@deepraxis/sdk 0.1.0 → 0.1.1-dev.07df50c

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -45,7 +45,7 @@ export declare const operations: readonly [{
45
45
  readonly resource: "agent.agents";
46
46
  readonly method: "create";
47
47
  readonly summary: "Create agent";
48
- readonly description: "Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; the native skill tool is separate from the skills field. Use tools: [{type: \"agent_toolset_20260401\"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: \"agent_toolset_20260401\", default_config: {enabled: false}, configs: [{name: \"codemode\", enabled: true}, {name: \"bash\", enabled: true, permission_policy: {type: \"always_ask\"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. Example: {\"name\":\"helper\",\"model\":{\"id\":\"deepseek-flash\"},\"tools\":[{\"type\":\"agent_toolset_20260401\"}]}.";
48
+ readonly description: "Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400. Use tools: [{type: \"agent_toolset_20260401\"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: \"agent_toolset_20260401\", default_config: {enabled: false}, configs: [{name: \"codemode\", enabled: true}, {name: \"bash\", enabled: true, permission_policy: {type: \"always_ask\"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. model and every models.allowed entry must be a catalog model that can run an agent: an unknown id returns 400 \"model <id> is not in the model catalog\" and an embedding, image or speech model returns 400 \"model <id> cannot run an agent\". name is a label, not a unique key: 1 to 256 characters after trimming, no NUL or line breaks. avatar is trimmed, must not contain spaces or point at a loopback, private or internal host, and its scheme is stored in lowercase. script and workflow binding ids are stored in lowercase, the form automation matches; bindings together with environment_id null return 400 because bindings need a machine. Example: {\"name\":\"helper\",\"model\":{\"id\":\"deepseek-flash\"},\"tools\":[{\"type\":\"agent_toolset_20260401\"}]}.";
49
49
  readonly http: "POST";
50
50
  readonly path: "/agent/v1/agents";
51
51
  readonly streaming: "no";
@@ -58,12 +58,12 @@ export declare const operations: readonly [{
58
58
  readonly name: "model";
59
59
  readonly type: "object";
60
60
  readonly required: true;
61
- readonly description: "Model identifier. Accepts the\n[model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison),\ne.g. `claude-opus-5`, or a `model_config` object for additional configuration\ncontrol";
61
+ readonly description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.";
62
62
  }, {
63
63
  readonly name: "name";
64
64
  readonly type: "string";
65
65
  readonly required: true;
66
- readonly description: "Human-readable name for the agent.";
66
+ readonly description: "Display name of the agent, 1 to 256 characters after trimming, with no NUL or line breaks. A label, not a unique key: two agents may share a name.";
67
67
  }, {
68
68
  readonly name: "description";
69
69
  readonly type: "string";
@@ -84,13 +84,13 @@ export declare const operations: readonly [{
84
84
  readonly name: "multiagent";
85
85
  readonly type: "object";
86
86
  readonly required: false;
87
- readonly description: "A coordinator topology: the session's primary thread orchestrates\nwork by spawning session threads, each running an agent drawn from the `agents`\nroster.";
87
+ readonly description: "Coordinator roster. A bare string agent id is equivalent to {type: \"agent\", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: \"self\"} refers to this agent. Specify a concrete version to pin it explicitly.";
88
88
  }, {
89
89
  readonly name: "skills";
90
90
  readonly type: "array";
91
91
  readonly itemType: "object";
92
92
  readonly required: false;
93
- readonly description: "Skill attachments are not supported: a nonempty array returns 400. Omit this field or send an empty array; the native skill tool is configured separately through tools.";
93
+ readonly description: "Custom skills attached to the agent, each {type: \"custom\", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send \"latest\", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.";
94
94
  }, {
95
95
  readonly name: "system";
96
96
  readonly type: "string";
@@ -107,7 +107,7 @@ export declare const operations: readonly [{
107
107
  readonly type: "array";
108
108
  readonly itemType: "object";
109
109
  readonly required: false;
110
- readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file_..., read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. A resource that is not bound returns 404, a service that is not opened returns 403, and writes to read_only resources are refused. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.";
110
+ readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.";
111
111
  }, {
112
112
  readonly name: "kind";
113
113
  readonly type: "string";
@@ -124,6 +124,11 @@ export declare const operations: readonly [{
124
124
  readonly type: "string";
125
125
  readonly required: false;
126
126
  readonly description: "Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.";
127
+ }, {
128
+ readonly name: "image_model";
129
+ readonly type: "string";
130
+ readonly required: false;
131
+ readonly description: "Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.";
127
132
  }, {
128
133
  readonly name: "subagents";
129
134
  readonly type: "array";
@@ -174,7 +179,7 @@ export declare const operations: readonly [{
174
179
  readonly resource: "agent.agents";
175
180
  readonly method: "retrieve";
176
181
  readonly summary: "Get agent";
177
- readonly description: "Read one agent by id, at its latest version or, with version, at a specific earlier version. The response lists every native tool with its resolved configuration in one agent_toolset_20260401 entry, so it can be sent back unchanged to agents.update. Use agents.versions.list to enumerate versions.";
182
+ readonly description: "Read the agent configuration currently effective for new sessions. By default, version equals active_version and latest_version identifies the newest saved version, including an unapplied save. Use latest_version for optimistic concurrency when updating. Pass version as a positive integer to read that saved version; version=active is equivalent to omission. The response lists every native tool with its resolved configuration in one agent_toolset_20260401 entry, so tools can be sent back unchanged to agents.update. Use agents.versions.list to enumerate saved versions.";
178
183
  readonly http: "GET";
179
184
  readonly path: "/agent/v1/agents/{agent_id}";
180
185
  readonly streaming: "no";
@@ -182,18 +187,19 @@ export declare const operations: readonly [{
182
187
  readonly pathParams: readonly [{
183
188
  readonly name: "agent_id";
184
189
  readonly sdkName: "agent_id";
190
+ readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.";
185
191
  }];
186
192
  readonly query: readonly [{
187
193
  readonly name: "version";
188
194
  readonly type: "number";
189
195
  readonly required: false;
190
- readonly description: "Agent version to read; omit for the latest. Integer of at least 1; versions are listed by agents.versions.list.";
196
+ readonly description: "Agent version to read. Omit, or send active, for the currently effective version used by new sessions. Send an integer of at least 1 from agents.versions.list to read that saved version. The default response also includes latest_version, the newest saved version number.";
191
197
  }];
192
198
  }, {
193
199
  readonly resource: "agent.agents";
194
200
  readonly method: "update";
195
201
  readonly summary: "Update agent";
196
- readonly description: "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version. apply defaults to true and moves active_version to the new version, or to the latest when configuration is unchanged; apply false saves without applying. version_note optionally records up to 280 characters on a newly created version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; use the native skill tool for available runtime skills.";
202
+ readonly description: "Save configuration changes as a new immutable version. Send latest_version from a default retrieve or update response as the request version for optimistic concurrency; a stale value returns 409. apply defaults to true and makes the new version effective; apply false saves without changing active_version. The response contains the effective configuration, with version equal to active_version and latest_version naming the newest saved version. An unchanged configuration, including a note-only update, is a no-op returning 200 and the current effective version without creating or activating a version. version_note records up to 280 characters only when a configuration change creates a new version; null is equivalent to omission. Use agents.versions.apply to activate an existing saved version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400.";
197
203
  readonly http: "POST";
198
204
  readonly path: "/agent/v1/agents/{agent_id}";
199
205
  readonly streaming: "no";
@@ -201,6 +207,7 @@ export declare const operations: readonly [{
201
207
  readonly pathParams: readonly [{
202
208
  readonly name: "agent_id";
203
209
  readonly sdkName: "agent_id";
210
+ readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.";
204
211
  }];
205
212
  readonly query: readonly [];
206
213
  readonly body: {
@@ -225,23 +232,23 @@ export declare const operations: readonly [{
225
232
  readonly name: "model";
226
233
  readonly type: "object";
227
234
  readonly required: false;
228
- readonly description: "Model identifier. Accepts the\n[model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison),\ne.g. `claude-opus-5`, or a `model_config` object for additional configuration\ncontrol. Omit to preserve. Cannot be cleared.";
235
+ readonly description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.";
229
236
  }, {
230
237
  readonly name: "multiagent";
231
238
  readonly type: "object";
232
239
  readonly required: false;
233
- readonly description: "A coordinator topology: the session's primary thread orchestrates\nwork by spawning session threads, each running an agent drawn from the `agents`\nroster.";
240
+ readonly description: "Coordinator roster. A bare string agent id is equivalent to {type: \"agent\", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: \"self\"} refers to this agent. Specify a concrete version to pin it explicitly.";
234
241
  }, {
235
242
  readonly name: "name";
236
243
  readonly type: "string";
237
244
  readonly required: false;
238
- readonly description: "Human-readable name. Must be non-empty. Omit to preserve. Cannot be\ncleared.";
245
+ readonly description: "New display name, 1 to 256 characters after trimming, with no NUL or line breaks. A label, not a unique key; omit to keep the current name.";
239
246
  }, {
240
247
  readonly name: "skills";
241
248
  readonly type: "array";
242
249
  readonly itemType: "object";
243
250
  readonly required: false;
244
- readonly description: "Skill attachments are not supported: a nonempty array returns 400. Omit this field or send an empty array; the native skill tool is configured separately through tools.";
251
+ readonly description: "Custom skills attached to the agent, each {type: \"custom\", skill_id, version?}: skill_id comes from skills.create or skills.list, at most 20 skills, no repeated skill_id. Omit version, or send \"latest\", to use the skill's newest version at the moment a session starts; a pinned version stays fixed. type anthropic returns 400: upload the skill and attach it as custom. On update, omit the field to keep the list, send an array to replace it, or send [] or null to clear it.";
245
252
  }, {
246
253
  readonly name: "system";
247
254
  readonly type: "string";
@@ -257,23 +264,23 @@ export declare const operations: readonly [{
257
264
  readonly name: "version";
258
265
  readonly type: "number";
259
266
  readonly required: false;
260
- readonly description: "The agent's current version, used to prevent concurrent overwrites.\nObtain this value from a create or retrieve response. Must be at least 1 if\nspecified. When supplied, the request fails if it does not match the server's\ncurrent version; omit to apply the update unconditionally.";
267
+ readonly description: "Newest saved version used for optimistic concurrency. Obtain latest_version from the default retrieve or update response, or version from versions.list. A stale value returns 409; omit for an unconditional update.";
261
268
  }, {
262
269
  readonly name: "apply";
263
270
  readonly type: "boolean";
264
271
  readonly required: false;
265
- readonly description: "Defaults to true: apply the newly saved version, or the latest version when configuration is unchanged. Set false to save without changing active_version. Unlike Managed Agents, saving and applying can be separate.";
272
+ readonly description: "Defaults to true: apply a newly saved configuration version. Set false to save without changing active_version. An unchanged configuration is a no-op, including note-only updates; use versions.apply to activate a saved version.";
266
273
  }, {
267
274
  readonly name: "version_note";
268
275
  readonly type: "string";
269
276
  readonly required: false;
270
- readonly description: "Optional change explanation stored as note on the new immutable version, up to 280 characters. Omission stores null. A note alone does not create a version or rewrite an existing note.";
277
+ readonly description: "Optional change explanation, at most 280 characters. Recorded only when a configuration change creates a new immutable version. A note-only update is a no-op returning 200 and the current effective version. Null is equivalent to omission.";
271
278
  }, {
272
279
  readonly name: "bindings";
273
280
  readonly type: "array";
274
281
  readonly itemType: "object";
275
282
  readonly required: false;
276
- readonly description: "Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept a nonempty list.";
283
+ readonly description: "Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; once this version is applied, disabling, removing or downgrading a binding revokes it immediately in running sessions on older versions, while apply=false changes no access. Only service agents accept a nonempty list.";
277
284
  }, {
278
285
  readonly name: "kind";
279
286
  readonly type: "string";
@@ -290,6 +297,11 @@ export declare const operations: readonly [{
290
297
  readonly type: "string";
291
298
  readonly required: false;
292
299
  readonly description: "Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.";
300
+ }, {
301
+ readonly name: "image_model";
302
+ readonly type: "string";
303
+ readonly required: false;
304
+ readonly description: "Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.";
293
305
  }, {
294
306
  readonly name: "subagents";
295
307
  readonly type: "array";
@@ -336,6 +348,21 @@ export declare const operations: readonly [{
336
348
  readonly description: "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor.";
337
349
  }];
338
350
  };
351
+ }, {
352
+ readonly resource: "agent.agents";
353
+ readonly method: "retrieveAppearance";
354
+ readonly summary: "Get agent appearance";
355
+ readonly description: "Read the saved chat appearance of a service agent.\n\nAgent Kit calls this from the page with a customer access token of this agent; your API key and console members can read it too. A token of another agent returns 404. The body is the same as the embed appearance read; a missing appearance returns the agent's own name and avatar only. Responses are private and cacheable for 60 seconds.";
356
+ readonly http: "GET";
357
+ readonly path: "/agent/v1/agents/{agent_id}/appearance";
358
+ readonly streaming: "no";
359
+ readonly pagination: false;
360
+ readonly pathParams: readonly [{
361
+ readonly name: "agent_id";
362
+ readonly sdkName: "agent_id";
363
+ readonly description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.";
364
+ }];
365
+ readonly query: readonly [];
339
366
  }, {
340
367
  readonly resource: "agent.agents";
341
368
  readonly method: "archive";
@@ -348,142 +375,291 @@ export declare const operations: readonly [{
348
375
  readonly pathParams: readonly [{
349
376
  readonly name: "agent_id";
350
377
  readonly sdkName: "agent_id";
378
+ readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.";
351
379
  }];
352
380
  readonly query: readonly [];
353
381
  }, {
354
- readonly resource: "agent.agents.endUsers";
382
+ readonly resource: "agent.agents.customers";
355
383
  readonly method: "list";
356
- readonly summary: "List End Users";
357
- readonly description: "List users who have sessions or token issuance history on a service agent.\n\nOrdered by last_active_at and external_user_id descending. q is a case-sensitive literal prefix, including underscores. limit is 1–100, default 20. Reuse next_page with the same organization, agent, q and limit. Preemptively blocked users without history do not appear. End-user credentials and inaccessible or personal agents return 404.";
384
+ readonly summary: "List customers";
385
+ readonly description: "List the customers of a service agent, identified and anonymous, most recently seen first.\n\nCall this from your backend with your API key, or from the console. Customers follow Shopify Admin customers (list, retrieve, block, sign-out and data deletion of the people who use your storefront), so that experience applies. The list includes customers who signed in but have not started a session yet, and customers recorded under your own ids by embed tokens before customer sign-in existed; an id first seen that way is identified unless it starts with anon_. Unlike Shopify, a customer can be anonymous: a visitor admitted with the publishable key gets an anon_ id, and when it later signs in with anonymous_access_token it is merged: merged_into names the identified customer, and its sessions count toward that customer. Filter with q (a case-sensitive customer id prefix), type (identified or anonymous) and blocked (true or false). limit is 1 to 100, default 20; reuse next_page with the same filters and limit. A customer access token gets 404. Example: GET /agent/v1/agents/agent_example/customers?type=identified&blocked=false&limit=50.";
358
386
  readonly http: "GET";
359
- readonly path: "/agent/v1/agents/{agent_id}/end_users";
387
+ readonly path: "/agent/v1/agents/{agent_id}/customers";
360
388
  readonly streaming: "no";
361
389
  readonly pagination: false;
362
390
  readonly pathParams: readonly [{
363
391
  readonly name: "agent_id";
364
392
  readonly sdkName: "agent_id";
393
+ readonly description: "Active service agent id from agent creation or listing.";
365
394
  }];
366
395
  readonly query: readonly [{
367
396
  readonly name: "limit";
368
397
  readonly type: "integer";
369
398
  readonly required: false;
370
- readonly description: "Maximum users per page; defaults to 20.";
399
+ readonly description: "Maximum customers per page, 1 to 100; defaults to 20.";
371
400
  }, {
372
401
  readonly name: "page";
373
402
  readonly type: "string";
374
403
  readonly required: false;
375
- readonly description: "next_page from the previous response with the same agent, q and limit.";
404
+ readonly description: "next_page from the previous response with the same q, type, blocked and limit.";
376
405
  }, {
377
406
  readonly name: "q";
378
407
  readonly type: "string";
379
408
  readonly required: false;
380
- readonly description: "Case-sensitive literal prefix of external_user_id; omit or use an empty string for all users.";
409
+ readonly description: "Case-sensitive literal prefix of the customer id; omit for all customers.";
410
+ }, {
411
+ readonly name: "type";
412
+ readonly type: "string";
413
+ readonly enum: readonly ["identified", "anonymous"];
414
+ readonly required: false;
415
+ readonly description: "Only identified or only anonymous customers; omit for both.";
416
+ }, {
417
+ readonly name: "blocked";
418
+ readonly type: "boolean";
419
+ readonly required: false;
420
+ readonly description: "true for blocked customers only, false for customers who are not blocked; omit for both.";
381
421
  }];
382
422
  }, {
383
- readonly resource: "agent.agents.endUsers";
423
+ readonly resource: "agent.agents.customers.auth.accessTokens";
424
+ readonly method: "create";
425
+ readonly summary: "Create customer access token";
426
+ readonly description: "Exchange a grant code, or the agent's publishable key for an anonymous visitor, for a customer access token that authorizes the agent's embedded sessions.\n\nNo Authorization header is required: the grant code or the publishable key is the credential. Agent Kit calls this from the browser, so send the page Origin. With grant_code, the code is consumed atomically: concurrent attempts have exactly one winner, and unknown, used, expired and other-agent codes all return the same 401 GRANT_CODE_INVALID. The sign-in starts now and lasts the code's max_session_seconds. Unlike Shopify, a visitor without an account gets a token too: send publishable_key instead and a new anonymous customer (anon_…) is created, bound to the request Origin, for 7 days. The access token lasts at most two hours and never outlives the sign-in; renew it with access_tokens/renew before expires_at. Both forms share the per-IP minute limit of anonymous issuance (default 20). Example body: {\"grant_code\":\"cgc_…\"}.";
427
+ readonly http: "POST";
428
+ readonly path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens";
429
+ readonly streaming: "no";
430
+ readonly pagination: false;
431
+ readonly pathParams: readonly [{
432
+ readonly name: "agent_id";
433
+ readonly sdkName: "agent_id";
434
+ readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
435
+ }];
436
+ readonly query: readonly [];
437
+ readonly body: {
438
+ readonly required: true;
439
+ readonly fields: readonly [];
440
+ };
441
+ }, {
442
+ readonly resource: "agent.agents.customers.auth.accessTokens";
443
+ readonly method: "deleteCurrent";
444
+ readonly summary: "Log out customer";
445
+ readonly description: "Log the customer out by revoking the sign-in of the presented access token and every token issued in it.\n\nSend the current customer access token as the Bearer credential, with no body, when the customer logs out of your site. Every token of the sign-in, including renewed ones, stops working, and their live event streams close; the customer's conversations are kept. Returns 204. Calling it again with the same token returns 401 ACCESS_TOKEN_REVOKED, so treat that as already logged out.";
446
+ readonly http: "DELETE";
447
+ readonly path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current";
448
+ readonly streaming: "no";
449
+ readonly pagination: false;
450
+ readonly pathParams: readonly [{
451
+ readonly name: "agent_id";
452
+ readonly sdkName: "agent_id";
453
+ readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
454
+ }];
455
+ readonly query: readonly [];
456
+ }, {
457
+ readonly resource: "agent.agents.customers.auth.accessTokens.renew";
458
+ readonly method: "create";
459
+ readonly summary: "Renew customer access token";
460
+ readonly description: "Get a fresh customer access token in the same sign-in, authenticated with the current one.\n\nSend the current customer access token as the Bearer credential, with no body, a few minutes before expires_at. The new token keeps the version, budget, context, metadata and origin binding of the sign-in and lasts at most two hours, never past session_expires_at. Unlike Shopify, renewal does not revoke the presented token: it stays valid until its own expiry, so a reply that is streaming on it is not cut off. When less than 60 seconds of the sign-in remain, renewal returns 401 CUSTOMER_SESSION_EXPIRED; sign the customer in again with a new grant code from your backend. A token that was logged out or merged returns 401 ACCESS_TOKEN_REVOKED.";
461
+ readonly http: "POST";
462
+ readonly path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew";
463
+ readonly streaming: "no";
464
+ readonly pagination: false;
465
+ readonly pathParams: readonly [{
466
+ readonly name: "agent_id";
467
+ readonly sdkName: "agent_id";
468
+ readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
469
+ }];
470
+ readonly query: readonly [];
471
+ }, {
472
+ readonly resource: "agent.agents.customers.auth.grantCodes";
473
+ readonly method: "create";
474
+ readonly summary: "Create customer grant code";
475
+ readonly description: "Sign your logged-in customer in to a service agent from your backend with a one-time grant code that Agent Kit exchanges for a customer access token.\n\nCall this from your backend with your API key after your own login succeeds, then pass the returned code to Agent Kit in the browser; never call it from the browser. Customer authorization follows Shopify Storefront customer access tokens (Multipass-style sign-in, a short-lived token, renewal and logout), so that experience applies. customer_id is your own identifier for the customer: use an opaque id such as your database user id, not an email address or phone number. The value auth is reserved, and ids starting with anon_ are reserved for anonymous customers. The code works once and expires after expires_in seconds (default 900). The sign-in it starts lasts max_session_seconds (default 7 days); version, budget (US dollars, at most 2 decimals), system_message, agent_override and metadata apply to every token of the sign-in. Unlike Shopify, origin binds the whole sign-in to one page origin, and anonymous_access_token merges the conversations of the anonymous visitor who chatted before signing in into this customer. Example body: {\"customer_id\":\"cus_8f2a91\",\"origin\":\"https://shop.example.com\"}.";
476
+ readonly http: "POST";
477
+ readonly path: "/agent/v1/agents/{agent_id}/customers/auth/grant_codes";
478
+ readonly streaming: "no";
479
+ readonly pagination: false;
480
+ readonly pathParams: readonly [{
481
+ readonly name: "agent_id";
482
+ readonly sdkName: "agent_id";
483
+ readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
484
+ }];
485
+ readonly query: readonly [];
486
+ readonly body: {
487
+ readonly required: true;
488
+ readonly fields: readonly [{
489
+ readonly name: "customer_id";
490
+ readonly type: "string";
491
+ readonly required: true;
492
+ readonly description: "Your stable, opaque identifier for the signed-in customer, such as your database user id. Do not use an email address or phone number. \"auth\" is reserved, and ids starting with anon_ are reserved for anonymous customers.";
493
+ }, {
494
+ readonly name: "version";
495
+ readonly type: "integer";
496
+ readonly required: false;
497
+ readonly description: "Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued.";
498
+ }, {
499
+ readonly name: "budget";
500
+ readonly type: "object";
501
+ readonly required: false;
502
+ readonly description: "Budget for each session the customer starts, in the same shape as a session budget. Defaults to the embed policy session budget and cannot exceed its maximum.";
503
+ }, {
504
+ readonly name: "system_message";
505
+ readonly type: "array";
506
+ readonly itemType: "object";
507
+ readonly required: false;
508
+ readonly description: "Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total.";
509
+ }, {
510
+ readonly name: "agent_override";
511
+ readonly type: "object";
512
+ readonly required: false;
513
+ readonly description: "Optional system prompt override, accepted only when the embed policy allows agent overrides.";
514
+ }, {
515
+ readonly name: "metadata";
516
+ readonly type: "object";
517
+ readonly required: false;
518
+ readonly description: "Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved.";
519
+ }, {
520
+ readonly name: "origin";
521
+ readonly type: "string";
522
+ readonly required: false;
523
+ readonly description: "Page origin, such as https://shop.example.com, that must be one of the agent policy's allowed_origins (or localhost when the policy allows it). When set, every token of this sign-in works only from exactly this origin. Omit to accept any policy origin.";
524
+ }, {
525
+ readonly name: "expires_in";
526
+ readonly type: "integer";
527
+ readonly required: false;
528
+ readonly description: "Seconds the code stays redeemable, from 60 to 86400. Defaults to 900.";
529
+ }, {
530
+ readonly name: "max_session_seconds";
531
+ readonly type: "integer";
532
+ readonly required: false;
533
+ readonly description: "Total lifetime of the sign-in in seconds, from 3600 to 604800 (7 days). Tokens renew within it; after it the customer signs in again. Defaults to 604800.";
534
+ }, {
535
+ readonly name: "anonymous_access_token";
536
+ readonly type: "string";
537
+ readonly required: false;
538
+ readonly description: "The current access token of the anonymous customer who used this agent before signing in. Their conversations become visible to the identified customer, and the anonymous sign-in ends at exchange.";
539
+ }, {
540
+ readonly name: "hosted";
541
+ readonly type: "boolean";
542
+ readonly required: false;
543
+ readonly description: "Set true to also return hosted_url, a link to the agent's Hosted chat page that carries the code in its fragment. The page exchanges the code only when the customer clicks to start, so link previews in email or chat apps do not use it up. The agent must have an identity_number, and origin cannot be set: the code is bound to no origin. Defaults to false.";
544
+ }];
545
+ };
546
+ }, {
547
+ readonly resource: "agent.agents.customers";
384
548
  readonly method: "delete";
385
- readonly summary: "Delete end-user data";
386
- readonly description: "Delete a host application's end-user data from one service agent after explicit confirmation.\n\nDevelop only. Set confirm to the exact external_user_id; missing or mismatched confirmation returns 400. Returns 202 with a pending task id, not completion. Poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the user is blocked before a seven-day recovery snapshot is verified. Sessions including child sessions, conversation data, grants and feedback are then removed. A pre-existing block remains; a temporary block is removed on success. Attachment metadata is recorded and File attachments are retained. No charge is introduced by this operation. Example: DELETE /agent/v1/agents/agent_example/end_users/customer_123?confirm=customer_123.";
549
+ readonly summary: "Delete customer data";
550
+ readonly description: "Delete a customer's data from one service agent after explicit confirmation.\n\nDevelop only. Set confirm to the exact customer id; a missing or different confirm returns 400 naming the value to send. Returns 202 with a pending task id; poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the customer is blocked before a seven-day recovery snapshot is verified; sessions including child sessions, conversation data, grants and feedback are then removed. A block that existed before stays; a temporary block is removed on success. File attachments are retained. Example: DELETE /agent/v1/agents/agent_example/customers/cus_8f2a91?confirm=cus_8f2a91.";
387
551
  readonly http: "DELETE";
388
- readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}";
552
+ readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}";
389
553
  readonly streaming: "no";
390
554
  readonly pagination: false;
391
555
  readonly pathParams: readonly [{
392
556
  readonly name: "agent_id";
393
557
  readonly sdkName: "agent_id";
558
+ readonly description: "Active service agent id from agent creation or listing.";
394
559
  }, {
395
- readonly name: "external_user_id";
396
- readonly sdkName: "external_user_id";
560
+ readonly name: "customer_id";
561
+ readonly sdkName: "customer_id";
562
+ readonly description: "Customer id from customer listing, or your own customer_id.";
397
563
  }];
398
564
  readonly query: readonly [{
399
565
  readonly name: "confirm";
400
566
  readonly type: "string";
401
567
  readonly required: true;
402
- readonly description: "Must exactly equal the external_user_id path parameter to confirm destructive deletion.";
568
+ readonly description: "Must equal the customer_id path parameter exactly, confirming the destructive deletion.";
403
569
  }];
404
570
  }, {
405
- readonly resource: "agent.agents.endUsers";
571
+ readonly resource: "agent.agents.customers";
406
572
  readonly method: "retrieve";
407
- readonly summary: "Get End User";
408
- readonly description: "Inspect one end user and their twenty most recently updated sessions.\n\nUse external_user_id from listing or your host application. Users without session or issuance history return 404, including preemptively blocked users. End-user credentials and inaccessible or personal agents return 404.";
573
+ readonly summary: "Get customer";
574
+ readonly description: "Retrieve one customer of a service agent with its twenty most recently updated sessions.\n\nUse the customer id from the list or your own customer_id. An unknown customer returns 404 CUSTOMER_NOT_FOUND, and so does a customer access token. Unlike Shopify, an identified customer's session_count, cost and recent_sessions include the sessions of anonymous customers merged into it; the merged anonymous customer still shows its own sessions and its merged_into.";
409
575
  readonly http: "GET";
410
- readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}";
576
+ readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}";
411
577
  readonly streaming: "no";
412
578
  readonly pagination: false;
413
579
  readonly pathParams: readonly [{
414
580
  readonly name: "agent_id";
415
581
  readonly sdkName: "agent_id";
582
+ readonly description: "Active service agent id from agent creation or listing.";
416
583
  }, {
417
- readonly name: "external_user_id";
418
- readonly sdkName: "external_user_id";
584
+ readonly name: "customer_id";
585
+ readonly sdkName: "customer_id";
586
+ readonly description: "Customer id from customer listing, or your own customer_id.";
419
587
  }];
420
588
  readonly query: readonly [];
421
589
  }, {
422
- readonly resource: "agent.agents.endUsers.block";
590
+ readonly resource: "agent.agents.customers.block";
423
591
  readonly method: "create";
424
- readonly summary: "Block End User";
425
- readonly description: "Block token issuance and session creation, then revoke existing tokens for an end user.\n\nMay block a user before any history exists; timestamps are then null and counts and cost are zero. Requires an embed policy, otherwise returns 409 with setup guidance. Deduplicates the policy blocklist and retains its 1000-user maximum. If revocation returns 502, the user remains blocked; retry to finish revocation. Repeats keep the user blocked and revoke any remaining grants. End-user credentials and inaccessible or personal agents return 404.";
592
+ readonly summary: "Block customer";
593
+ readonly description: "Block a customer and end every sign-in it has on this agent.\n\nBlocks the customer, then ends every live sign-in the way logout does: each access token is revoked and its open event streams close. From then on grant_codes, access_tokens, renew and new sessions for this customer return CUSTOMER_BLOCKED until you unblock it. Idempotent: a repeat keeps the first block time and revokes whatever is still live. If credential revocation fails the request returns 502 and the customer stays blocked; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.";
426
594
  readonly http: "POST";
427
- readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block";
595
+ readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/block";
428
596
  readonly streaming: "no";
429
597
  readonly pagination: false;
430
598
  readonly pathParams: readonly [{
431
599
  readonly name: "agent_id";
432
600
  readonly sdkName: "agent_id";
601
+ readonly description: "Active service agent id from agent creation or listing.";
433
602
  }, {
434
- readonly name: "external_user_id";
435
- readonly sdkName: "external_user_id";
603
+ readonly name: "customer_id";
604
+ readonly sdkName: "customer_id";
605
+ readonly description: "Customer id from customer listing, or your own customer_id.";
436
606
  }];
437
607
  readonly query: readonly [];
438
608
  }, {
439
- readonly resource: "agent.agents.endUsers";
609
+ readonly resource: "agent.agents.customers";
440
610
  readonly method: "retrieveDeletion";
441
- readonly summary: "Get end-user deletion";
442
- readonly description: "Poll the latest deletion task for an end user, including after the user data has been removed.\n\nUse the same agent_id and external_user_id as the confirmed DELETE. Status is pending, snapshotting, deleting, done or failed. Counts are empty until a verified snapshot exists. A failed task remains blocked and resumes when DELETE is retried with matching confirmation. snapshot_key is an operator recovery reference retained for seven days, not a public download URL. End-user credentials, inaccessible or personal agents, and missing tasks return 404. This read does not create a task or charge usage.";
611
+ readonly summary: "Get customer deletion";
612
+ readonly description: "Poll the latest deletion task of a customer, including after its data has been removed.\n\nUse the same agent_id and customer id as the confirmed DELETE. Status is pending, snapshotting, deleting, done or failed. Counts are empty until a verified snapshot exists. snapshot_key is an operator recovery reference retained for seven days, not a download URL. A customer access token and a missing task return 404.";
443
613
  readonly http: "GET";
444
- readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion";
614
+ readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion";
445
615
  readonly streaming: "no";
446
616
  readonly pagination: false;
447
617
  readonly pathParams: readonly [{
448
618
  readonly name: "agent_id";
449
619
  readonly sdkName: "agent_id";
620
+ readonly description: "Active service agent id from agent creation or listing.";
450
621
  }, {
451
- readonly name: "external_user_id";
452
- readonly sdkName: "external_user_id";
622
+ readonly name: "customer_id";
623
+ readonly sdkName: "customer_id";
624
+ readonly description: "Customer id from customer listing, or your own customer_id.";
453
625
  }];
454
626
  readonly query: readonly [];
455
627
  }, {
456
- readonly resource: "agent.agents.endUsers.revokeTokens";
628
+ readonly resource: "agent.agents.customers.revokeTokens";
457
629
  readonly method: "create";
458
- readonly summary: "Revoke End User Tokens";
459
- readonly description: "Revoke all issued tokens for an end user and terminate their open embed streams.\n\nRevokes credentials before marking grants revoked. Upstream failure returns 502 without changing grant revocation timestamps. Returns the count of newly revoked grants; a repeat without new grants returns zero. Does not block future issuance. End-user credentials and inaccessible or personal agents return 404.";
630
+ readonly summary: "Revoke customer tokens";
631
+ readonly description: "Sign a customer out everywhere without blocking it.\n\nEnds every live sign-in of the customer, revoking each access token and closing its open event streams; the customer can sign in again right away. Returns the number of access tokens this request revoked; a repeat returns 0. Credential revocation failure returns 502; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.";
460
632
  readonly http: "POST";
461
- readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens";
633
+ readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens";
462
634
  readonly streaming: "no";
463
635
  readonly pagination: false;
464
636
  readonly pathParams: readonly [{
465
637
  readonly name: "agent_id";
466
638
  readonly sdkName: "agent_id";
639
+ readonly description: "Active service agent id from agent creation or listing.";
467
640
  }, {
468
- readonly name: "external_user_id";
469
- readonly sdkName: "external_user_id";
641
+ readonly name: "customer_id";
642
+ readonly sdkName: "customer_id";
643
+ readonly description: "Customer id from customer listing, or your own customer_id.";
470
644
  }];
471
645
  readonly query: readonly [];
472
646
  }, {
473
- readonly resource: "agent.agents.endUsers.unblock";
647
+ readonly resource: "agent.agents.customers.unblock";
474
648
  readonly method: "create";
475
- readonly summary: "Unblock End User";
476
- readonly description: "Allow an end user to receive new tokens and create new sessions again.\n\nRemoves the user from the blocklist; previously revoked tokens stay revoked. Idempotent. Requires an embed policy, otherwise returns 409 with setup guidance. Returns null timestamps and zero counts and cost when no session or issuance history exists. End-user credentials and inaccessible or personal agents return 404.";
649
+ readonly summary: "Unblock customer";
650
+ readonly description: "Allow a blocked customer to sign in and start sessions again.\n\nIdempotent. Access tokens revoked while the customer was blocked stay revoked; sign the customer in again with a new grant code. An unknown customer returns 404 CUSTOMER_NOT_FOUND.";
477
651
  readonly http: "POST";
478
- readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock";
652
+ readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock";
479
653
  readonly streaming: "no";
480
654
  readonly pagination: false;
481
655
  readonly pathParams: readonly [{
482
656
  readonly name: "agent_id";
483
657
  readonly sdkName: "agent_id";
658
+ readonly description: "Active service agent id from agent creation or listing.";
484
659
  }, {
485
- readonly name: "external_user_id";
486
- readonly sdkName: "external_user_id";
660
+ readonly name: "customer_id";
661
+ readonly sdkName: "customer_id";
662
+ readonly description: "Customer id from customer listing, or your own customer_id.";
487
663
  }];
488
664
  readonly query: readonly [];
489
665
  }, {
@@ -498,13 +674,14 @@ export declare const operations: readonly [{
498
674
  readonly pathParams: readonly [{
499
675
  readonly name: "agent_id";
500
676
  readonly sdkName: "agent_id";
677
+ readonly description: "Agent id from creation or listing.";
501
678
  }];
502
679
  readonly query: readonly [];
503
680
  }, {
504
681
  readonly resource: "agent.agents.versions";
505
682
  readonly method: "list";
506
683
  readonly summary: "List agent versions";
507
- readonly description: "List the saved versions of one agent, in pages of at most 100 (default 20). Each item is the full agent definition at that version, so you can compare what changed between versions. Use agents.retrieve with version to read a single one; agent_id comes from agents.list or agents.create.";
684
+ readonly description: "List the saved versions of one agent in ascending version number, oldest first, in pages of at most 100 (default 20). Each item is the full agent definition at that saved version, so you can compare configurations. active is true only for the item new sessions use. active_version on every item is the same agent-level currently effective version; it is not that item's version. Use agents.retrieve with version to read a single saved version; agent_id comes from agents.list or agents.create. Pass next_page as page to continue.";
508
685
  readonly http: "GET";
509
686
  readonly path: "/agent/v1/agents/{agent_id}/versions";
510
687
  readonly streaming: "no";
@@ -512,6 +689,7 @@ export declare const operations: readonly [{
512
689
  readonly pathParams: readonly [{
513
690
  readonly name: "agent_id";
514
691
  readonly sdkName: "agent_id";
692
+ readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.";
515
693
  }];
516
694
  readonly query: readonly [{
517
695
  readonly name: "limit";
@@ -528,7 +706,7 @@ export declare const operations: readonly [{
528
706
  readonly resource: "agent.agents.versions";
529
707
  readonly method: "apply";
530
708
  readonly summary: "Apply Agent Version";
531
- readonly description: "Apply a version from agents.versions.list by its version number. This idempotent operation changes active_version without creating a version; existing sessions and tokens keep their version. The response is the latest saved agent with its current active_version. Missing versions return 404 Agent version not found; archived agents return 409 Agent is archived. For example, POST /agent/v1/agents/{agent_id}/versions/2/apply with no body.";
709
+ readonly description: "Apply a saved version from agents.versions.list for new sessions and newly issued tokens, without creating a version. Existing sessions and tokens retain their version. The response contains the effective configuration with version equal to active_version and latest_version naming the newest saved version. Missing versions return 404; archived agents return 409. For example, POST /agent/v1/agents/{agent_id}/versions/2/apply with no body.";
532
710
  readonly http: "POST";
533
711
  readonly path: "/agent/v1/agents/{agent_id}/versions/{version}/apply";
534
712
  readonly streaming: "no";
@@ -536,16 +714,19 @@ export declare const operations: readonly [{
536
714
  readonly pathParams: readonly [{
537
715
  readonly name: "agent_id";
538
716
  readonly sdkName: "agent_id";
717
+ readonly description: "Agent identifier from agents.create or agents.list.";
539
718
  }, {
540
719
  readonly name: "version";
541
720
  readonly sdkName: "version";
721
+ readonly type: "integer";
722
+ readonly description: "Existing version number from agents.versions.list to use for new sessions and tokens.";
542
723
  }];
543
724
  readonly query: readonly [];
544
725
  }, {
545
726
  readonly resource: "agent.computers";
546
727
  readonly method: "list";
547
- readonly summary: "ComputersList";
548
- readonly description: "Tenant-owned durable computer resource.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
728
+ readonly summary: "List Computers";
729
+ readonly description: "List the computers of your organization, archived ones included.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
549
730
  readonly http: "GET";
550
731
  readonly path: "/agent/v1/computers";
551
732
  readonly streaming: "no";
@@ -565,8 +746,8 @@ export declare const operations: readonly [{
565
746
  }, {
566
747
  readonly resource: "agent.computers";
567
748
  readonly method: "create";
568
- readonly summary: "ComputersCreate";
569
- readonly description: "Tenant-owned durable computer resource.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
749
+ readonly summary: "Create Computer";
750
+ readonly description: "Create a durable computer: a named machine whose files outlive sessions, for personal agents.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
570
751
  readonly http: "POST";
571
752
  readonly path: "/agent/v1/computers";
572
753
  readonly streaming: "no";
@@ -599,13 +780,14 @@ export declare const operations: readonly [{
599
780
  readonly pathParams: readonly [{
600
781
  readonly name: "computer_id";
601
782
  readonly sdkName: "computer_id";
783
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
602
784
  }];
603
785
  readonly query: readonly [];
604
786
  }, {
605
787
  readonly resource: "agent.computers";
606
788
  readonly method: "retrieve";
607
- readonly summary: "ComputersRetrieve";
608
- readonly description: "Tenant-owned durable computer resource.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
789
+ readonly summary: "Get Computer";
790
+ readonly description: "Read one computer's status, storage use and sandbox id.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
609
791
  readonly http: "GET";
610
792
  readonly path: "/agent/v1/computers/{computer_id}";
611
793
  readonly streaming: "no";
@@ -613,13 +795,14 @@ export declare const operations: readonly [{
613
795
  readonly pathParams: readonly [{
614
796
  readonly name: "computer_id";
615
797
  readonly sdkName: "computer_id";
798
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
616
799
  }];
617
800
  readonly query: readonly [];
618
801
  }, {
619
802
  readonly resource: "agent.computers";
620
803
  readonly method: "update";
621
- readonly summary: "ComputersUpdate";
622
- readonly description: "Tenant-owned durable computer resource.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
804
+ readonly summary: "Update Computer";
805
+ readonly description: "Rename a computer.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
623
806
  readonly http: "POST";
624
807
  readonly path: "/agent/v1/computers/{computer_id}";
625
808
  readonly streaming: "no";
@@ -627,6 +810,7 @@ export declare const operations: readonly [{
627
810
  readonly pathParams: readonly [{
628
811
  readonly name: "computer_id";
629
812
  readonly sdkName: "computer_id";
813
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
630
814
  }];
631
815
  readonly query: readonly [];
632
816
  readonly body: {
@@ -641,8 +825,8 @@ export declare const operations: readonly [{
641
825
  }, {
642
826
  readonly resource: "agent.computers";
643
827
  readonly method: "archive";
644
- readonly summary: "ComputersArchive";
645
- readonly description: "Tenant-owned durable computer resource.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
828
+ readonly summary: "Archive Computer";
829
+ readonly description: "Archive a computer: its files stay readable but new sessions cannot use it.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
646
830
  readonly http: "POST";
647
831
  readonly path: "/agent/v1/computers/{computer_id}/archive";
648
832
  readonly streaming: "no";
@@ -650,6 +834,7 @@ export declare const operations: readonly [{
650
834
  readonly pathParams: readonly [{
651
835
  readonly name: "computer_id";
652
836
  readonly sdkName: "computer_id";
837
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
653
838
  }];
654
839
  readonly query: readonly [];
655
840
  }, {
@@ -664,6 +849,7 @@ export declare const operations: readonly [{
664
849
  readonly pathParams: readonly [{
665
850
  readonly name: "computer_id";
666
851
  readonly sdkName: "computer_id";
852
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
667
853
  }];
668
854
  readonly query: readonly [{
669
855
  readonly name: "name";
@@ -687,6 +873,7 @@ export declare const operations: readonly [{
687
873
  readonly pathParams: readonly [{
688
874
  readonly name: "computer_id";
689
875
  readonly sdkName: "computer_id";
876
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
690
877
  }];
691
878
  readonly query: readonly [];
692
879
  readonly body: {
@@ -702,8 +889,8 @@ export declare const operations: readonly [{
702
889
  }, {
703
890
  readonly resource: "agent.computers.files";
704
891
  readonly method: "list";
705
- readonly summary: "ComputersFilesList";
706
- readonly description: "Tenant-owned durable computer resource.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
892
+ readonly summary: "List Computer Files";
893
+ readonly description: "List the entries of one directory on a computer.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
707
894
  readonly http: "GET";
708
895
  readonly path: "/agent/v1/computers/{computer_id}/files";
709
896
  readonly streaming: "no";
@@ -711,6 +898,7 @@ export declare const operations: readonly [{
711
898
  readonly pathParams: readonly [{
712
899
  readonly name: "computer_id";
713
900
  readonly sdkName: "computer_id";
901
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
714
902
  }];
715
903
  readonly query: readonly [{
716
904
  readonly name: "path";
@@ -721,8 +909,8 @@ export declare const operations: readonly [{
721
909
  }, {
722
910
  readonly resource: "agent.computers.files";
723
911
  readonly method: "retrieveContent";
724
- readonly summary: "ComputersFilesContent";
725
- readonly description: "Tenant-owned durable computer resource.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
912
+ readonly summary: "Get Computer File Content";
913
+ readonly description: "Download the bytes of one file on a computer, up to 16 MiB, with single-range support.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
726
914
  readonly http: "GET";
727
915
  readonly path: "/agent/v1/computers/{computer_id}/files/content";
728
916
  readonly streaming: "no";
@@ -730,6 +918,7 @@ export declare const operations: readonly [{
730
918
  readonly pathParams: readonly [{
731
919
  readonly name: "computer_id";
732
920
  readonly sdkName: "computer_id";
921
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
733
922
  }];
734
923
  readonly query: readonly [{
735
924
  readonly name: "path";
@@ -749,9 +938,11 @@ export declare const operations: readonly [{
749
938
  readonly pathParams: readonly [{
750
939
  readonly name: "computer_id";
751
940
  readonly sdkName: "computer_id";
941
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
752
942
  }, {
753
943
  readonly name: "lease_id";
754
944
  readonly sdkName: "lease_id";
945
+ readonly description: "lease_id from the connect response.";
755
946
  }];
756
947
  readonly query: readonly [];
757
948
  }, {
@@ -766,9 +957,11 @@ export declare const operations: readonly [{
766
957
  readonly pathParams: readonly [{
767
958
  readonly name: "computer_id";
768
959
  readonly sdkName: "computer_id";
960
+ readonly description: "Computer id (cmp_...), as returned by computers.create or computers.list.";
769
961
  }, {
770
962
  readonly name: "lease_id";
771
963
  readonly sdkName: "lease_id";
964
+ readonly description: "lease_id from the connect response.";
772
965
  }];
773
966
  readonly query: readonly [];
774
967
  }, {
@@ -841,6 +1034,7 @@ export declare const operations: readonly [{
841
1034
  readonly pathParams: readonly [{
842
1035
  readonly name: "deployment_run_id";
843
1036
  readonly sdkName: "deployment_run_id";
1037
+ readonly description: "Deployment run id (drun_...), returned by deployments.run or deployment_runs.list.";
844
1038
  }];
845
1039
  readonly query: readonly [];
846
1040
  }, {
@@ -976,6 +1170,7 @@ export declare const operations: readonly [{
976
1170
  readonly pathParams: readonly [{
977
1171
  readonly name: "deployment_id";
978
1172
  readonly sdkName: "deployment_id";
1173
+ readonly description: "Deployment id (depl_...), returned by deployments.create or deployments.list.";
979
1174
  }];
980
1175
  readonly query: readonly [];
981
1176
  }, {
@@ -990,6 +1185,7 @@ export declare const operations: readonly [{
990
1185
  readonly pathParams: readonly [{
991
1186
  readonly name: "deployment_id";
992
1187
  readonly sdkName: "deployment_id";
1188
+ readonly description: "Deployment id (depl_...), returned by deployments.create or deployments.list.";
993
1189
  }];
994
1190
  readonly query: readonly [];
995
1191
  readonly body: {
@@ -1066,6 +1262,7 @@ export declare const operations: readonly [{
1066
1262
  readonly pathParams: readonly [{
1067
1263
  readonly name: "deployment_id";
1068
1264
  readonly sdkName: "deployment_id";
1265
+ readonly description: "Deployment id (depl_...), returned by deployments.create or deployments.list.";
1069
1266
  }];
1070
1267
  readonly query: readonly [];
1071
1268
  }, {
@@ -1080,6 +1277,7 @@ export declare const operations: readonly [{
1080
1277
  readonly pathParams: readonly [{
1081
1278
  readonly name: "deployment_id";
1082
1279
  readonly sdkName: "deployment_id";
1280
+ readonly description: "Deployment id (depl_...), returned by deployments.create or deployments.list.";
1083
1281
  }];
1084
1282
  readonly query: readonly [];
1085
1283
  }, {
@@ -1094,6 +1292,7 @@ export declare const operations: readonly [{
1094
1292
  readonly pathParams: readonly [{
1095
1293
  readonly name: "deployment_id";
1096
1294
  readonly sdkName: "deployment_id";
1295
+ readonly description: "Deployment id (depl_...), returned by deployments.create or deployments.list.";
1097
1296
  }];
1098
1297
  readonly query: readonly [];
1099
1298
  }, {
@@ -1108,174 +1307,7 @@ export declare const operations: readonly [{
1108
1307
  readonly pathParams: readonly [{
1109
1308
  readonly name: "deployment_id";
1110
1309
  readonly sdkName: "deployment_id";
1111
- }];
1112
- readonly query: readonly [];
1113
- }, {
1114
- readonly resource: "agent.embed";
1115
- readonly method: "retrieveAppearance";
1116
- readonly summary: "Read chat appearance";
1117
- readonly description: "Load saved appearance for an iframe or Hosted chat page. Supply an end-user embed token as Bearer authorization, or a console-issued publishable key in Praxis-Publishable-Key before anonymous token issuance. The credential selects the agent; identity_number and agent_id query parameters are rejected with 400. Missing appearance returns an empty object. Kit option names retain camelCase. Responses are private and cacheable for 60 seconds. Component hosts configure Kit in their own code instead.";
1118
- readonly http: "GET";
1119
- readonly path: "/agent/v1/embed/appearance";
1120
- readonly streaming: "no";
1121
- readonly pagination: false;
1122
- readonly pathParams: readonly [];
1123
- readonly query: readonly [];
1124
- }, {
1125
- readonly resource: "agent.embed.exchange";
1126
- readonly method: "create";
1127
- readonly summary: "Exchange Hosted Code";
1128
- readonly description: "Redeem a single-use hosted link credential for an end-user token.\n\nRead code from the c fragment parameter of hosted_url returned by embed token creation with hosted true, then remove the fragment before exchanging. No Authorization header is required; the code authenticates this request. The code expires after 60 seconds and is consumed atomically on exchange, so concurrent attempts have only one winner. Expired, used and unknown codes return the same 404 body. Keep the token in memory and return to the host website for a fresh link when it expires; exchange cannot refresh it. Requests are IP limited per minute using the anonymous entrypoint budget (default 20). Example body is {\"code\":\"<code from hosted_url>\"}.";
1129
- readonly http: "POST";
1130
- readonly path: "/agent/v1/embed/exchange";
1131
- readonly streaming: "no";
1132
- readonly pagination: false;
1133
- readonly pathParams: readonly [];
1134
- readonly query: readonly [];
1135
- readonly body: {
1136
- readonly required: true;
1137
- readonly fields: readonly [{
1138
- readonly name: "code";
1139
- readonly type: "string";
1140
- readonly required: true;
1141
- readonly description: "Single-use credential from the c fragment parameter of hosted_url returned by embed token creation. Valid for 60 seconds.";
1142
- }];
1143
- };
1144
- }, {
1145
- readonly resource: "agent.embedTokens";
1146
- readonly method: "list";
1147
- readonly summary: "List Embed Tokens";
1148
- readonly description: "List embed token issuance records in your organization.\n\nIncludes expired and revoked grants; returns neither token nor token_id. Sorts by created_at, then grant id, both descending. agent_id accepts agent_ or agt_; external_user_id matches exactly. limit is 1–100 (default 20). Reuse next_page as page with the same filters and organization; a mismatch returns 400. End-user credentials return 404.";
1149
- readonly http: "GET";
1150
- readonly path: "/agent/v1/embed_tokens";
1151
- readonly streaming: "no";
1152
- readonly pagination: false;
1153
- readonly pathParams: readonly [];
1154
- readonly query: readonly [{
1155
- readonly name: "agent_id";
1156
- readonly type: "string";
1157
- readonly required: false;
1158
- readonly description: "Filter by service agent identifier (agent_ or agt_ prefix).";
1159
- }, {
1160
- readonly name: "external_user_id";
1161
- readonly type: "string";
1162
- readonly required: false;
1163
- readonly description: "Exact host user identifier supplied at issuance.";
1164
- }, {
1165
- readonly name: "limit";
1166
- readonly type: "integer";
1167
- readonly required: false;
1168
- readonly description: "Maximum records per page; defaults to 20.";
1169
- }, {
1170
- readonly name: "page";
1171
- readonly type: "string";
1172
- readonly required: false;
1173
- readonly description: "next_page from a previous response with the same filters.";
1174
- }];
1175
- }, {
1176
- readonly resource: "agent.embedTokens";
1177
- readonly method: "create";
1178
- readonly summary: "Create Embed Token";
1179
- readonly description: "Issue a short-lived credential on your backend for an end user of a service agent.\n\nRequires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.";
1180
- readonly http: "POST";
1181
- readonly path: "/agent/v1/embed_tokens";
1182
- readonly streaming: "no";
1183
- readonly pagination: false;
1184
- readonly pathParams: readonly [];
1185
- readonly query: readonly [];
1186
- readonly body: {
1187
- readonly required: true;
1188
- readonly fields: readonly [{
1189
- readonly name: "hosted";
1190
- readonly type: "boolean";
1191
- readonly required: false;
1192
- readonly description: "Set true to also return a hosted chat URL with a single-use credential valid for 60 seconds. Defaults to false; the agent must have an identity_number.";
1193
- }, {
1194
- readonly name: "agent";
1195
- readonly type: "string";
1196
- readonly required: true;
1197
- readonly description: "Service agent ID or identity_number from agent retrieval; it must belong to your organization and be active.";
1198
- }, {
1199
- readonly name: "version";
1200
- readonly type: "integer";
1201
- readonly required: false;
1202
- readonly description: "Existing agent version to pin. Omit to pin the latest version at issuance.";
1203
- }, {
1204
- readonly name: "external_user_id";
1205
- readonly type: "string";
1206
- readonly required: true;
1207
- readonly description: "Your application's stable end-user identifier, scoped to this organization and agent.";
1208
- }, {
1209
- readonly name: "ttl_seconds";
1210
- readonly type: "integer";
1211
- readonly required: false;
1212
- readonly description: "Token lifetime in seconds. Defaults to the embed policy TTL and cannot exceed its maximum or 3600 seconds.";
1213
- }, {
1214
- readonly name: "budget_cents";
1215
- readonly type: "integer";
1216
- readonly required: false;
1217
- readonly description: "Session budget in cents. Defaults to the embed policy session budget and cannot exceed its maximum.";
1218
- }, {
1219
- readonly name: "system_message";
1220
- readonly type: "array";
1221
- readonly itemType: "object";
1222
- readonly required: false;
1223
- readonly description: "Optional host context as text blocks, limited to 8192 UTF-8 bytes in total.";
1224
- }, {
1225
- readonly name: "agent_override";
1226
- readonly type: "object";
1227
- readonly required: false;
1228
- readonly description: "Optional system prompt override, accepted only when the embed policy allows agent overrides.";
1229
- }, {
1230
- readonly name: "allowed_origins";
1231
- readonly type: "array";
1232
- readonly itemType: "string";
1233
- readonly required: false;
1234
- readonly description: "Optional subset of the policy origin entries, compared exactly. Omit to snapshot every policy origin.";
1235
- }, {
1236
- readonly name: "metadata";
1237
- readonly type: "object";
1238
- readonly required: false;
1239
- readonly description: "Host metadata preserved verbatim; at most 16 keys of 1–64 characters and string values of at most 512 characters. Defaults to an empty object.";
1240
- }];
1241
- };
1242
- }, {
1243
- readonly resource: "agent.embedTokens.anonymous";
1244
- readonly method: "create";
1245
- readonly summary: "Issue anonymous visitor token";
1246
- readonly description: "Obtain a short-lived embedding token for a visitor without an account using the agent owner's publishable key.\n\nNo Authorization header is required. Send the browser Origin allowed by the agent policy. Save a returned visitor_secret and reuse it for refreshes; only new visitors receive one. Unknown secrets create new visitors, and extra fields including visitor_id return 400. Issuance uses the key creator's organization membership, the key session budget and the smaller of the policy TTL maximum and 3600 seconds. IP requests are limited per minute (default 20); UTC daily session and spending caps are checked across the key's primary sessions created that day. Token issuance itself does not create a session or charge usage; subsequent sessions bill the host organization. Example body: {\"publishable_key\":\"pk_praxis_example\"}.";
1247
- readonly http: "POST";
1248
- readonly path: "/agent/v1/embed_tokens/anonymous";
1249
- readonly streaming: "no";
1250
- readonly pagination: false;
1251
- readonly pathParams: readonly [];
1252
- readonly query: readonly [];
1253
- readonly body: {
1254
- readonly required: true;
1255
- readonly fields: readonly [{
1256
- readonly name: "publishable_key";
1257
- readonly type: "string";
1258
- readonly required: true;
1259
- readonly description: "Public key created by the service agent owner; safe to include in browser code.";
1260
- }, {
1261
- readonly name: "visitor_secret";
1262
- readonly type: "string";
1263
- readonly required: false;
1264
- readonly description: "Secret returned by a previous anonymous issuance for this key. Omit for a new visitor; an unknown secret creates a new visitor.";
1265
- }];
1266
- };
1267
- }, {
1268
- readonly resource: "agent.embedTokens.revoke";
1269
- readonly method: "create";
1270
- readonly summary: "Revoke Embed Token";
1271
- readonly description: "Revoke an embed token and close its open event streams.\n\nUse an id from issuance or listing. Revokes the credential before setting revoked_at; upstream failure leaves it unset. Streams receive session.error (EMBED_TOKEN_REVOKED), then close immediately; other credentials are unaffected. Idempotent; repeats return the original revoked record without another revocation or audit. Missing or foreign grants and end-user credentials return 404.";
1272
- readonly http: "POST";
1273
- readonly path: "/agent/v1/embed_tokens/{id}/revoke";
1274
- readonly streaming: "no";
1275
- readonly pagination: false;
1276
- readonly pathParams: readonly [{
1277
- readonly name: "id";
1278
- readonly sdkName: "id";
1310
+ readonly description: "Deployment id (depl_...), returned by deployments.create or deployments.list.";
1279
1311
  }];
1280
1312
  readonly query: readonly [];
1281
1313
  }, {
@@ -1309,7 +1341,7 @@ export declare const operations: readonly [{
1309
1341
  readonly resource: "agent.environments";
1310
1342
  readonly method: "create";
1311
1343
  readonly summary: "Create environment";
1312
- readonly description: "Create a tenant-owned cloud environment: a sandbox recipe (packages to install and networking policy) that sessions can select through environment_id. Package installation happens when the session's sandbox is created; a failed install terminates that session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. Limited networking is applied at sandbox creation. Unlike Anthropic Managed Agents, self_hosted environments, scope and cross-session package caching are not supported.";
1344
+ readonly description: "Create a tenant-owned cloud environment: a sandbox recipe (packages to install and networking policy) that sessions can select through environment_id. Package installation happens when the session's sandbox is created; a failed install terminates that session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. Limited networking is applied at sandbox creation. Unlike Anthropic Managed Agents, self_hosted environments, scope and cross-session package caching are not supported. config.template must name an available sandbox template, otherwise 400 lists the available ones.";
1313
1345
  readonly http: "POST";
1314
1346
  readonly path: "/agent/v1/environments";
1315
1347
  readonly streaming: "no";
@@ -1338,12 +1370,6 @@ export declare const operations: readonly [{
1338
1370
  readonly type: "object";
1339
1371
  readonly required: false;
1340
1372
  readonly description: "Free-form string key/value pairs.";
1341
- }, {
1342
- readonly name: "scope";
1343
- readonly type: "string";
1344
- readonly enum: readonly ["organization", "account"];
1345
- readonly required: false;
1346
- readonly description: "The visibility scope for this environment. 'organization' makes the\nenvironment visible to all accounts. 'account' restricts visibility to the\nowning account only. API organizations support only 'organization'; 'account' is\nrejected. If not specified, defaults based on organization type.";
1347
1373
  }];
1348
1374
  };
1349
1375
  }, {
@@ -1358,13 +1384,14 @@ export declare const operations: readonly [{
1358
1384
  readonly pathParams: readonly [{
1359
1385
  readonly name: "environment_id";
1360
1386
  readonly sdkName: "environment_id";
1387
+ readonly description: "Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed.";
1361
1388
  }];
1362
1389
  readonly query: readonly [];
1363
1390
  }, {
1364
1391
  readonly resource: "agent.environments";
1365
1392
  readonly method: "update";
1366
1393
  readonly summary: "Update environment";
1367
- readonly description: "Update the configuration of a tenant-owned cloud environment. Built-in environments are read-only. Package installation and limited networking are applied when a session's sandbox is created. Omitted fields keep their value.";
1394
+ readonly description: "Update the configuration of a tenant-owned cloud environment. Built-in environments are read-only. Package installation and limited networking are applied when a session's sandbox is created. Omitted fields keep their value. A changed config.template must name an available sandbox template, otherwise 400 lists the available ones.";
1368
1395
  readonly http: "POST";
1369
1396
  readonly path: "/agent/v1/environments/{environment_id}";
1370
1397
  readonly streaming: "no";
@@ -1372,6 +1399,7 @@ export declare const operations: readonly [{
1372
1399
  readonly pathParams: readonly [{
1373
1400
  readonly name: "environment_id";
1374
1401
  readonly sdkName: "environment_id";
1402
+ readonly description: "Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed.";
1375
1403
  }];
1376
1404
  readonly query: readonly [];
1377
1405
  readonly body: {
@@ -1396,19 +1424,13 @@ export declare const operations: readonly [{
1396
1424
  readonly type: "string";
1397
1425
  readonly required: false;
1398
1426
  readonly description: "Updated name for the environment";
1399
- }, {
1400
- readonly name: "scope";
1401
- readonly type: "string";
1402
- readonly enum: readonly ["organization", "account"];
1403
- readonly required: false;
1404
- readonly description: "The visibility scope for this environment. 'organization' makes the\nenvironment visible to all accounts. 'account' restricts visibility to the\nowning account only.";
1405
1427
  }];
1406
1428
  };
1407
1429
  }, {
1408
1430
  readonly resource: "agent.environments";
1409
1431
  readonly method: "archive";
1410
1432
  readonly summary: "Archive environment";
1411
- readonly description: "Soft-archive a tenant-owned cloud environment so it can no longer be used to create new sessions. Built-in environments are read-only and cannot be archived.";
1433
+ readonly description: "Soft-archive a tenant-owned cloud environment so it can no longer be used to create new sessions. Built-in environments are read-only and cannot be archived. An environment that the active version of a non-archived agent uses as environment_id returns 409 RESOURCE_IN_USE naming the agents; point them at another environment first.";
1412
1434
  readonly http: "POST";
1413
1435
  readonly path: "/agent/v1/environments/{environment_id}/archive";
1414
1436
  readonly streaming: "no";
@@ -1416,13 +1438,14 @@ export declare const operations: readonly [{
1416
1438
  readonly pathParams: readonly [{
1417
1439
  readonly name: "environment_id";
1418
1440
  readonly sdkName: "environment_id";
1441
+ readonly description: "Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed.";
1419
1442
  }];
1420
1443
  readonly query: readonly [];
1421
1444
  }, {
1422
1445
  readonly resource: "agent.sessions";
1423
1446
  readonly method: "list";
1424
1447
  readonly summary: "List sessions";
1425
- readonly description: "List sessions of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Unlike Anthropic Managed Agents, only limit, page, agent_id and deployment_id are honored; the other filters declared here (agent_version, created_at ranges, memory_store_id, include_archived, order, statuses) are not supported and return 400. Use the returned id with sessions.retrieve or sessions.events.list; pass next_page as page for the next page.";
1448
+ readonly description: "List sessions of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Archived sessions are hidden unless include_archived is true. Unlike Anthropic Managed Agents, only limit, page, agent_id, deployment_id and include_archived are honored; the other filters declared here (agent_version, created_at ranges, memory_store_id, order, statuses) are not supported and return 400. Use the returned id with sessions.retrieve or sessions.events.list; pass next_page as page for the next page.";
1426
1449
  readonly http: "GET";
1427
1450
  readonly path: "/agent/v1/sessions";
1428
1451
  readonly streaming: "no";
@@ -1447,7 +1470,7 @@ export declare const operations: readonly [{
1447
1470
  readonly name: "created_at[gte]";
1448
1471
  readonly type: "string";
1449
1472
  readonly required: false;
1450
- readonly description: "Created-at lower bound for sessions. Declared by the Managed Agents shape but not supported here: sessions.list honors only limit, page, agent_id and deployment_id, and other filters return 400.";
1473
+ readonly description: "Created-at lower bound for sessions. Declared by the Managed Agents shape but not supported here: sessions.list honors only limit, page, agent_id, deployment_id and include_archived, and other filters return 400.";
1451
1474
  }, {
1452
1475
  readonly name: "created_at[lt]";
1453
1476
  readonly type: "string";
@@ -1457,7 +1480,7 @@ export declare const operations: readonly [{
1457
1480
  readonly name: "created_at[lte]";
1458
1481
  readonly type: "string";
1459
1482
  readonly required: false;
1460
- readonly description: "Created-at upper bound for sessions. Declared by the Managed Agents shape but not supported here: sessions.list honors only limit, page, agent_id and deployment_id, and other filters return 400.";
1483
+ readonly description: "Created-at upper bound for sessions. Declared by the Managed Agents shape but not supported here: sessions.list honors only limit, page, agent_id, deployment_id and include_archived, and other filters return 400.";
1461
1484
  }, {
1462
1485
  readonly name: "deployment_id";
1463
1486
  readonly type: "string";
@@ -1468,7 +1491,7 @@ export declare const operations: readonly [{
1468
1491
  readonly type: "boolean";
1469
1492
  readonly enum: readonly [false, true];
1470
1493
  readonly required: false;
1471
- readonly description: "Declared by the Managed Agents shape but not supported by sessions.list; sending it returns 400. Archived sessions are retrievable by id.";
1494
+ readonly description: "Whether archived sessions are listed: true includes them, false (the default) hides them. A value other than true or false returns 400. Archived sessions stay retrievable by id either way.";
1472
1495
  }, {
1473
1496
  readonly name: "memory_store_id";
1474
1497
  readonly type: "string";
@@ -1513,7 +1536,7 @@ export declare const operations: readonly [{
1513
1536
  readonly resource: "agent.sessions";
1514
1537
  readonly method: "create";
1515
1538
  readonly summary: "Create session";
1516
- readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id (active_version) or {id, version, type:\"agent\"}. Unlike Anthropic Managed Agents, omit environment_id to get a light machine, unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, omission returns environment_id=light; explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Inline agent overrides are not supported. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Omitted budget defaults to USD 20; null removes the limit, and a limit object uses a positive integer string of USD cents. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.";
1539
+ readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id or {type:\"agent\", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:\"agent_with_overrides\", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:\"limit\", max_list_cost:{amount, currency:\"USD\"}} where amount is a positive integer string of US cents (\"2000\" is USD 20.00); omitted budget defaults to \"2000\" and null removes the limit. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.";
1517
1540
  readonly http: "POST";
1518
1541
  readonly path: "/agent/v1/sessions";
1519
1542
  readonly streaming: "no";
@@ -1526,17 +1549,17 @@ export declare const operations: readonly [{
1526
1549
  readonly name: "agent";
1527
1550
  readonly type: "object";
1528
1551
  readonly required: true;
1529
- readonly description: "Agent identifier. Accepts the `agent` ID string, which pins the\nlatest version for the session, or an `agent` object with both id and version\nspecified.";
1552
+ readonly description: "The agent to run: an agent id string, or {type: \"agent\", id, version?}. An id alone, or an object without version, pins the agent's active_version at the moment the session is created (the version chosen with agents.versions.apply, not necessarily the newest saved one); version pins that exact version. Unlike Managed Agents, the only inline override is a system prompt ({type: \"agent_with_overrides\", id, system}); to change the model, tools, MCP servers or skills, save a version instead.";
1530
1553
  }, {
1531
1554
  readonly name: "environment_id";
1532
1555
  readonly type: "string";
1533
1556
  readonly required: false;
1534
- readonly description: "Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission selects the built-in light environment and returns session.environment_id=light; explicit null allocates no machine and makes machine tools, including codemode and bash, unavailable. Personal agents use their selected Computer.";
1557
+ readonly description: "Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission uses the default environment saved in the agent version (light for a new agent) and returns it as session.environment_id; explicit null allocates no machine and makes machine tools, including codemode and bash, unavailable. Personal agents use their selected Computer.";
1535
1558
  }, {
1536
1559
  readonly name: "budget";
1537
1560
  readonly type: "object";
1538
1561
  readonly required: false;
1539
- readonly description: "Session spending limit in USD cents; null when unlimited. Creation defaults to USD 20 when omitted. A limit amount is a positive integer string; removing a limit with null prevents setting it again for that session.";
1562
+ readonly description: "Session spending limit, {type: \"limit\", max_list_cost: {amount, currency}}; null when unlimited. amount is in US dollars: send an integer or up to 2 decimals (\"0.50\"), and responses carry exactly 2 decimals (\"20.00\"). Creation defaults to USD 20.00 when omitted. More decimals, zero or a number return 400. Removing the limit with null prevents setting it again for that session.";
1540
1563
  }, {
1541
1564
  readonly name: "initial_events";
1542
1565
  readonly type: "array";
@@ -1604,6 +1627,7 @@ export declare const operations: readonly [{
1604
1627
  readonly pathParams: readonly [{
1605
1628
  readonly name: "session_id";
1606
1629
  readonly sdkName: "session_id";
1630
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1607
1631
  }];
1608
1632
  readonly query: readonly [];
1609
1633
  }, {
@@ -1618,6 +1642,7 @@ export declare const operations: readonly [{
1618
1642
  readonly pathParams: readonly [{
1619
1643
  readonly name: "session_id";
1620
1644
  readonly sdkName: "session_id";
1645
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1621
1646
  }];
1622
1647
  readonly query: readonly [];
1623
1648
  }, {
@@ -1632,16 +1657,12 @@ export declare const operations: readonly [{
1632
1657
  readonly pathParams: readonly [{
1633
1658
  readonly name: "session_id";
1634
1659
  readonly sdkName: "session_id";
1660
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1635
1661
  }];
1636
1662
  readonly query: readonly [];
1637
1663
  readonly body: {
1638
1664
  readonly required: true;
1639
1665
  readonly fields: readonly [{
1640
- readonly name: "agent";
1641
- readonly type: "object";
1642
- readonly required: false;
1643
- readonly description: "Agent definition the session uses after the change; null when unchanged.";
1644
- }, {
1645
1666
  readonly name: "budget";
1646
1667
  readonly type: "object";
1647
1668
  readonly required: false;
@@ -1686,6 +1707,7 @@ export declare const operations: readonly [{
1686
1707
  readonly pathParams: readonly [{
1687
1708
  readonly name: "session_id";
1688
1709
  readonly sdkName: "session_id";
1710
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1689
1711
  }];
1690
1712
  readonly query: readonly [];
1691
1713
  }, {
@@ -1700,6 +1722,7 @@ export declare const operations: readonly [{
1700
1722
  readonly pathParams: readonly [{
1701
1723
  readonly name: "session_id";
1702
1724
  readonly sdkName: "session_id";
1725
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1703
1726
  }];
1704
1727
  readonly query: readonly [];
1705
1728
  }, {
@@ -1714,9 +1737,11 @@ export declare const operations: readonly [{
1714
1737
  readonly pathParams: readonly [{
1715
1738
  readonly name: "session_id";
1716
1739
  readonly sdkName: "session_id";
1740
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1717
1741
  }, {
1718
1742
  readonly name: "task_id";
1719
1743
  readonly sdkName: "task_id";
1744
+ readonly description: "Background task id (task_...), as listed by sessions.background_tasks.list.";
1720
1745
  }];
1721
1746
  readonly query: readonly [{
1722
1747
  readonly name: "offset";
@@ -1741,9 +1766,11 @@ export declare const operations: readonly [{
1741
1766
  readonly pathParams: readonly [{
1742
1767
  readonly name: "session_id";
1743
1768
  readonly sdkName: "session_id";
1769
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1744
1770
  }, {
1745
1771
  readonly name: "task_id";
1746
1772
  readonly sdkName: "task_id";
1773
+ readonly description: "Background task id (task_...), as listed by sessions.background_tasks.list.";
1747
1774
  }];
1748
1775
  readonly query: readonly [];
1749
1776
  }, {
@@ -1758,6 +1785,7 @@ export declare const operations: readonly [{
1758
1785
  readonly pathParams: readonly [{
1759
1786
  readonly name: "session_id";
1760
1787
  readonly sdkName: "session_id";
1788
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1761
1789
  }];
1762
1790
  readonly query: readonly [];
1763
1791
  readonly body: {
@@ -1781,9 +1809,11 @@ export declare const operations: readonly [{
1781
1809
  readonly pathParams: readonly [{
1782
1810
  readonly name: "session_id";
1783
1811
  readonly sdkName: "session_id";
1812
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1784
1813
  }, {
1785
1814
  readonly name: "operation_id";
1786
1815
  readonly sdkName: "operation_id";
1816
+ readonly description: "Compaction operation id returned by sessions.compact in the id field of the session_compaction object.";
1787
1817
  }];
1788
1818
  readonly query: readonly [];
1789
1819
  }, {
@@ -1798,6 +1828,7 @@ export declare const operations: readonly [{
1798
1828
  readonly pathParams: readonly [{
1799
1829
  readonly name: "session_id";
1800
1830
  readonly sdkName: "session_id";
1831
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1801
1832
  }];
1802
1833
  readonly query: readonly [];
1803
1834
  }, {
@@ -1812,6 +1843,7 @@ export declare const operations: readonly [{
1812
1843
  readonly pathParams: readonly [{
1813
1844
  readonly name: "session_id";
1814
1845
  readonly sdkName: "session_id";
1846
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1815
1847
  }];
1816
1848
  readonly query: readonly [];
1817
1849
  }, {
@@ -1826,6 +1858,7 @@ export declare const operations: readonly [{
1826
1858
  readonly pathParams: readonly [{
1827
1859
  readonly name: "session_id";
1828
1860
  readonly sdkName: "session_id";
1861
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1829
1862
  }];
1830
1863
  readonly query: readonly [{
1831
1864
  readonly name: "created_at[gt]";
@@ -1882,6 +1915,7 @@ export declare const operations: readonly [{
1882
1915
  readonly pathParams: readonly [{
1883
1916
  readonly name: "session_id";
1884
1917
  readonly sdkName: "session_id";
1918
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1885
1919
  }];
1886
1920
  readonly query: readonly [];
1887
1921
  readonly body: {
@@ -1906,6 +1940,7 @@ export declare const operations: readonly [{
1906
1940
  readonly pathParams: readonly [{
1907
1941
  readonly name: "session_id";
1908
1942
  readonly sdkName: "session_id";
1943
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1909
1944
  }];
1910
1945
  readonly query: readonly [{
1911
1946
  readonly name: "event_deltas";
@@ -1927,6 +1962,7 @@ export declare const operations: readonly [{
1927
1962
  readonly pathParams: readonly [{
1928
1963
  readonly name: "session_id";
1929
1964
  readonly sdkName: "session_id";
1965
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1930
1966
  }];
1931
1967
  readonly query: readonly [];
1932
1968
  readonly body: {
@@ -1950,6 +1986,7 @@ export declare const operations: readonly [{
1950
1986
  readonly pathParams: readonly [{
1951
1987
  readonly name: "session_id";
1952
1988
  readonly sdkName: "session_id";
1989
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1953
1990
  }];
1954
1991
  readonly query: readonly [{
1955
1992
  readonly name: "limit";
@@ -1974,6 +2011,7 @@ export declare const operations: readonly [{
1974
2011
  readonly pathParams: readonly [{
1975
2012
  readonly name: "session_id";
1976
2013
  readonly sdkName: "session_id";
2014
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
1977
2015
  }];
1978
2016
  readonly query: readonly [{
1979
2017
  readonly name: "type";
@@ -2008,9 +2046,11 @@ export declare const operations: readonly [{
2008
2046
  readonly pathParams: readonly [{
2009
2047
  readonly name: "session_id";
2010
2048
  readonly sdkName: "session_id";
2049
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
2011
2050
  }, {
2012
2051
  readonly name: "resource_id";
2013
2052
  readonly sdkName: "resource_id";
2053
+ readonly description: "Id of a resource attached to the session, as returned by sessions.resources.add or sessions.resources.list.";
2014
2054
  }];
2015
2055
  readonly query: readonly [{
2016
2056
  readonly name: "session_id";
@@ -2031,9 +2071,11 @@ export declare const operations: readonly [{
2031
2071
  readonly pathParams: readonly [{
2032
2072
  readonly name: "session_id";
2033
2073
  readonly sdkName: "session_id";
2074
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
2034
2075
  }, {
2035
2076
  readonly name: "resource_id";
2036
2077
  readonly sdkName: "resource_id";
2078
+ readonly description: "Id of a resource attached to the session, as returned by sessions.resources.add or sessions.resources.list.";
2037
2079
  }];
2038
2080
  readonly query: readonly [{
2039
2081
  readonly name: "session_id";
@@ -2054,9 +2096,11 @@ export declare const operations: readonly [{
2054
2096
  readonly pathParams: readonly [{
2055
2097
  readonly name: "session_id";
2056
2098
  readonly sdkName: "session_id";
2099
+ readonly description: "Session id from session creation or listing.";
2057
2100
  }, {
2058
2101
  readonly name: "run_id";
2059
2102
  readonly sdkName: "run_id";
2103
+ readonly description: "Existing run_id from this session's events.";
2060
2104
  }];
2061
2105
  readonly query: readonly [];
2062
2106
  }, {
@@ -2071,9 +2115,11 @@ export declare const operations: readonly [{
2071
2115
  readonly pathParams: readonly [{
2072
2116
  readonly name: "session_id";
2073
2117
  readonly sdkName: "session_id";
2118
+ readonly description: "Session id from session creation or listing.";
2074
2119
  }, {
2075
2120
  readonly name: "run_id";
2076
2121
  readonly sdkName: "run_id";
2122
+ readonly description: "Existing run_id from this session's events.";
2077
2123
  }];
2078
2124
  readonly query: readonly [];
2079
2125
  readonly body: {
@@ -2103,6 +2149,7 @@ export declare const operations: readonly [{
2103
2149
  readonly pathParams: readonly [{
2104
2150
  readonly name: "session_id";
2105
2151
  readonly sdkName: "session_id";
2152
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
2106
2153
  }];
2107
2154
  readonly query: readonly [{
2108
2155
  readonly name: "limit";
@@ -2127,9 +2174,11 @@ export declare const operations: readonly [{
2127
2174
  readonly pathParams: readonly [{
2128
2175
  readonly name: "session_id";
2129
2176
  readonly sdkName: "session_id";
2177
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
2130
2178
  }, {
2131
2179
  readonly name: "thread_id";
2132
2180
  readonly sdkName: "thread_id";
2181
+ readonly description: "Execution thread id (sthr_...), as listed by sessions.threads.list; the primary thread id equals the session's own thread. Unknown or foreign ids return 404.";
2133
2182
  }];
2134
2183
  readonly query: readonly [{
2135
2184
  readonly name: "session_id";
@@ -2150,9 +2199,11 @@ export declare const operations: readonly [{
2150
2199
  readonly pathParams: readonly [{
2151
2200
  readonly name: "session_id";
2152
2201
  readonly sdkName: "session_id";
2202
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
2153
2203
  }, {
2154
2204
  readonly name: "thread_id";
2155
2205
  readonly sdkName: "thread_id";
2206
+ readonly description: "Execution thread id (sthr_...), as listed by sessions.threads.list; the primary thread id equals the session's own thread. Unknown or foreign ids return 404.";
2156
2207
  }];
2157
2208
  readonly query: readonly [{
2158
2209
  readonly name: "session_id";
@@ -2173,9 +2224,11 @@ export declare const operations: readonly [{
2173
2224
  readonly pathParams: readonly [{
2174
2225
  readonly name: "session_id";
2175
2226
  readonly sdkName: "session_id";
2227
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
2176
2228
  }, {
2177
2229
  readonly name: "thread_id";
2178
2230
  readonly sdkName: "thread_id";
2231
+ readonly description: "Execution thread id (sthr_...), as listed by sessions.threads.list; the primary thread id equals the session's own thread. Unknown or foreign ids return 404.";
2179
2232
  }];
2180
2233
  readonly query: readonly [{
2181
2234
  readonly name: "session_id";
@@ -2206,9 +2259,11 @@ export declare const operations: readonly [{
2206
2259
  readonly pathParams: readonly [{
2207
2260
  readonly name: "session_id";
2208
2261
  readonly sdkName: "session_id";
2262
+ readonly description: "Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.";
2209
2263
  }, {
2210
2264
  readonly name: "thread_id";
2211
2265
  readonly sdkName: "thread_id";
2266
+ readonly description: "Execution thread id (sthr_...), as listed by sessions.threads.list; the primary thread id equals the session's own thread. Unknown or foreign ids return 404.";
2212
2267
  }];
2213
2268
  readonly query: readonly [{
2214
2269
  readonly name: "session_id";
@@ -2254,7 +2309,7 @@ export declare const operations: readonly [{
2254
2309
  readonly resource: "agent.skills";
2255
2310
  readonly method: "create";
2256
2311
  readonly summary: "Create skill";
2257
- readonly description: "Upload a skill: a directory that contains SKILL.md, which the agent reads when it needs the skill. Send multipart/form-data with one files part per file, each file name being its path under one top-level directory (pdf/SKILL.md, pdf/scripts/run.py), and an optional display_name. SKILL.md frontmatter needs a description; name defaults to the directory name. Limits: 8 MB in total, at most 200 files, no .. segments, absolute paths or empty names; a violation returns 400 naming the path or field. The upload creates the skill and its first version, and versions are immutable. Attach the skill to an agent with `skills` on the agent.";
2312
+ readonly description: "Upload a skill: a directory that contains SKILL.md, which the agent reads when it needs the skill. Send multipart/form-data with one files part per file, each file name being its path under one top-level directory (pdf/SKILL.md, pdf/scripts/run.py), and an optional display_name. SKILL.md frontmatter needs a description; name defaults to the directory name and must be one folder name (1-255 characters, no \"/\", backslash or NUL, not \".\" or \"..\"), otherwise the upload returns 400 stating the allowed form. Limits: 8 MB in total, at most 200 files, no .. segments, absolute paths or empty names; a violation returns 400 naming the path or field. The upload creates the skill and its first version, and versions are immutable. Attach the skill to an agent with `skills` on the agent.";
2258
2313
  readonly http: "POST";
2259
2314
  readonly path: "/agent/v1/skills";
2260
2315
  readonly streaming: "no";
@@ -2281,7 +2336,7 @@ export declare const operations: readonly [{
2281
2336
  readonly resource: "agent.skills";
2282
2337
  readonly method: "delete";
2283
2338
  readonly summary: "Delete skill";
2284
- readonly description: "Delete a skill that has no live versions. A skill that still has versions returns 409 Delete all versions first; remove each with skills.versions.delete, then call this. Returns {id, type: skill_deleted}. skill_id comes from skills.create or skills.list.";
2339
+ readonly description: "Delete a skill together with all of its versions. A skill that is still attached to an agent returns 409 RESOURCE_IN_USE naming up to 10 agent ids (the active or latest version of a non-archived agent counts); remove it from those agents first. Returns {id, type: skill_deleted}. skill_id comes from skills.create or skills.list.";
2285
2340
  readonly http: "DELETE";
2286
2341
  readonly path: "/agent/v1/skills/{skill_id}";
2287
2342
  readonly streaming: "no";
@@ -2289,6 +2344,7 @@ export declare const operations: readonly [{
2289
2344
  readonly pathParams: readonly [{
2290
2345
  readonly name: "skill_id";
2291
2346
  readonly sdkName: "skill_id";
2347
+ readonly description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.";
2292
2348
  }];
2293
2349
  readonly query: readonly [];
2294
2350
  }, {
@@ -2303,6 +2359,7 @@ export declare const operations: readonly [{
2303
2359
  readonly pathParams: readonly [{
2304
2360
  readonly name: "skill_id";
2305
2361
  readonly sdkName: "skill_id";
2362
+ readonly description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.";
2306
2363
  }];
2307
2364
  readonly query: readonly [];
2308
2365
  }, {
@@ -2317,6 +2374,7 @@ export declare const operations: readonly [{
2317
2374
  readonly pathParams: readonly [{
2318
2375
  readonly name: "skill_id";
2319
2376
  readonly sdkName: "skill_id";
2377
+ readonly description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.";
2320
2378
  }];
2321
2379
  readonly query: readonly [{
2322
2380
  readonly name: "limit";
@@ -2342,6 +2400,7 @@ export declare const operations: readonly [{
2342
2400
  readonly pathParams: readonly [{
2343
2401
  readonly name: "skill_id";
2344
2402
  readonly sdkName: "skill_id";
2403
+ readonly description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.";
2345
2404
  }];
2346
2405
  readonly query: readonly [];
2347
2406
  readonly body: {
@@ -2358,7 +2417,7 @@ export declare const operations: readonly [{
2358
2417
  readonly resource: "agent.skills.versions";
2359
2418
  readonly method: "delete";
2360
2419
  readonly summary: "Delete skill version";
2361
- readonly description: "Soft-delete one version of a skill so it can no longer be read or downloaded; latest_version_id of the skill falls back to the newest remaining version. Returns {id, type: skill_version_deleted}. A skill can be deleted only after all of its versions are deleted.";
2420
+ readonly description: "Soft-delete one version of a skill so it can no longer be read or downloaded; latest_version_id of the skill falls back to the newest remaining version. Returns {id, type: skill_version_deleted}. A skill keeps at least one version: deleting the last remaining version returns 409 SKILL_LAST_VERSION (delete the skill instead), so latest_version_id is never null. A version that a non-archived agent pins returns 409 RESOURCE_IN_USE naming the agents.";
2362
2421
  readonly http: "DELETE";
2363
2422
  readonly path: "/agent/v1/skills/{skill_id}/versions/{version}";
2364
2423
  readonly streaming: "no";
@@ -2366,9 +2425,11 @@ export declare const operations: readonly [{
2366
2425
  readonly pathParams: readonly [{
2367
2426
  readonly name: "skill_id";
2368
2427
  readonly sdkName: "skill_id";
2428
+ readonly description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.";
2369
2429
  }, {
2370
2430
  readonly name: "version";
2371
2431
  readonly sdkName: "version";
2432
+ readonly description: "Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload.";
2372
2433
  }];
2373
2434
  readonly query: readonly [];
2374
2435
  }, {
@@ -2383,9 +2444,11 @@ export declare const operations: readonly [{
2383
2444
  readonly pathParams: readonly [{
2384
2445
  readonly name: "skill_id";
2385
2446
  readonly sdkName: "skill_id";
2447
+ readonly description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.";
2386
2448
  }, {
2387
2449
  readonly name: "version";
2388
2450
  readonly sdkName: "version";
2451
+ readonly description: "Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload.";
2389
2452
  }];
2390
2453
  readonly query: readonly [];
2391
2454
  }, {
@@ -2400,9 +2463,11 @@ export declare const operations: readonly [{
2400
2463
  readonly pathParams: readonly [{
2401
2464
  readonly name: "skill_id";
2402
2465
  readonly sdkName: "skill_id";
2466
+ readonly description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404.";
2403
2467
  }, {
2404
2468
  readonly name: "version";
2405
2469
  readonly sdkName: "version";
2470
+ readonly description: "Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload.";
2406
2471
  }];
2407
2472
  readonly query: readonly [];
2408
2473
  }, {
@@ -2551,6 +2616,7 @@ export declare const operations: readonly [{
2551
2616
  readonly pathParams: readonly [{
2552
2617
  readonly name: "worker_id";
2553
2618
  readonly sdkName: "worker_id";
2619
+ readonly description: "Worker ID (wkr_…).";
2554
2620
  }];
2555
2621
  readonly query: readonly [];
2556
2622
  }, {
@@ -2565,6 +2631,7 @@ export declare const operations: readonly [{
2565
2631
  readonly pathParams: readonly [{
2566
2632
  readonly name: "worker_id";
2567
2633
  readonly sdkName: "worker_id";
2634
+ readonly description: "Worker ID (wkr_…).";
2568
2635
  }];
2569
2636
  readonly query: readonly [{
2570
2637
  readonly name: "expand";
@@ -2584,6 +2651,7 @@ export declare const operations: readonly [{
2584
2651
  readonly pathParams: readonly [{
2585
2652
  readonly name: "worker_id";
2586
2653
  readonly sdkName: "worker_id";
2654
+ readonly description: "Worker ID (wkr_…).";
2587
2655
  }];
2588
2656
  readonly query: readonly [];
2589
2657
  readonly body: {
@@ -2628,6 +2696,7 @@ export declare const operations: readonly [{
2628
2696
  readonly pathParams: readonly [{
2629
2697
  readonly name: "worker_id";
2630
2698
  readonly sdkName: "worker_id";
2699
+ readonly description: "Worker ID (wkr_…).";
2631
2700
  }];
2632
2701
  readonly query: readonly [];
2633
2702
  readonly body: {
@@ -2651,6 +2720,7 @@ export declare const operations: readonly [{
2651
2720
  readonly pathParams: readonly [{
2652
2721
  readonly name: "worker_id";
2653
2722
  readonly sdkName: "worker_id";
2723
+ readonly description: "Worker ID (wkr_…).";
2654
2724
  }];
2655
2725
  readonly query: readonly [];
2656
2726
  }, {
@@ -2665,6 +2735,7 @@ export declare const operations: readonly [{
2665
2735
  readonly pathParams: readonly [{
2666
2736
  readonly name: "worker_id";
2667
2737
  readonly sdkName: "worker_id";
2738
+ readonly description: "Worker ID (wkr_…).";
2668
2739
  }];
2669
2740
  readonly query: readonly [{
2670
2741
  readonly name: "cursor";
@@ -2689,6 +2760,7 @@ export declare const operations: readonly [{
2689
2760
  readonly pathParams: readonly [{
2690
2761
  readonly name: "worker_id";
2691
2762
  readonly sdkName: "worker_id";
2763
+ readonly description: "Worker ID (wkr_…).";
2692
2764
  }];
2693
2765
  readonly query: readonly [];
2694
2766
  readonly body: {
@@ -2729,9 +2801,11 @@ export declare const operations: readonly [{
2729
2801
  readonly pathParams: readonly [{
2730
2802
  readonly name: "worker_id";
2731
2803
  readonly sdkName: "worker_id";
2804
+ readonly description: "Worker ID (wkr_…).";
2732
2805
  }, {
2733
2806
  readonly name: "deployment_id";
2734
2807
  readonly sdkName: "deployment_id";
2808
+ readonly description: "ID from the id of CreateDeployment or ListDeployments, prefixed dep_.";
2735
2809
  }];
2736
2810
  readonly query: readonly [];
2737
2811
  }, {
@@ -2746,6 +2820,7 @@ export declare const operations: readonly [{
2746
2820
  readonly pathParams: readonly [{
2747
2821
  readonly name: "worker_id";
2748
2822
  readonly sdkName: "worker_id";
2823
+ readonly description: "Worker ID (wkr_…).";
2749
2824
  }];
2750
2825
  readonly query: readonly [{
2751
2826
  readonly name: "after_seq";
@@ -2770,6 +2845,7 @@ export declare const operations: readonly [{
2770
2845
  readonly pathParams: readonly [{
2771
2846
  readonly name: "worker_id";
2772
2847
  readonly sdkName: "worker_id";
2848
+ readonly description: "Worker ID (wkr_…).";
2773
2849
  }];
2774
2850
  readonly query: readonly [];
2775
2851
  }, {
@@ -2784,6 +2860,7 @@ export declare const operations: readonly [{
2784
2860
  readonly pathParams: readonly [{
2785
2861
  readonly name: "worker_id";
2786
2862
  readonly sdkName: "worker_id";
2863
+ readonly description: "Worker ID (wkr_…).";
2787
2864
  }];
2788
2865
  readonly query: readonly [];
2789
2866
  readonly body: {
@@ -2813,9 +2890,11 @@ export declare const operations: readonly [{
2813
2890
  readonly pathParams: readonly [{
2814
2891
  readonly name: "worker_id";
2815
2892
  readonly sdkName: "worker_id";
2893
+ readonly description: "Worker ID (wkr_…).";
2816
2894
  }, {
2817
2895
  readonly name: "grant_id";
2818
2896
  readonly sdkName: "grant_id";
2897
+ readonly description: "Grant ID (grt_…).";
2819
2898
  }];
2820
2899
  readonly query: readonly [];
2821
2900
  }, {
@@ -2830,6 +2909,7 @@ export declare const operations: readonly [{
2830
2909
  readonly pathParams: readonly [{
2831
2910
  readonly name: "worker_id";
2832
2911
  readonly sdkName: "worker_id";
2912
+ readonly description: "Worker ID (wkr_…).";
2833
2913
  }];
2834
2914
  readonly query: readonly [];
2835
2915
  }, {
@@ -2844,6 +2924,7 @@ export declare const operations: readonly [{
2844
2924
  readonly pathParams: readonly [{
2845
2925
  readonly name: "worker_id";
2846
2926
  readonly sdkName: "worker_id";
2927
+ readonly description: "Worker ID (wkr_…).";
2847
2928
  }];
2848
2929
  readonly query: readonly [];
2849
2930
  }, {
@@ -2858,9 +2939,11 @@ export declare const operations: readonly [{
2858
2939
  readonly pathParams: readonly [{
2859
2940
  readonly name: "worker_id";
2860
2941
  readonly sdkName: "worker_id";
2942
+ readonly description: "Worker ID (wkr_…).";
2861
2943
  }, {
2862
2944
  readonly name: "name";
2863
2945
  readonly sdkName: "name";
2946
+ readonly description: "Secret name as seen in the Worker's env: 1–64 letters, digits or underscores, not starting with a digit.";
2864
2947
  }];
2865
2948
  readonly query: readonly [];
2866
2949
  }, {
@@ -2875,9 +2958,11 @@ export declare const operations: readonly [{
2875
2958
  readonly pathParams: readonly [{
2876
2959
  readonly name: "worker_id";
2877
2960
  readonly sdkName: "worker_id";
2961
+ readonly description: "Worker ID (wkr_…).";
2878
2962
  }, {
2879
2963
  readonly name: "name";
2880
2964
  readonly sdkName: "name";
2965
+ readonly description: "Secret name as seen in the Worker's env: 1–64 letters, digits or underscores, not starting with a digit.";
2881
2966
  }];
2882
2967
  readonly query: readonly [];
2883
2968
  readonly body: {
@@ -2901,6 +2986,7 @@ export declare const operations: readonly [{
2901
2986
  readonly pathParams: readonly [{
2902
2987
  readonly name: "worker_id";
2903
2988
  readonly sdkName: "worker_id";
2989
+ readonly description: "Worker ID (wkr_…).";
2904
2990
  }];
2905
2991
  readonly query: readonly [{
2906
2992
  readonly name: "cursor";
@@ -2925,6 +3011,7 @@ export declare const operations: readonly [{
2925
3011
  readonly pathParams: readonly [{
2926
3012
  readonly name: "worker_id";
2927
3013
  readonly sdkName: "worker_id";
3014
+ readonly description: "Worker ID (wkr_…).";
2928
3015
  }];
2929
3016
  readonly query: readonly [];
2930
3017
  readonly body: {
@@ -2991,9 +3078,11 @@ export declare const operations: readonly [{
2991
3078
  readonly pathParams: readonly [{
2992
3079
  readonly name: "worker_id";
2993
3080
  readonly sdkName: "worker_id";
3081
+ readonly description: "Worker ID (wkr_…).";
2994
3082
  }, {
2995
3083
  readonly name: "version_id";
2996
3084
  readonly sdkName: "version_id";
3085
+ readonly description: "Version ID (ver_…).";
2997
3086
  }];
2998
3087
  readonly query: readonly [];
2999
3088
  }, {
@@ -3008,9 +3097,11 @@ export declare const operations: readonly [{
3008
3097
  readonly pathParams: readonly [{
3009
3098
  readonly name: "worker_id";
3010
3099
  readonly sdkName: "worker_id";
3100
+ readonly description: "Worker ID (wkr_…).";
3011
3101
  }, {
3012
3102
  readonly name: "version_id";
3013
3103
  readonly sdkName: "version_id";
3104
+ readonly description: "Version ID from versions.list or the active deployment.";
3014
3105
  }];
3015
3106
  readonly query: readonly [];
3016
3107
  }, {
@@ -3162,9 +3253,11 @@ export declare const operations: readonly [{
3162
3253
  readonly pathParams: readonly [{
3163
3254
  readonly name: "ns";
3164
3255
  readonly sdkName: "ns";
3256
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
3165
3257
  }, {
3166
3258
  readonly name: "name";
3167
3259
  readonly sdkName: "name";
3260
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
3168
3261
  }];
3169
3262
  readonly query: readonly [];
3170
3263
  }, {
@@ -3179,9 +3272,11 @@ export declare const operations: readonly [{
3179
3272
  readonly pathParams: readonly [{
3180
3273
  readonly name: "ns";
3181
3274
  readonly sdkName: "ns";
3275
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
3182
3276
  }, {
3183
3277
  readonly name: "name";
3184
3278
  readonly sdkName: "name";
3279
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
3185
3280
  }];
3186
3281
  readonly query: readonly [{
3187
3282
  readonly name: "dry_run";
@@ -3251,9 +3346,11 @@ export declare const operations: readonly [{
3251
3346
  readonly pathParams: readonly [{
3252
3347
  readonly name: "ns";
3253
3348
  readonly sdkName: "ns";
3349
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
3254
3350
  }, {
3255
3351
  readonly name: "name";
3256
3352
  readonly sdkName: "name";
3353
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
3257
3354
  }];
3258
3355
  readonly query: readonly [];
3259
3356
  readonly body: {
@@ -3272,9 +3369,11 @@ export declare const operations: readonly [{
3272
3369
  readonly pathParams: readonly [{
3273
3370
  readonly name: "ns";
3274
3371
  readonly sdkName: "ns";
3372
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
3275
3373
  }, {
3276
3374
  readonly name: "name";
3277
3375
  readonly sdkName: "name";
3376
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
3278
3377
  }];
3279
3378
  readonly query: readonly [{
3280
3379
  readonly name: "limit";
@@ -3299,9 +3398,11 @@ export declare const operations: readonly [{
3299
3398
  readonly pathParams: readonly [{
3300
3399
  readonly name: "ns";
3301
3400
  readonly sdkName: "ns";
3401
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
3302
3402
  }, {
3303
3403
  readonly name: "name";
3304
3404
  readonly sdkName: "name";
3405
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
3305
3406
  }];
3306
3407
  readonly query: readonly [{
3307
3408
  readonly name: "limit";
@@ -3354,9 +3455,11 @@ export declare const operations: readonly [{
3354
3455
  readonly pathParams: readonly [{
3355
3456
  readonly name: "ns";
3356
3457
  readonly sdkName: "ns";
3458
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
3357
3459
  }, {
3358
3460
  readonly name: "name";
3359
3461
  readonly sdkName: "name";
3462
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
3360
3463
  }];
3361
3464
  readonly query: readonly [];
3362
3465
  readonly body: {
@@ -3375,9 +3478,11 @@ export declare const operations: readonly [{
3375
3478
  readonly pathParams: readonly [{
3376
3479
  readonly name: "ns";
3377
3480
  readonly sdkName: "ns";
3481
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
3378
3482
  }, {
3379
3483
  readonly name: "name";
3380
3484
  readonly sdkName: "name";
3485
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
3381
3486
  }];
3382
3487
  readonly query: readonly [{
3383
3488
  readonly name: "limit";
@@ -3408,12 +3513,15 @@ export declare const operations: readonly [{
3408
3513
  readonly pathParams: readonly [{
3409
3514
  readonly name: "ns";
3410
3515
  readonly sdkName: "ns";
3516
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
3411
3517
  }, {
3412
3518
  readonly name: "name";
3413
3519
  readonly sdkName: "name";
3520
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
3414
3521
  }, {
3415
3522
  readonly name: "revision";
3416
3523
  readonly sdkName: "revision";
3524
+ readonly description: "Action revision ID (actr_); the query parameter filters invocation records.";
3417
3525
  }];
3418
3526
  readonly query: readonly [];
3419
3527
  }, {
@@ -3428,9 +3536,11 @@ export declare const operations: readonly [{
3428
3536
  readonly pathParams: readonly [{
3429
3537
  readonly name: "ns";
3430
3538
  readonly sdkName: "ns";
3539
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
3431
3540
  }, {
3432
3541
  readonly name: "name";
3433
3542
  readonly sdkName: "name";
3543
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
3434
3544
  }];
3435
3545
  readonly query: readonly [];
3436
3546
  readonly body: {
@@ -3459,9 +3569,11 @@ export declare const operations: readonly [{
3459
3569
  readonly pathParams: readonly [{
3460
3570
  readonly name: "trigger_id";
3461
3571
  readonly sdkName: "trigger_id";
3572
+ readonly description: "Trigger ID (trg_).";
3462
3573
  }, {
3463
3574
  readonly name: "token";
3464
3575
  readonly sdkName: "token";
3576
+ readonly description: "Secret URL token returned on creation or rotation; do not disclose it.";
3465
3577
  }];
3466
3578
  readonly query: readonly [];
3467
3579
  readonly body: {
@@ -3622,6 +3734,7 @@ export declare const operations: readonly [{
3622
3734
  readonly pathParams: readonly [{
3623
3735
  readonly name: "id";
3624
3736
  readonly sdkName: "id";
3737
+ readonly description: "Run ID (run_).";
3625
3738
  }];
3626
3739
  readonly query: readonly [{
3627
3740
  readonly name: "expand";
@@ -3648,6 +3761,7 @@ export declare const operations: readonly [{
3648
3761
  readonly pathParams: readonly [{
3649
3762
  readonly name: "id";
3650
3763
  readonly sdkName: "id";
3764
+ readonly description: "Run ID (run_).";
3651
3765
  }];
3652
3766
  readonly query: readonly [{
3653
3767
  readonly name: "limit";
@@ -3672,6 +3786,7 @@ export declare const operations: readonly [{
3672
3786
  readonly pathParams: readonly [{
3673
3787
  readonly name: "id";
3674
3788
  readonly sdkName: "id";
3789
+ readonly description: "Run ID (run_).";
3675
3790
  }];
3676
3791
  readonly query: readonly [{
3677
3792
  readonly name: "limit";
@@ -3696,6 +3811,7 @@ export declare const operations: readonly [{
3696
3811
  readonly pathParams: readonly [{
3697
3812
  readonly name: "id";
3698
3813
  readonly sdkName: "id";
3814
+ readonly description: "Run ID (run_).";
3699
3815
  }];
3700
3816
  readonly query: readonly [];
3701
3817
  readonly body: {
@@ -3719,6 +3835,7 @@ export declare const operations: readonly [{
3719
3835
  readonly pathParams: readonly [{
3720
3836
  readonly name: "id";
3721
3837
  readonly sdkName: "id";
3838
+ readonly description: "Run ID (run_).";
3722
3839
  }];
3723
3840
  readonly query: readonly [{
3724
3841
  readonly name: "limit";
@@ -3743,6 +3860,7 @@ export declare const operations: readonly [{
3743
3860
  readonly pathParams: readonly [{
3744
3861
  readonly name: "id";
3745
3862
  readonly sdkName: "id";
3863
+ readonly description: "Run ID (run_).";
3746
3864
  }];
3747
3865
  readonly query: readonly [{
3748
3866
  readonly name: "limit";
@@ -3767,6 +3885,7 @@ export declare const operations: readonly [{
3767
3885
  readonly pathParams: readonly [{
3768
3886
  readonly name: "id";
3769
3887
  readonly sdkName: "id";
3888
+ readonly description: "Run ID (run_).";
3770
3889
  }];
3771
3890
  readonly query: readonly [];
3772
3891
  readonly body: {
@@ -3790,6 +3909,7 @@ export declare const operations: readonly [{
3790
3909
  readonly pathParams: readonly [{
3791
3910
  readonly name: "id";
3792
3911
  readonly sdkName: "id";
3912
+ readonly description: "Run ID (run_).";
3793
3913
  }];
3794
3914
  readonly query: readonly [];
3795
3915
  readonly body: {
@@ -3808,6 +3928,7 @@ export declare const operations: readonly [{
3808
3928
  readonly pathParams: readonly [{
3809
3929
  readonly name: "id";
3810
3930
  readonly sdkName: "id";
3931
+ readonly description: "Run ID (run_).";
3811
3932
  }];
3812
3933
  readonly query: readonly [];
3813
3934
  }, {
@@ -3822,6 +3943,7 @@ export declare const operations: readonly [{
3822
3943
  readonly pathParams: readonly [{
3823
3944
  readonly name: "id";
3824
3945
  readonly sdkName: "id";
3946
+ readonly description: "Run ID (run_).";
3825
3947
  }];
3826
3948
  readonly query: readonly [];
3827
3949
  readonly body: {
@@ -3840,6 +3962,7 @@ export declare const operations: readonly [{
3840
3962
  readonly pathParams: readonly [{
3841
3963
  readonly name: "id";
3842
3964
  readonly sdkName: "id";
3965
+ readonly description: "Run ID (run_).";
3843
3966
  }];
3844
3967
  readonly query: readonly [{
3845
3968
  readonly name: "limit";
@@ -3876,6 +3999,7 @@ export declare const operations: readonly [{
3876
3999
  readonly pathParams: readonly [{
3877
4000
  readonly name: "id";
3878
4001
  readonly sdkName: "id";
4002
+ readonly description: "Run ID (run_).";
3879
4003
  }];
3880
4004
  readonly query: readonly [{
3881
4005
  readonly name: "limit";
@@ -3900,9 +4024,11 @@ export declare const operations: readonly [{
3900
4024
  readonly pathParams: readonly [{
3901
4025
  readonly name: "id";
3902
4026
  readonly sdkName: "id";
4027
+ readonly description: "Run ID (run_).";
3903
4028
  }, {
3904
4029
  readonly name: "wait_id";
3905
4030
  readonly sdkName: "wait_id";
4031
+ readonly description: "Wait ID (wait_) belonging to this run.";
3906
4032
  }];
3907
4033
  readonly query: readonly [];
3908
4034
  readonly body: {
@@ -4030,9 +4156,11 @@ export declare const operations: readonly [{
4030
4156
  readonly pathParams: readonly [{
4031
4157
  readonly name: "ns";
4032
4158
  readonly sdkName: "ns";
4159
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4033
4160
  }, {
4034
4161
  readonly name: "name";
4035
4162
  readonly sdkName: "name";
4163
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4036
4164
  }];
4037
4165
  readonly query: readonly [];
4038
4166
  }, {
@@ -4047,9 +4175,11 @@ export declare const operations: readonly [{
4047
4175
  readonly pathParams: readonly [{
4048
4176
  readonly name: "ns";
4049
4177
  readonly sdkName: "ns";
4178
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4050
4179
  }, {
4051
4180
  readonly name: "name";
4052
4181
  readonly sdkName: "name";
4182
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4053
4183
  }];
4054
4184
  readonly query: readonly [];
4055
4185
  readonly body: {
@@ -4083,9 +4213,11 @@ export declare const operations: readonly [{
4083
4213
  readonly pathParams: readonly [{
4084
4214
  readonly name: "ns";
4085
4215
  readonly sdkName: "ns";
4216
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4086
4217
  }, {
4087
4218
  readonly name: "name";
4088
4219
  readonly sdkName: "name";
4220
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4089
4221
  }];
4090
4222
  readonly query: readonly [];
4091
4223
  readonly body: {
@@ -4104,9 +4236,11 @@ export declare const operations: readonly [{
4104
4236
  readonly pathParams: readonly [{
4105
4237
  readonly name: "ns";
4106
4238
  readonly sdkName: "ns";
4239
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4107
4240
  }, {
4108
4241
  readonly name: "name";
4109
4242
  readonly sdkName: "name";
4243
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4110
4244
  }];
4111
4245
  readonly query: readonly [];
4112
4246
  }, {
@@ -4121,12 +4255,15 @@ export declare const operations: readonly [{
4121
4255
  readonly pathParams: readonly [{
4122
4256
  readonly name: "ns";
4123
4257
  readonly sdkName: "ns";
4258
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4124
4259
  }, {
4125
4260
  readonly name: "name";
4126
4261
  readonly sdkName: "name";
4262
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4127
4263
  }, {
4128
4264
  readonly name: "tag";
4129
4265
  readonly sdkName: "tag";
4266
+ readonly description: "Distribution tag. A prerelease (such as 1.3.0-beta.1) requires a tag and it cannot be latest; a tag may only use URL-safe characters (letters, digits and - _ . ! ~ * ' ( )), no spaces or / ? # and no leading or trailing whitespace; it cannot be a version or a version range (such as 1.2.3, ^1, 1.x, *); any other name such as beta, next or debug is allowed. Violations return TAG_INVALID or TAG_REQUIRED with the complete rules in hint.";
4130
4267
  }];
4131
4268
  readonly query: readonly [];
4132
4269
  }, {
@@ -4141,12 +4278,15 @@ export declare const operations: readonly [{
4141
4278
  readonly pathParams: readonly [{
4142
4279
  readonly name: "ns";
4143
4280
  readonly sdkName: "ns";
4281
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4144
4282
  }, {
4145
4283
  readonly name: "name";
4146
4284
  readonly sdkName: "name";
4285
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4147
4286
  }, {
4148
4287
  readonly name: "tag";
4149
4288
  readonly sdkName: "tag";
4289
+ readonly description: "Distribution tag. A prerelease (such as 1.3.0-beta.1) requires a tag and it cannot be latest; a tag may only use URL-safe characters (letters, digits and - _ . ! ~ * ' ( )), no spaces or / ? # and no leading or trailing whitespace; it cannot be a version or a version range (such as 1.2.3, ^1, 1.x, *); any other name such as beta, next or debug is allowed. Violations return TAG_INVALID or TAG_REQUIRED with the complete rules in hint.";
4150
4290
  }];
4151
4291
  readonly query: readonly [];
4152
4292
  readonly body: {
@@ -4170,9 +4310,11 @@ export declare const operations: readonly [{
4170
4310
  readonly pathParams: readonly [{
4171
4311
  readonly name: "ns";
4172
4312
  readonly sdkName: "ns";
4313
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4173
4314
  }, {
4174
4315
  readonly name: "name";
4175
4316
  readonly sdkName: "name";
4317
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4176
4318
  }];
4177
4319
  readonly query: readonly [];
4178
4320
  readonly body: {
@@ -4191,9 +4333,11 @@ export declare const operations: readonly [{
4191
4333
  readonly pathParams: readonly [{
4192
4334
  readonly name: "ns";
4193
4335
  readonly sdkName: "ns";
4336
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4194
4337
  }, {
4195
4338
  readonly name: "name";
4196
4339
  readonly sdkName: "name";
4340
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4197
4341
  }];
4198
4342
  readonly query: readonly [{
4199
4343
  readonly name: "limit";
@@ -4225,9 +4369,11 @@ export declare const operations: readonly [{
4225
4369
  readonly pathParams: readonly [{
4226
4370
  readonly name: "ns";
4227
4371
  readonly sdkName: "ns";
4372
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4228
4373
  }, {
4229
4374
  readonly name: "name";
4230
4375
  readonly sdkName: "name";
4376
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4231
4377
  }];
4232
4378
  readonly query: readonly [];
4233
4379
  readonly body: {
@@ -4246,12 +4392,15 @@ export declare const operations: readonly [{
4246
4392
  readonly pathParams: readonly [{
4247
4393
  readonly name: "ns";
4248
4394
  readonly sdkName: "ns";
4395
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4249
4396
  }, {
4250
4397
  readonly name: "name";
4251
4398
  readonly sdkName: "name";
4399
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4252
4400
  }, {
4253
4401
  readonly name: "version";
4254
4402
  readonly sdkName: "version";
4403
+ readonly description: "Exact version or dist-tag; ranges are rejected with 400 and a hint.";
4255
4404
  }];
4256
4405
  readonly query: readonly [];
4257
4406
  }, {
@@ -4266,12 +4415,15 @@ export declare const operations: readonly [{
4266
4415
  readonly pathParams: readonly [{
4267
4416
  readonly name: "ns";
4268
4417
  readonly sdkName: "ns";
4418
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4269
4419
  }, {
4270
4420
  readonly name: "name";
4271
4421
  readonly sdkName: "name";
4422
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4272
4423
  }, {
4273
4424
  readonly name: "version";
4274
4425
  readonly sdkName: "version";
4426
+ readonly description: "An exact canonical semantic version, such as 1.2.0 or 1.3.0-beta.1, not a range.";
4275
4427
  }];
4276
4428
  readonly query: readonly [];
4277
4429
  readonly body: {
@@ -4516,6 +4668,7 @@ export declare const operations: readonly [{
4516
4668
  readonly pathParams: readonly [{
4517
4669
  readonly name: "id";
4518
4670
  readonly sdkName: "id";
4671
+ readonly description: "Trigger ID (trg_).";
4519
4672
  }];
4520
4673
  readonly query: readonly [];
4521
4674
  }, {
@@ -4530,6 +4683,7 @@ export declare const operations: readonly [{
4530
4683
  readonly pathParams: readonly [{
4531
4684
  readonly name: "id";
4532
4685
  readonly sdkName: "id";
4686
+ readonly description: "Trigger ID (trg_).";
4533
4687
  }];
4534
4688
  readonly query: readonly [];
4535
4689
  }, {
@@ -4544,6 +4698,7 @@ export declare const operations: readonly [{
4544
4698
  readonly pathParams: readonly [{
4545
4699
  readonly name: "id";
4546
4700
  readonly sdkName: "id";
4701
+ readonly description: "Trigger ID (trg_).";
4547
4702
  }];
4548
4703
  readonly query: readonly [];
4549
4704
  readonly body: {
@@ -4629,6 +4784,7 @@ export declare const operations: readonly [{
4629
4784
  readonly pathParams: readonly [{
4630
4785
  readonly name: "id";
4631
4786
  readonly sdkName: "id";
4787
+ readonly description: "Trigger ID (trg_).";
4632
4788
  }];
4633
4789
  readonly query: readonly [];
4634
4790
  }, {
@@ -4643,6 +4799,7 @@ export declare const operations: readonly [{
4643
4799
  readonly pathParams: readonly [{
4644
4800
  readonly name: "id";
4645
4801
  readonly sdkName: "id";
4802
+ readonly description: "Trigger ID (trg_).";
4646
4803
  }];
4647
4804
  readonly query: readonly [{
4648
4805
  readonly name: "limit";
@@ -4679,6 +4836,7 @@ export declare const operations: readonly [{
4679
4836
  readonly pathParams: readonly [{
4680
4837
  readonly name: "id";
4681
4838
  readonly sdkName: "id";
4839
+ readonly description: "Trigger ID (trg_).";
4682
4840
  }];
4683
4841
  readonly query: readonly [];
4684
4842
  }, {
@@ -4693,6 +4851,7 @@ export declare const operations: readonly [{
4693
4851
  readonly pathParams: readonly [{
4694
4852
  readonly name: "id";
4695
4853
  readonly sdkName: "id";
4854
+ readonly description: "Trigger ID (trg_).";
4696
4855
  }];
4697
4856
  readonly query: readonly [];
4698
4857
  }, {
@@ -4707,6 +4866,7 @@ export declare const operations: readonly [{
4707
4866
  readonly pathParams: readonly [{
4708
4867
  readonly name: "id";
4709
4868
  readonly sdkName: "id";
4869
+ readonly description: "Trigger ID (trg_).";
4710
4870
  }];
4711
4871
  readonly query: readonly [];
4712
4872
  }, {
@@ -4846,9 +5006,11 @@ export declare const operations: readonly [{
4846
5006
  readonly pathParams: readonly [{
4847
5007
  readonly name: "ns";
4848
5008
  readonly sdkName: "ns";
5009
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4849
5010
  }, {
4850
5011
  readonly name: "name";
4851
5012
  readonly sdkName: "name";
5013
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4852
5014
  }];
4853
5015
  readonly query: readonly [];
4854
5016
  }, {
@@ -4863,9 +5025,11 @@ export declare const operations: readonly [{
4863
5025
  readonly pathParams: readonly [{
4864
5026
  readonly name: "ns";
4865
5027
  readonly sdkName: "ns";
5028
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4866
5029
  }, {
4867
5030
  readonly name: "name";
4868
5031
  readonly sdkName: "name";
5032
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4869
5033
  }];
4870
5034
  readonly query: readonly [];
4871
5035
  readonly body: {
@@ -4899,9 +5063,11 @@ export declare const operations: readonly [{
4899
5063
  readonly pathParams: readonly [{
4900
5064
  readonly name: "ns";
4901
5065
  readonly sdkName: "ns";
5066
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4902
5067
  }, {
4903
5068
  readonly name: "name";
4904
5069
  readonly sdkName: "name";
5070
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4905
5071
  }];
4906
5072
  readonly query: readonly [];
4907
5073
  readonly body: {
@@ -4920,9 +5086,11 @@ export declare const operations: readonly [{
4920
5086
  readonly pathParams: readonly [{
4921
5087
  readonly name: "ns";
4922
5088
  readonly sdkName: "ns";
5089
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4923
5090
  }, {
4924
5091
  readonly name: "name";
4925
5092
  readonly sdkName: "name";
5093
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4926
5094
  }];
4927
5095
  readonly query: readonly [];
4928
5096
  }, {
@@ -4937,12 +5105,15 @@ export declare const operations: readonly [{
4937
5105
  readonly pathParams: readonly [{
4938
5106
  readonly name: "ns";
4939
5107
  readonly sdkName: "ns";
5108
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4940
5109
  }, {
4941
5110
  readonly name: "name";
4942
5111
  readonly sdkName: "name";
5112
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4943
5113
  }, {
4944
5114
  readonly name: "tag";
4945
5115
  readonly sdkName: "tag";
5116
+ readonly description: "Distribution tag. A prerelease (such as 1.3.0-beta.1) requires a tag and it cannot be latest; a tag may only use URL-safe characters (letters, digits and - _ . ! ~ * ' ( )), no spaces or / ? # and no leading or trailing whitespace; it cannot be a version or a version range (such as 1.2.3, ^1, 1.x, *); any other name such as beta, next or debug is allowed. Violations return TAG_INVALID or TAG_REQUIRED with the complete rules in hint.";
4946
5117
  }];
4947
5118
  readonly query: readonly [];
4948
5119
  }, {
@@ -4957,12 +5128,15 @@ export declare const operations: readonly [{
4957
5128
  readonly pathParams: readonly [{
4958
5129
  readonly name: "ns";
4959
5130
  readonly sdkName: "ns";
5131
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4960
5132
  }, {
4961
5133
  readonly name: "name";
4962
5134
  readonly sdkName: "name";
5135
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4963
5136
  }, {
4964
5137
  readonly name: "tag";
4965
5138
  readonly sdkName: "tag";
5139
+ readonly description: "Distribution tag. A prerelease (such as 1.3.0-beta.1) requires a tag and it cannot be latest; a tag may only use URL-safe characters (letters, digits and - _ . ! ~ * ' ( )), no spaces or / ? # and no leading or trailing whitespace; it cannot be a version or a version range (such as 1.2.3, ^1, 1.x, *); any other name such as beta, next or debug is allowed. Violations return TAG_INVALID or TAG_REQUIRED with the complete rules in hint.";
4966
5140
  }];
4967
5141
  readonly query: readonly [];
4968
5142
  readonly body: {
@@ -4986,9 +5160,11 @@ export declare const operations: readonly [{
4986
5160
  readonly pathParams: readonly [{
4987
5161
  readonly name: "ns";
4988
5162
  readonly sdkName: "ns";
5163
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
4989
5164
  }, {
4990
5165
  readonly name: "name";
4991
5166
  readonly sdkName: "name";
5167
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
4992
5168
  }];
4993
5169
  readonly query: readonly [];
4994
5170
  readonly body: {
@@ -5007,9 +5183,11 @@ export declare const operations: readonly [{
5007
5183
  readonly pathParams: readonly [{
5008
5184
  readonly name: "ns";
5009
5185
  readonly sdkName: "ns";
5186
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
5010
5187
  }, {
5011
5188
  readonly name: "name";
5012
5189
  readonly sdkName: "name";
5190
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
5013
5191
  }];
5014
5192
  readonly query: readonly [{
5015
5193
  readonly name: "limit";
@@ -5041,9 +5219,11 @@ export declare const operations: readonly [{
5041
5219
  readonly pathParams: readonly [{
5042
5220
  readonly name: "ns";
5043
5221
  readonly sdkName: "ns";
5222
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
5044
5223
  }, {
5045
5224
  readonly name: "name";
5046
5225
  readonly sdkName: "name";
5226
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
5047
5227
  }];
5048
5228
  readonly query: readonly [];
5049
5229
  readonly body: {
@@ -5062,12 +5242,15 @@ export declare const operations: readonly [{
5062
5242
  readonly pathParams: readonly [{
5063
5243
  readonly name: "ns";
5064
5244
  readonly sdkName: "ns";
5245
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
5065
5246
  }, {
5066
5247
  readonly name: "name";
5067
5248
  readonly sdkName: "name";
5249
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
5068
5250
  }, {
5069
5251
  readonly name: "version";
5070
5252
  readonly sdkName: "version";
5253
+ readonly description: "Exact version or dist-tag; ranges are rejected with 400 and a hint.";
5071
5254
  }];
5072
5255
  readonly query: readonly [];
5073
5256
  }, {
@@ -5082,12 +5265,15 @@ export declare const operations: readonly [{
5082
5265
  readonly pathParams: readonly [{
5083
5266
  readonly name: "ns";
5084
5267
  readonly sdkName: "ns";
5268
+ readonly description: "Namespace, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}. praxis is reserved for built-in Actions.";
5085
5269
  }, {
5086
5270
  readonly name: "name";
5087
5271
  readonly sdkName: "name";
5272
+ readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9._-]{0,63} for existing references, including historical dotted names; new names must match [a-z0-9][a-z0-9_-]{0,63}.";
5088
5273
  }, {
5089
5274
  readonly name: "version";
5090
5275
  readonly sdkName: "version";
5276
+ readonly description: "An exact canonical semantic version, such as 1.2.0 or 1.3.0-beta.1, not a range.";
5091
5277
  }];
5092
5278
  readonly query: readonly [];
5093
5279
  readonly body: {
@@ -5218,6 +5404,7 @@ export declare const operations: readonly [{
5218
5404
  readonly pathParams: readonly [{
5219
5405
  readonly name: "contextId";
5220
5406
  readonly sdkName: "contextId";
5407
+ readonly description: "登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。";
5221
5408
  }];
5222
5409
  readonly query: readonly [];
5223
5410
  }, {
@@ -5232,6 +5419,7 @@ export declare const operations: readonly [{
5232
5419
  readonly pathParams: readonly [{
5233
5420
  readonly name: "contextId";
5234
5421
  readonly sdkName: "contextId";
5422
+ readonly description: "登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。";
5235
5423
  }];
5236
5424
  readonly query: readonly [];
5237
5425
  }, {
@@ -5246,6 +5434,7 @@ export declare const operations: readonly [{
5246
5434
  readonly pathParams: readonly [{
5247
5435
  readonly name: "contextId";
5248
5436
  readonly sdkName: "contextId";
5437
+ readonly description: "登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。";
5249
5438
  }];
5250
5439
  readonly query: readonly [];
5251
5440
  readonly body: {
@@ -5274,9 +5463,11 @@ export declare const operations: readonly [{
5274
5463
  readonly pathParams: readonly [{
5275
5464
  readonly name: "sessionId";
5276
5465
  readonly sdkName: "sessionId";
5466
+ readonly description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。";
5277
5467
  }, {
5278
5468
  readonly name: "pageId";
5279
5469
  readonly sdkName: "pageId";
5470
+ readonly description: "实时观看地址中的标签页 ID;使用 debug 返回链接中的原值,_ 表示会话级画面。";
5280
5471
  }];
5281
5472
  readonly query: readonly [{
5282
5473
  readonly name: "t";
@@ -5414,6 +5605,7 @@ export declare const operations: readonly [{
5414
5605
  readonly pathParams: readonly [{
5415
5606
  readonly name: "sessionId";
5416
5607
  readonly sdkName: "sessionId";
5608
+ readonly description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。";
5417
5609
  }];
5418
5610
  readonly query: readonly [{
5419
5611
  readonly name: "expand";
@@ -5433,6 +5625,7 @@ export declare const operations: readonly [{
5433
5625
  readonly pathParams: readonly [{
5434
5626
  readonly name: "sessionId";
5435
5627
  readonly sdkName: "sessionId";
5628
+ readonly description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。";
5436
5629
  }];
5437
5630
  readonly query: readonly [];
5438
5631
  readonly body: {
@@ -5457,6 +5650,7 @@ export declare const operations: readonly [{
5457
5650
  readonly pathParams: readonly [{
5458
5651
  readonly name: "sessionId";
5459
5652
  readonly sdkName: "sessionId";
5653
+ readonly description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。";
5460
5654
  }];
5461
5655
  readonly query: readonly [];
5462
5656
  }, {
@@ -5471,6 +5665,7 @@ export declare const operations: readonly [{
5471
5665
  readonly pathParams: readonly [{
5472
5666
  readonly name: "sessionId";
5473
5667
  readonly sdkName: "sessionId";
5668
+ readonly description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。";
5474
5669
  }];
5475
5670
  readonly query: readonly [{
5476
5671
  readonly name: "cursor";
@@ -5500,6 +5695,7 @@ export declare const operations: readonly [{
5500
5695
  readonly pathParams: readonly [{
5501
5696
  readonly name: "sessionId";
5502
5697
  readonly sdkName: "sessionId";
5698
+ readonly description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。";
5503
5699
  }];
5504
5700
  readonly query: readonly [];
5505
5701
  readonly body: {
@@ -5528,6 +5724,7 @@ export declare const operations: readonly [{
5528
5724
  readonly pathParams: readonly [{
5529
5725
  readonly name: "sessionId";
5530
5726
  readonly sdkName: "sessionId";
5727
+ readonly description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。";
5531
5728
  }];
5532
5729
  readonly query: readonly [];
5533
5730
  }, {
@@ -5542,6 +5739,7 @@ export declare const operations: readonly [{
5542
5739
  readonly pathParams: readonly [{
5543
5740
  readonly name: "sessionId";
5544
5741
  readonly sdkName: "sessionId";
5742
+ readonly description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。";
5545
5743
  }];
5546
5744
  readonly query: readonly [];
5547
5745
  }, {
@@ -5556,6 +5754,7 @@ export declare const operations: readonly [{
5556
5754
  readonly pathParams: readonly [{
5557
5755
  readonly name: "sessionId";
5558
5756
  readonly sdkName: "sessionId";
5757
+ readonly description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。";
5559
5758
  }];
5560
5759
  readonly query: readonly [];
5561
5760
  readonly body: {
@@ -5636,6 +5835,7 @@ export declare const operations: readonly [{
5636
5835
  readonly pathParams: readonly [{
5637
5836
  readonly name: "database_id";
5638
5837
  readonly sdkName: "database_id";
5838
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
5639
5839
  }];
5640
5840
  readonly query: readonly [];
5641
5841
  }, {
@@ -5650,6 +5850,7 @@ export declare const operations: readonly [{
5650
5850
  readonly pathParams: readonly [{
5651
5851
  readonly name: "database_id";
5652
5852
  readonly sdkName: "database_id";
5853
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
5653
5854
  }];
5654
5855
  readonly query: readonly [];
5655
5856
  }, {
@@ -5664,6 +5865,7 @@ export declare const operations: readonly [{
5664
5865
  readonly pathParams: readonly [{
5665
5866
  readonly name: "database_id";
5666
5867
  readonly sdkName: "database_id";
5868
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
5667
5869
  }];
5668
5870
  readonly query: readonly [];
5669
5871
  readonly body: {
@@ -5692,6 +5894,7 @@ export declare const operations: readonly [{
5692
5894
  readonly pathParams: readonly [{
5693
5895
  readonly name: "database_id";
5694
5896
  readonly sdkName: "database_id";
5897
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
5695
5898
  }];
5696
5899
  readonly query: readonly [{
5697
5900
  readonly name: "after_seq";
@@ -5727,6 +5930,7 @@ export declare const operations: readonly [{
5727
5930
  readonly pathParams: readonly [{
5728
5931
  readonly name: "database_id";
5729
5932
  readonly sdkName: "database_id";
5933
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
5730
5934
  }];
5731
5935
  readonly query: readonly [];
5732
5936
  }, {
@@ -5741,9 +5945,11 @@ export declare const operations: readonly [{
5741
5945
  readonly pathParams: readonly [{
5742
5946
  readonly name: "database_id";
5743
5947
  readonly sdkName: "database_id";
5948
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
5744
5949
  }, {
5745
5950
  readonly name: "table";
5746
5951
  readonly sdkName: "table";
5952
+ readonly description: "table ID or name.";
5747
5953
  }];
5748
5954
  readonly query: readonly [{
5749
5955
  readonly name: "select";
@@ -5813,9 +6019,11 @@ export declare const operations: readonly [{
5813
6019
  readonly pathParams: readonly [{
5814
6020
  readonly name: "database_id";
5815
6021
  readonly sdkName: "database_id";
6022
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
5816
6023
  }, {
5817
6024
  readonly name: "table";
5818
6025
  readonly sdkName: "table";
6026
+ readonly description: "table ID or name.";
5819
6027
  }];
5820
6028
  readonly query: readonly [{
5821
6029
  readonly name: "select";
@@ -5885,9 +6093,11 @@ export declare const operations: readonly [{
5885
6093
  readonly pathParams: readonly [{
5886
6094
  readonly name: "database_id";
5887
6095
  readonly sdkName: "database_id";
6096
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
5888
6097
  }, {
5889
6098
  readonly name: "table";
5890
6099
  readonly sdkName: "table";
6100
+ readonly description: "table ID or name.";
5891
6101
  }];
5892
6102
  readonly query: readonly [{
5893
6103
  readonly name: "select";
@@ -5957,9 +6167,11 @@ export declare const operations: readonly [{
5957
6167
  readonly pathParams: readonly [{
5958
6168
  readonly name: "database_id";
5959
6169
  readonly sdkName: "database_id";
6170
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
5960
6171
  }, {
5961
6172
  readonly name: "table";
5962
6173
  readonly sdkName: "table";
6174
+ readonly description: "table ID or name.";
5963
6175
  }];
5964
6176
  readonly query: readonly [{
5965
6177
  readonly name: "select";
@@ -6033,9 +6245,11 @@ export declare const operations: readonly [{
6033
6245
  readonly pathParams: readonly [{
6034
6246
  readonly name: "database_id";
6035
6247
  readonly sdkName: "database_id";
6248
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6036
6249
  }, {
6037
6250
  readonly name: "table";
6038
6251
  readonly sdkName: "table";
6252
+ readonly description: "table ID or name.";
6039
6253
  }];
6040
6254
  readonly query: readonly [{
6041
6255
  readonly name: "select";
@@ -6109,6 +6323,7 @@ export declare const operations: readonly [{
6109
6323
  readonly pathParams: readonly [{
6110
6324
  readonly name: "database_id";
6111
6325
  readonly sdkName: "database_id";
6326
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6112
6327
  }];
6113
6328
  readonly query: readonly [];
6114
6329
  }, {
@@ -6123,6 +6338,7 @@ export declare const operations: readonly [{
6123
6338
  readonly pathParams: readonly [{
6124
6339
  readonly name: "database_id";
6125
6340
  readonly sdkName: "database_id";
6341
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6126
6342
  }];
6127
6343
  readonly query: readonly [];
6128
6344
  }, {
@@ -6137,6 +6353,7 @@ export declare const operations: readonly [{
6137
6353
  readonly pathParams: readonly [{
6138
6354
  readonly name: "database_id";
6139
6355
  readonly sdkName: "database_id";
6356
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6140
6357
  }];
6141
6358
  readonly query: readonly [];
6142
6359
  readonly body: {
@@ -6171,9 +6388,11 @@ export declare const operations: readonly [{
6171
6388
  readonly pathParams: readonly [{
6172
6389
  readonly name: "database_id";
6173
6390
  readonly sdkName: "database_id";
6391
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6174
6392
  }, {
6175
6393
  readonly name: "table";
6176
6394
  readonly sdkName: "table";
6395
+ readonly description: "table ID or name.";
6177
6396
  }];
6178
6397
  readonly query: readonly [];
6179
6398
  }, {
@@ -6188,9 +6407,11 @@ export declare const operations: readonly [{
6188
6407
  readonly pathParams: readonly [{
6189
6408
  readonly name: "database_id";
6190
6409
  readonly sdkName: "database_id";
6410
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6191
6411
  }, {
6192
6412
  readonly name: "table";
6193
6413
  readonly sdkName: "table";
6414
+ readonly description: "table ID or name.";
6194
6415
  }];
6195
6416
  readonly query: readonly [];
6196
6417
  }, {
@@ -6205,9 +6426,11 @@ export declare const operations: readonly [{
6205
6426
  readonly pathParams: readonly [{
6206
6427
  readonly name: "database_id";
6207
6428
  readonly sdkName: "database_id";
6429
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6208
6430
  }, {
6209
6431
  readonly name: "table";
6210
6432
  readonly sdkName: "table";
6433
+ readonly description: "table ID or name.";
6211
6434
  }];
6212
6435
  readonly query: readonly [];
6213
6436
  readonly body: {
@@ -6236,9 +6459,11 @@ export declare const operations: readonly [{
6236
6459
  readonly pathParams: readonly [{
6237
6460
  readonly name: "database_id";
6238
6461
  readonly sdkName: "database_id";
6462
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6239
6463
  }, {
6240
6464
  readonly name: "table";
6241
6465
  readonly sdkName: "table";
6466
+ readonly description: "table ID or name.";
6242
6467
  }];
6243
6468
  readonly query: readonly [];
6244
6469
  readonly body: {
@@ -6257,12 +6482,15 @@ export declare const operations: readonly [{
6257
6482
  readonly pathParams: readonly [{
6258
6483
  readonly name: "database_id";
6259
6484
  readonly sdkName: "database_id";
6485
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6260
6486
  }, {
6261
6487
  readonly name: "table";
6262
6488
  readonly sdkName: "table";
6489
+ readonly description: "table ID or name.";
6263
6490
  }, {
6264
6491
  readonly name: "field";
6265
6492
  readonly sdkName: "field";
6493
+ readonly description: "field ID or name.";
6266
6494
  }];
6267
6495
  readonly query: readonly [];
6268
6496
  }, {
@@ -6277,12 +6505,15 @@ export declare const operations: readonly [{
6277
6505
  readonly pathParams: readonly [{
6278
6506
  readonly name: "database_id";
6279
6507
  readonly sdkName: "database_id";
6508
+ readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
6280
6509
  }, {
6281
6510
  readonly name: "table";
6282
6511
  readonly sdkName: "table";
6512
+ readonly description: "table ID or name.";
6283
6513
  }, {
6284
6514
  readonly name: "field";
6285
6515
  readonly sdkName: "field";
6516
+ readonly description: "field ID or name.";
6286
6517
  }];
6287
6518
  readonly query: readonly [];
6288
6519
  readonly body: {
@@ -6410,6 +6641,7 @@ export declare const operations: readonly [{
6410
6641
  readonly pathParams: readonly [{
6411
6642
  readonly name: "file_id";
6412
6643
  readonly sdkName: "file_id";
6644
+ readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
6413
6645
  }];
6414
6646
  readonly query: readonly [];
6415
6647
  }, {
@@ -6424,6 +6656,7 @@ export declare const operations: readonly [{
6424
6656
  readonly pathParams: readonly [{
6425
6657
  readonly name: "file_id";
6426
6658
  readonly sdkName: "file_id";
6659
+ readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
6427
6660
  }];
6428
6661
  readonly query: readonly [];
6429
6662
  }, {
@@ -6438,6 +6671,7 @@ export declare const operations: readonly [{
6438
6671
  readonly pathParams: readonly [{
6439
6672
  readonly name: "file_id";
6440
6673
  readonly sdkName: "file_id";
6674
+ readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
6441
6675
  }];
6442
6676
  readonly query: readonly [];
6443
6677
  }, {
@@ -6498,6 +6732,7 @@ export declare const operations: readonly [{
6498
6732
  readonly pathParams: readonly [{
6499
6733
  readonly name: "upload_id";
6500
6734
  readonly sdkName: "upload_id";
6735
+ readonly description: "Upload identifier returned by create; belongs to your organization.";
6501
6736
  }];
6502
6737
  readonly query: readonly [];
6503
6738
  }, {
@@ -6512,6 +6747,7 @@ export declare const operations: readonly [{
6512
6747
  readonly pathParams: readonly [{
6513
6748
  readonly name: "upload_id";
6514
6749
  readonly sdkName: "upload_id";
6750
+ readonly description: "Upload identifier returned by create; belongs to your organization.";
6515
6751
  }];
6516
6752
  readonly query: readonly [];
6517
6753
  readonly body: {
@@ -6542,6 +6778,7 @@ export declare const operations: readonly [{
6542
6778
  readonly pathParams: readonly [{
6543
6779
  readonly name: "upload_id";
6544
6780
  readonly sdkName: "upload_id";
6781
+ readonly description: "Upload identifier returned by create; belongs to your organization.";
6545
6782
  }];
6546
6783
  readonly query: readonly [{
6547
6784
  readonly name: "part_number";
@@ -6659,6 +6896,7 @@ export declare const operations: readonly [{
6659
6896
  readonly pathParams: readonly [{
6660
6897
  readonly name: "vector_store_id";
6661
6898
  readonly sdkName: "vector_store_id";
6899
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6662
6900
  }];
6663
6901
  readonly query: readonly [];
6664
6902
  }, {
@@ -6673,6 +6911,7 @@ export declare const operations: readonly [{
6673
6911
  readonly pathParams: readonly [{
6674
6912
  readonly name: "vector_store_id";
6675
6913
  readonly sdkName: "vector_store_id";
6914
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6676
6915
  }];
6677
6916
  readonly query: readonly [{
6678
6917
  readonly name: "expand";
@@ -6701,6 +6940,7 @@ export declare const operations: readonly [{
6701
6940
  readonly pathParams: readonly [{
6702
6941
  readonly name: "vector_store_id";
6703
6942
  readonly sdkName: "vector_store_id";
6943
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6704
6944
  }];
6705
6945
  readonly query: readonly [];
6706
6946
  readonly body: {
@@ -6739,6 +6979,7 @@ export declare const operations: readonly [{
6739
6979
  readonly pathParams: readonly [{
6740
6980
  readonly name: "vector_store_id";
6741
6981
  readonly sdkName: "vector_store_id";
6982
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6742
6983
  }];
6743
6984
  readonly query: readonly [{
6744
6985
  readonly name: "after_seq";
@@ -6763,6 +7004,7 @@ export declare const operations: readonly [{
6763
7004
  readonly pathParams: readonly [{
6764
7005
  readonly name: "vector_store_id";
6765
7006
  readonly sdkName: "vector_store_id";
7007
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6766
7008
  }];
6767
7009
  readonly query: readonly [];
6768
7010
  readonly body: {
@@ -6781,9 +7023,11 @@ export declare const operations: readonly [{
6781
7023
  readonly pathParams: readonly [{
6782
7024
  readonly name: "vector_store_id";
6783
7025
  readonly sdkName: "vector_store_id";
7026
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6784
7027
  }, {
6785
7028
  readonly name: "batch_id";
6786
7029
  readonly sdkName: "batch_id";
7030
+ readonly description: "File-batch ID returned by batch creation in this knowledge base.";
6787
7031
  }];
6788
7032
  readonly query: readonly [];
6789
7033
  }, {
@@ -6798,9 +7042,11 @@ export declare const operations: readonly [{
6798
7042
  readonly pathParams: readonly [{
6799
7043
  readonly name: "vector_store_id";
6800
7044
  readonly sdkName: "vector_store_id";
7045
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6801
7046
  }, {
6802
7047
  readonly name: "batch_id";
6803
7048
  readonly sdkName: "batch_id";
7049
+ readonly description: "File-batch ID returned by batch creation in this knowledge base.";
6804
7050
  }];
6805
7051
  readonly query: readonly [];
6806
7052
  }, {
@@ -6815,9 +7061,11 @@ export declare const operations: readonly [{
6815
7061
  readonly pathParams: readonly [{
6816
7062
  readonly name: "vector_store_id";
6817
7063
  readonly sdkName: "vector_store_id";
7064
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6818
7065
  }, {
6819
7066
  readonly name: "batch_id";
6820
7067
  readonly sdkName: "batch_id";
7068
+ readonly description: "File-batch ID returned by batch creation in this knowledge base.";
6821
7069
  }];
6822
7070
  readonly query: readonly [{
6823
7071
  readonly name: "after";
@@ -6859,6 +7107,7 @@ export declare const operations: readonly [{
6859
7107
  readonly pathParams: readonly [{
6860
7108
  readonly name: "vector_store_id";
6861
7109
  readonly sdkName: "vector_store_id";
7110
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6862
7111
  }];
6863
7112
  readonly query: readonly [{
6864
7113
  readonly name: "after";
@@ -6900,6 +7149,7 @@ export declare const operations: readonly [{
6900
7149
  readonly pathParams: readonly [{
6901
7150
  readonly name: "vector_store_id";
6902
7151
  readonly sdkName: "vector_store_id";
7152
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6903
7153
  }];
6904
7154
  readonly query: readonly [];
6905
7155
  readonly body: {
@@ -6933,9 +7183,11 @@ export declare const operations: readonly [{
6933
7183
  readonly pathParams: readonly [{
6934
7184
  readonly name: "vector_store_id";
6935
7185
  readonly sdkName: "vector_store_id";
7186
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6936
7187
  }, {
6937
7188
  readonly name: "file_id";
6938
7189
  readonly sdkName: "file_id";
7190
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
6939
7191
  }];
6940
7192
  readonly query: readonly [];
6941
7193
  }, {
@@ -6950,9 +7202,11 @@ export declare const operations: readonly [{
6950
7202
  readonly pathParams: readonly [{
6951
7203
  readonly name: "vector_store_id";
6952
7204
  readonly sdkName: "vector_store_id";
7205
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6953
7206
  }, {
6954
7207
  readonly name: "file_id";
6955
7208
  readonly sdkName: "file_id";
7209
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
6956
7210
  }];
6957
7211
  readonly query: readonly [];
6958
7212
  }, {
@@ -6967,9 +7221,11 @@ export declare const operations: readonly [{
6967
7221
  readonly pathParams: readonly [{
6968
7222
  readonly name: "vector_store_id";
6969
7223
  readonly sdkName: "vector_store_id";
7224
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6970
7225
  }, {
6971
7226
  readonly name: "file_id";
6972
7227
  readonly sdkName: "file_id";
7228
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
6973
7229
  }];
6974
7230
  readonly query: readonly [];
6975
7231
  readonly body: {
@@ -6993,9 +7249,11 @@ export declare const operations: readonly [{
6993
7249
  readonly pathParams: readonly [{
6994
7250
  readonly name: "vector_store_id";
6995
7251
  readonly sdkName: "vector_store_id";
7252
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
6996
7253
  }, {
6997
7254
  readonly name: "file_id";
6998
7255
  readonly sdkName: "file_id";
7256
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
6999
7257
  }];
7000
7258
  readonly query: readonly [];
7001
7259
  }, {
@@ -7010,9 +7268,11 @@ export declare const operations: readonly [{
7010
7268
  readonly pathParams: readonly [{
7011
7269
  readonly name: "vector_store_id";
7012
7270
  readonly sdkName: "vector_store_id";
7271
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
7013
7272
  }, {
7014
7273
  readonly name: "file_id";
7015
7274
  readonly sdkName: "file_id";
7275
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
7016
7276
  }];
7017
7277
  readonly query: readonly [];
7018
7278
  }, {
@@ -7027,9 +7287,11 @@ export declare const operations: readonly [{
7027
7287
  readonly pathParams: readonly [{
7028
7288
  readonly name: "vector_store_id";
7029
7289
  readonly sdkName: "vector_store_id";
7290
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
7030
7291
  }, {
7031
7292
  readonly name: "file_id";
7032
7293
  readonly sdkName: "file_id";
7294
+ readonly description: "Source File ID of an attachment, returned by file attachment or listing.";
7033
7295
  }];
7034
7296
  readonly query: readonly [{
7035
7297
  readonly name: "after";
@@ -7065,6 +7327,7 @@ export declare const operations: readonly [{
7065
7327
  readonly pathParams: readonly [{
7066
7328
  readonly name: "vector_store_id";
7067
7329
  readonly sdkName: "vector_store_id";
7330
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
7068
7331
  }];
7069
7332
  readonly query: readonly [];
7070
7333
  }, {
@@ -7079,6 +7342,7 @@ export declare const operations: readonly [{
7079
7342
  readonly pathParams: readonly [{
7080
7343
  readonly name: "vector_store_id";
7081
7344
  readonly sdkName: "vector_store_id";
7345
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
7082
7346
  }];
7083
7347
  readonly query: readonly [];
7084
7348
  }, {
@@ -7093,6 +7357,7 @@ export declare const operations: readonly [{
7093
7357
  readonly pathParams: readonly [{
7094
7358
  readonly name: "vector_store_id";
7095
7359
  readonly sdkName: "vector_store_id";
7360
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
7096
7361
  }];
7097
7362
  readonly query: readonly [];
7098
7363
  readonly body: {
@@ -7146,9 +7411,11 @@ export declare const operations: readonly [{
7146
7411
  readonly pathParams: readonly [{
7147
7412
  readonly name: "vector_store_id";
7148
7413
  readonly sdkName: "vector_store_id";
7414
+ readonly description: "Knowledge-base ID returned by create or list; use the ID rather than its display name.";
7149
7415
  }, {
7150
7416
  readonly name: "chunk_id";
7151
7417
  readonly sdkName: "chunk_id";
7418
+ readonly description: "Chunk ID returned by segment listing or native search content.";
7152
7419
  }];
7153
7420
  readonly query: readonly [];
7154
7421
  }, {
@@ -7230,6 +7497,7 @@ export declare const operations: readonly [{
7230
7497
  readonly pathParams: readonly [{
7231
7498
  readonly name: "library_id";
7232
7499
  readonly sdkName: "library_id";
7500
+ readonly description: "Library ID returned by creation.";
7233
7501
  }];
7234
7502
  readonly query: readonly [];
7235
7503
  }, {
@@ -7244,6 +7512,7 @@ export declare const operations: readonly [{
7244
7512
  readonly pathParams: readonly [{
7245
7513
  readonly name: "library_id";
7246
7514
  readonly sdkName: "library_id";
7515
+ readonly description: "Library ID returned by creation.";
7247
7516
  }];
7248
7517
  readonly query: readonly [];
7249
7518
  }, {
@@ -7258,6 +7527,7 @@ export declare const operations: readonly [{
7258
7527
  readonly pathParams: readonly [{
7259
7528
  readonly name: "library_id";
7260
7529
  readonly sdkName: "library_id";
7530
+ readonly description: "Library ID returned by creation.";
7261
7531
  }];
7262
7532
  readonly query: readonly [];
7263
7533
  readonly body: {
@@ -7296,6 +7566,7 @@ export declare const operations: readonly [{
7296
7566
  readonly pathParams: readonly [{
7297
7567
  readonly name: "library_id";
7298
7568
  readonly sdkName: "library_id";
7569
+ readonly description: "Library ID returned by creation.";
7299
7570
  }];
7300
7571
  readonly query: readonly [{
7301
7572
  readonly name: "asset_folder";
@@ -7332,6 +7603,7 @@ export declare const operations: readonly [{
7332
7603
  readonly pathParams: readonly [{
7333
7604
  readonly name: "library_id";
7334
7605
  readonly sdkName: "library_id";
7606
+ readonly description: "Library ID returned by creation.";
7335
7607
  }];
7336
7608
  readonly query: readonly [];
7337
7609
  readonly body: {
@@ -7421,6 +7693,7 @@ export declare const operations: readonly [{
7421
7693
  readonly pathParams: readonly [{
7422
7694
  readonly name: "library_id";
7423
7695
  readonly sdkName: "library_id";
7696
+ readonly description: "Library ID returned by creation.";
7424
7697
  }];
7425
7698
  readonly query: readonly [];
7426
7699
  readonly body: {
@@ -7509,9 +7782,11 @@ export declare const operations: readonly [{
7509
7782
  readonly pathParams: readonly [{
7510
7783
  readonly name: "library_id";
7511
7784
  readonly sdkName: "library_id";
7785
+ readonly description: "Library ID returned by creation.";
7512
7786
  }, {
7513
7787
  readonly name: "asset_id";
7514
7788
  readonly sdkName: "asset_id";
7789
+ readonly description: "32-character asset ID.";
7515
7790
  }];
7516
7791
  readonly query: readonly [];
7517
7792
  }, {
@@ -7526,9 +7801,11 @@ export declare const operations: readonly [{
7526
7801
  readonly pathParams: readonly [{
7527
7802
  readonly name: "library_id";
7528
7803
  readonly sdkName: "library_id";
7804
+ readonly description: "Library ID returned by creation.";
7529
7805
  }, {
7530
7806
  readonly name: "asset_id";
7531
7807
  readonly sdkName: "asset_id";
7808
+ readonly description: "32-character asset ID.";
7532
7809
  }];
7533
7810
  readonly query: readonly [];
7534
7811
  }, {
@@ -7543,9 +7820,11 @@ export declare const operations: readonly [{
7543
7820
  readonly pathParams: readonly [{
7544
7821
  readonly name: "library_id";
7545
7822
  readonly sdkName: "library_id";
7823
+ readonly description: "Library ID returned by creation.";
7546
7824
  }, {
7547
7825
  readonly name: "asset_id";
7548
7826
  readonly sdkName: "asset_id";
7827
+ readonly description: "32-character asset ID.";
7549
7828
  }];
7550
7829
  readonly query: readonly [];
7551
7830
  readonly body: {
@@ -7585,9 +7864,11 @@ export declare const operations: readonly [{
7585
7864
  readonly pathParams: readonly [{
7586
7865
  readonly name: "library_id";
7587
7866
  readonly sdkName: "library_id";
7867
+ readonly description: "Library ID returned by creation.";
7588
7868
  }, {
7589
7869
  readonly name: "asset_id";
7590
7870
  readonly sdkName: "asset_id";
7871
+ readonly description: "32-character asset ID.";
7591
7872
  }];
7592
7873
  readonly query: readonly [];
7593
7874
  readonly body: {
@@ -7613,9 +7894,11 @@ export declare const operations: readonly [{
7613
7894
  readonly pathParams: readonly [{
7614
7895
  readonly name: "library_id";
7615
7896
  readonly sdkName: "library_id";
7897
+ readonly description: "Library ID returned by creation.";
7616
7898
  }, {
7617
7899
  readonly name: "asset_id";
7618
7900
  readonly sdkName: "asset_id";
7901
+ readonly description: "32-character asset ID.";
7619
7902
  }];
7620
7903
  readonly query: readonly [{
7621
7904
  readonly name: "include_superseded";
@@ -7651,6 +7934,7 @@ export declare const operations: readonly [{
7651
7934
  readonly pathParams: readonly [{
7652
7935
  readonly name: "library_id";
7653
7936
  readonly sdkName: "library_id";
7937
+ readonly description: "Library ID returned by creation.";
7654
7938
  }];
7655
7939
  readonly query: readonly [];
7656
7940
  readonly body: {
@@ -7674,6 +7958,7 @@ export declare const operations: readonly [{
7674
7958
  readonly pathParams: readonly [{
7675
7959
  readonly name: "library_id";
7676
7960
  readonly sdkName: "library_id";
7961
+ readonly description: "Library ID returned by creation.";
7677
7962
  }];
7678
7963
  readonly query: readonly [];
7679
7964
  readonly body: {
@@ -7697,9 +7982,11 @@ export declare const operations: readonly [{
7697
7982
  readonly pathParams: readonly [{
7698
7983
  readonly name: "library_id";
7699
7984
  readonly sdkName: "library_id";
7985
+ readonly description: "Library ID returned by creation.";
7700
7986
  }, {
7701
7987
  readonly name: "job_id";
7702
7988
  readonly sdkName: "job_id";
7989
+ readonly description: "Batch identifier returned by createBatch or batchAssets; resolved within this library.";
7703
7990
  }];
7704
7991
  readonly query: readonly [];
7705
7992
  }, {
@@ -7714,6 +8001,7 @@ export declare const operations: readonly [{
7714
8001
  readonly pathParams: readonly [{
7715
8002
  readonly name: "library_id";
7716
8003
  readonly sdkName: "library_id";
8004
+ readonly description: "Library ID returned by creation.";
7717
8005
  }];
7718
8006
  readonly query: readonly [{
7719
8007
  readonly name: "after_seq";
@@ -7749,6 +8037,7 @@ export declare const operations: readonly [{
7749
8037
  readonly pathParams: readonly [{
7750
8038
  readonly name: "library_id";
7751
8039
  readonly sdkName: "library_id";
8040
+ readonly description: "Library ID returned by creation.";
7752
8041
  }];
7753
8042
  readonly query: readonly [{
7754
8043
  readonly name: "parent";
@@ -7768,9 +8057,11 @@ export declare const operations: readonly [{
7768
8057
  readonly pathParams: readonly [{
7769
8058
  readonly name: "library_id";
7770
8059
  readonly sdkName: "library_id";
8060
+ readonly description: "Library ID returned by creation.";
7771
8061
  }, {
7772
8062
  readonly name: "job_id";
7773
8063
  readonly sdkName: "job_id";
8064
+ readonly description: "Batch identifier returned by createBatch or batchAssets; resolved within this library.";
7774
8065
  }];
7775
8066
  readonly query: readonly [];
7776
8067
  }, {
@@ -7785,6 +8076,7 @@ export declare const operations: readonly [{
7785
8076
  readonly pathParams: readonly [{
7786
8077
  readonly name: "library_id";
7787
8078
  readonly sdkName: "library_id";
8079
+ readonly description: "Library ID returned by creation.";
7788
8080
  }];
7789
8081
  readonly query: readonly [];
7790
8082
  }, {
@@ -7799,6 +8091,7 @@ export declare const operations: readonly [{
7799
8091
  readonly pathParams: readonly [{
7800
8092
  readonly name: "library_id";
7801
8093
  readonly sdkName: "library_id";
8094
+ readonly description: "Library ID returned by creation.";
7802
8095
  }];
7803
8096
  readonly query: readonly [];
7804
8097
  }, {
@@ -7813,6 +8106,7 @@ export declare const operations: readonly [{
7813
8106
  readonly pathParams: readonly [{
7814
8107
  readonly name: "library_id";
7815
8108
  readonly sdkName: "library_id";
8109
+ readonly description: "Library ID returned by creation.";
7816
8110
  }];
7817
8111
  readonly query: readonly [];
7818
8112
  readonly body: {
@@ -7852,6 +8146,7 @@ export declare const operations: readonly [{
7852
8146
  readonly pathParams: readonly [{
7853
8147
  readonly name: "library_id";
7854
8148
  readonly sdkName: "library_id";
8149
+ readonly description: "Library ID returned by creation.";
7855
8150
  }];
7856
8151
  readonly query: readonly [];
7857
8152
  readonly body: {
@@ -7905,6 +8200,7 @@ export declare const operations: readonly [{
7905
8200
  readonly pathParams: readonly [{
7906
8201
  readonly name: "library_id";
7907
8202
  readonly sdkName: "library_id";
8203
+ readonly description: "Library ID returned by creation.";
7908
8204
  }];
7909
8205
  readonly query: readonly [];
7910
8206
  readonly body: {
@@ -7944,6 +8240,7 @@ export declare const operations: readonly [{
7944
8240
  readonly pathParams: readonly [{
7945
8241
  readonly name: "library_id";
7946
8242
  readonly sdkName: "library_id";
8243
+ readonly description: "Library ID returned by creation.";
7947
8244
  }];
7948
8245
  readonly query: readonly [];
7949
8246
  readonly body: {
@@ -8019,6 +8316,7 @@ export declare const operations: readonly [{
8019
8316
  readonly pathParams: readonly [{
8020
8317
  readonly name: "name";
8021
8318
  readonly sdkName: "name";
8319
+ readonly description: "Exact method name from the search results, for example `praxis.database.databases.tables.create`.";
8022
8320
  }];
8023
8321
  readonly query: readonly [];
8024
8322
  }, {
@@ -8525,6 +8823,7 @@ export declare const operations: readonly [{
8525
8823
  readonly pathParams: readonly [{
8526
8824
  readonly name: "conversation_id";
8527
8825
  readonly sdkName: "conversation_id";
8826
+ readonly description: "Id of the conversation, the `id` of the object returned by createConversation (it looks like conv_...). Another tenant's conversation, an unknown id and a deleted conversation all answer 404 conversation_not_found.";
8528
8827
  }];
8529
8828
  readonly query: readonly [];
8530
8829
  }, {
@@ -8539,6 +8838,7 @@ export declare const operations: readonly [{
8539
8838
  readonly pathParams: readonly [{
8540
8839
  readonly name: "conversation_id";
8541
8840
  readonly sdkName: "conversation_id";
8841
+ readonly description: "Id of the conversation, the `id` of the object returned by createConversation (it looks like conv_...). Another tenant's conversation, an unknown id and a deleted conversation all answer 404 conversation_not_found.";
8542
8842
  }];
8543
8843
  readonly query: readonly [];
8544
8844
  }, {
@@ -8553,6 +8853,7 @@ export declare const operations: readonly [{
8553
8853
  readonly pathParams: readonly [{
8554
8854
  readonly name: "conversation_id";
8555
8855
  readonly sdkName: "conversation_id";
8856
+ readonly description: "Id of the conversation, the `id` of the object returned by createConversation (it looks like conv_...). Another tenant's conversation, an unknown id and a deleted conversation all answer 404 conversation_not_found.";
8556
8857
  }];
8557
8858
  readonly query: readonly [];
8558
8859
  readonly body: {
@@ -8576,6 +8877,7 @@ export declare const operations: readonly [{
8576
8877
  readonly pathParams: readonly [{
8577
8878
  readonly name: "conversation_id";
8578
8879
  readonly sdkName: "conversation_id";
8880
+ readonly description: "Id of the conversation, the `id` of the object returned by createConversation (it looks like conv_...). Another tenant's conversation, an unknown id and a deleted conversation all answer 404 conversation_not_found.";
8579
8881
  }];
8580
8882
  readonly query: readonly [];
8581
8883
  }, {
@@ -8590,6 +8892,7 @@ export declare const operations: readonly [{
8590
8892
  readonly pathParams: readonly [{
8591
8893
  readonly name: "conversation_id";
8592
8894
  readonly sdkName: "conversation_id";
8895
+ readonly description: "Id of the conversation, the `id` of the object returned by createConversation (it looks like conv_...). Another tenant's conversation, an unknown id and a deleted conversation all answer 404 conversation_not_found.";
8593
8896
  }];
8594
8897
  readonly query: readonly [];
8595
8898
  readonly body: {
@@ -8614,9 +8917,11 @@ export declare const operations: readonly [{
8614
8917
  readonly pathParams: readonly [{
8615
8918
  readonly name: "conversation_id";
8616
8919
  readonly sdkName: "conversation_id";
8920
+ readonly description: "Id of the conversation, the `id` of the object returned by createConversation (it looks like conv_...). Another tenant's conversation, an unknown id and a deleted conversation all answer 404 conversation_not_found.";
8617
8921
  }, {
8618
8922
  readonly name: "item_id";
8619
8923
  readonly sdkName: "item_id";
8924
+ readonly description: "Id of the item to delete, from the `id` of an item returned by createConversationItems or listConversationItems. An id that is not in the conversation answers 404.";
8620
8925
  }];
8621
8926
  readonly query: readonly [];
8622
8927
  }, {
@@ -8631,9 +8936,11 @@ export declare const operations: readonly [{
8631
8936
  readonly pathParams: readonly [{
8632
8937
  readonly name: "conversation_id";
8633
8938
  readonly sdkName: "conversation_id";
8939
+ readonly description: "Id of the conversation, the `id` of the object returned by createConversation (it looks like conv_...). Another tenant's conversation, an unknown id and a deleted conversation all answer 404 conversation_not_found.";
8634
8940
  }, {
8635
8941
  readonly name: "item_id";
8636
8942
  readonly sdkName: "item_id";
8943
+ readonly description: "Id of the item to read, from the `id` of an item returned by createConversationItems or listConversationItems. An id that is not in the conversation answers 404.";
8637
8944
  }];
8638
8945
  readonly query: readonly [];
8639
8946
  }, {
@@ -9078,6 +9385,7 @@ export declare const operations: readonly [{
9078
9385
  readonly pathParams: readonly [{
9079
9386
  readonly name: "model";
9080
9387
  readonly sdkName: "model";
9388
+ readonly description: "Id of the model to read. It may carry a creator prefix with a slash, such as deepseek/deepseek-v4-pro, so the value runs to the end of the path. Ids come from the `id` field of listModels; an unknown id answers 404.";
9081
9389
  }];
9082
9390
  readonly query: readonly [];
9083
9391
  }, {
@@ -9448,6 +9756,7 @@ export declare const operations: readonly [{
9448
9756
  readonly pathParams: readonly [{
9449
9757
  readonly name: "response_id";
9450
9758
  readonly sdkName: "response_id";
9759
+ readonly description: "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404.";
9451
9760
  }];
9452
9761
  readonly query: readonly [];
9453
9762
  }, {
@@ -9462,6 +9771,7 @@ export declare const operations: readonly [{
9462
9771
  readonly pathParams: readonly [{
9463
9772
  readonly name: "response_id";
9464
9773
  readonly sdkName: "response_id";
9774
+ readonly description: "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404.";
9465
9775
  }];
9466
9776
  readonly query: readonly [];
9467
9777
  }, {
@@ -9476,6 +9786,7 @@ export declare const operations: readonly [{
9476
9786
  readonly pathParams: readonly [{
9477
9787
  readonly name: "response_id";
9478
9788
  readonly sdkName: "response_id";
9789
+ readonly description: "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404.";
9479
9790
  }];
9480
9791
  readonly query: readonly [];
9481
9792
  }, {
@@ -9490,6 +9801,7 @@ export declare const operations: readonly [{
9490
9801
  readonly pathParams: readonly [{
9491
9802
  readonly name: "response_id";
9492
9803
  readonly sdkName: "response_id";
9804
+ readonly description: "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404.";
9493
9805
  }];
9494
9806
  readonly query: readonly [];
9495
9807
  }, {
@@ -9619,6 +9931,7 @@ export declare const operations: readonly [{
9619
9931
  readonly pathParams: readonly [{
9620
9932
  readonly name: "video_id";
9621
9933
  readonly sdkName: "video_id";
9934
+ readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
9622
9935
  }];
9623
9936
  readonly query: readonly [];
9624
9937
  }, {
@@ -9633,6 +9946,7 @@ export declare const operations: readonly [{
9633
9946
  readonly pathParams: readonly [{
9634
9947
  readonly name: "video_id";
9635
9948
  readonly sdkName: "video_id";
9949
+ readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
9636
9950
  }];
9637
9951
  readonly query: readonly [];
9638
9952
  }, {
@@ -9647,6 +9961,7 @@ export declare const operations: readonly [{
9647
9961
  readonly pathParams: readonly [{
9648
9962
  readonly name: "video_id";
9649
9963
  readonly sdkName: "video_id";
9964
+ readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
9650
9965
  }];
9651
9966
  readonly query: readonly [{
9652
9967
  readonly name: "variant";
@@ -9672,6 +9987,7 @@ export declare const operations: readonly [{
9672
9987
  readonly pathParams: readonly [{
9673
9988
  readonly name: "video_id";
9674
9989
  readonly sdkName: "video_id";
9990
+ readonly description: "Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.";
9675
9991
  }];
9676
9992
  readonly query: readonly [];
9677
9993
  }, {
@@ -9782,6 +10098,7 @@ export declare const operations: readonly [{
9782
10098
  readonly pathParams: readonly [{
9783
10099
  readonly name: "id";
9784
10100
  readonly sdkName: "id";
10101
+ readonly description: "The event id from the events list.";
9785
10102
  }];
9786
10103
  readonly query: readonly [];
9787
10104
  }, {
@@ -9910,6 +10227,7 @@ export declare const operations: readonly [{
9910
10227
  readonly pathParams: readonly [{
9911
10228
  readonly name: "id";
9912
10229
  readonly sdkName: "id";
10230
+ readonly description: "Feedback identifier, prefixed with fb_.";
9913
10231
  }];
9914
10232
  readonly query: readonly [];
9915
10233
  }, {
@@ -9924,6 +10242,7 @@ export declare const operations: readonly [{
9924
10242
  readonly pathParams: readonly [{
9925
10243
  readonly name: "id";
9926
10244
  readonly sdkName: "id";
10245
+ readonly description: "Feedback identifier, prefixed with fb_.";
9927
10246
  }];
9928
10247
  readonly query: readonly [{
9929
10248
  readonly name: "limit";
@@ -9948,6 +10267,7 @@ export declare const operations: readonly [{
9948
10267
  readonly pathParams: readonly [{
9949
10268
  readonly name: "id";
9950
10269
  readonly sdkName: "id";
10270
+ readonly description: "Feedback identifier, prefixed with fb_.";
9951
10271
  }];
9952
10272
  readonly query: readonly [];
9953
10273
  readonly body: {
@@ -10151,6 +10471,7 @@ export declare const operations: readonly [{
10151
10471
  readonly pathParams: readonly [{
10152
10472
  readonly name: "sandboxID";
10153
10473
  readonly sdkName: "sandboxID";
10474
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10154
10475
  }];
10155
10476
  readonly query: readonly [];
10156
10477
  }, {
@@ -10165,6 +10486,7 @@ export declare const operations: readonly [{
10165
10486
  readonly pathParams: readonly [{
10166
10487
  readonly name: "sandboxID";
10167
10488
  readonly sdkName: "sandboxID";
10489
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10168
10490
  }];
10169
10491
  readonly query: readonly [];
10170
10492
  }, {
@@ -10179,6 +10501,7 @@ export declare const operations: readonly [{
10179
10501
  readonly pathParams: readonly [{
10180
10502
  readonly name: "sandboxID";
10181
10503
  readonly sdkName: "sandboxID";
10504
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10182
10505
  }];
10183
10506
  readonly query: readonly [];
10184
10507
  readonly body: {
@@ -10202,6 +10525,7 @@ export declare const operations: readonly [{
10202
10525
  readonly pathParams: readonly [{
10203
10526
  readonly name: "sandboxID";
10204
10527
  readonly sdkName: "sandboxID";
10528
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10205
10529
  }];
10206
10530
  readonly query: readonly [];
10207
10531
  readonly body: {
@@ -10230,6 +10554,7 @@ export declare const operations: readonly [{
10230
10554
  readonly pathParams: readonly [{
10231
10555
  readonly name: "sandboxID";
10232
10556
  readonly sdkName: "sandboxID";
10557
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10233
10558
  }];
10234
10559
  readonly query: readonly [];
10235
10560
  readonly body: {
@@ -10254,6 +10579,7 @@ export declare const operations: readonly [{
10254
10579
  readonly pathParams: readonly [{
10255
10580
  readonly name: "sandboxID";
10256
10581
  readonly sdkName: "sandboxID";
10582
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10257
10583
  }];
10258
10584
  readonly query: readonly [];
10259
10585
  readonly body: {
@@ -10282,6 +10608,7 @@ export declare const operations: readonly [{
10282
10608
  readonly pathParams: readonly [{
10283
10609
  readonly name: "sandboxID";
10284
10610
  readonly sdkName: "sandboxID";
10611
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10285
10612
  }];
10286
10613
  readonly query: readonly [{
10287
10614
  readonly name: "cursor";
@@ -10323,6 +10650,7 @@ export declare const operations: readonly [{
10323
10650
  readonly pathParams: readonly [{
10324
10651
  readonly name: "sandboxID";
10325
10652
  readonly sdkName: "sandboxID";
10653
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10326
10654
  }];
10327
10655
  readonly query: readonly [{
10328
10656
  readonly name: "start";
@@ -10347,6 +10675,7 @@ export declare const operations: readonly [{
10347
10675
  readonly pathParams: readonly [{
10348
10676
  readonly name: "sandboxID";
10349
10677
  readonly sdkName: "sandboxID";
10678
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10350
10679
  }];
10351
10680
  readonly query: readonly [];
10352
10681
  readonly body: {
@@ -10392,6 +10721,7 @@ export declare const operations: readonly [{
10392
10721
  readonly pathParams: readonly [{
10393
10722
  readonly name: "sandboxID";
10394
10723
  readonly sdkName: "sandboxID";
10724
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10395
10725
  }];
10396
10726
  readonly query: readonly [];
10397
10727
  readonly body: {
@@ -10415,6 +10745,7 @@ export declare const operations: readonly [{
10415
10745
  readonly pathParams: readonly [{
10416
10746
  readonly name: "sandboxID";
10417
10747
  readonly sdkName: "sandboxID";
10748
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10418
10749
  }];
10419
10750
  readonly query: readonly [{
10420
10751
  readonly name: "state";
@@ -10435,9 +10766,11 @@ export declare const operations: readonly [{
10435
10766
  readonly pathParams: readonly [{
10436
10767
  readonly name: "sandboxID";
10437
10768
  readonly sdkName: "sandboxID";
10769
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10438
10770
  }, {
10439
10771
  readonly name: "processID";
10440
10772
  readonly sdkName: "processID";
10773
+ readonly description: "Id of the process, the `processId` of an entry returned by listObservedProcesses. Observed processes look like obs-<n>; a process that was only seen live (live-<pid>) has no retained output and answers 404.";
10441
10774
  }];
10442
10775
  readonly query: readonly [];
10443
10776
  }, {
@@ -10452,6 +10785,7 @@ export declare const operations: readonly [{
10452
10785
  readonly pathParams: readonly [{
10453
10786
  readonly name: "sandboxID";
10454
10787
  readonly sdkName: "sandboxID";
10788
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10455
10789
  }];
10456
10790
  readonly query: readonly [];
10457
10791
  readonly body: {
@@ -10475,6 +10809,7 @@ export declare const operations: readonly [{
10475
10809
  readonly pathParams: readonly [{
10476
10810
  readonly name: "sandboxID";
10477
10811
  readonly sdkName: "sandboxID";
10812
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10478
10813
  }];
10479
10814
  readonly query: readonly [];
10480
10815
  readonly body: {
@@ -10498,6 +10833,7 @@ export declare const operations: readonly [{
10498
10833
  readonly pathParams: readonly [{
10499
10834
  readonly name: "sandboxID";
10500
10835
  readonly sdkName: "sandboxID";
10836
+ readonly description: "Id of the sandbox, the `sandboxID` returned by the create call (or listed by listSandboxes). Another team's sandbox and an unknown id both answer 404.";
10501
10837
  }];
10502
10838
  readonly query: readonly [];
10503
10839
  readonly body: {
@@ -10521,6 +10857,7 @@ export declare const operations: readonly [{
10521
10857
  readonly pathParams: readonly [{
10522
10858
  readonly name: "sandbox_id";
10523
10859
  readonly sdkName: "sandbox_id";
10860
+ readonly description: "Sandbox ID returned by sandboxes.create or sandboxes.list.";
10524
10861
  }];
10525
10862
  readonly query: readonly [];
10526
10863
  readonly body: {
@@ -10559,6 +10896,7 @@ export declare const operations: readonly [{
10559
10896
  readonly pathParams: readonly [{
10560
10897
  readonly name: "sandbox_id";
10561
10898
  readonly sdkName: "sandbox_id";
10899
+ readonly description: "Sandbox ID returned by sandboxes.create or sandboxes.list.";
10562
10900
  }];
10563
10901
  readonly query: readonly [{
10564
10902
  readonly name: "path";
@@ -10578,6 +10916,7 @@ export declare const operations: readonly [{
10578
10916
  readonly pathParams: readonly [{
10579
10917
  readonly name: "sandbox_id";
10580
10918
  readonly sdkName: "sandbox_id";
10919
+ readonly description: "Sandbox ID returned by sandboxes.create or sandboxes.list.";
10581
10920
  }];
10582
10921
  readonly query: readonly [{
10583
10922
  readonly name: "path";
@@ -10597,6 +10936,7 @@ export declare const operations: readonly [{
10597
10936
  readonly pathParams: readonly [{
10598
10937
  readonly name: "sandbox_id";
10599
10938
  readonly sdkName: "sandbox_id";
10939
+ readonly description: "Sandbox ID returned by sandboxes.create or sandboxes.list.";
10600
10940
  }];
10601
10941
  readonly query: readonly [];
10602
10942
  readonly body: {
@@ -10625,6 +10965,7 @@ export declare const operations: readonly [{
10625
10965
  readonly pathParams: readonly [{
10626
10966
  readonly name: "sandbox_id";
10627
10967
  readonly sdkName: "sandbox_id";
10968
+ readonly description: "Sandbox ID returned by sandboxes.create or sandboxes.list.";
10628
10969
  }];
10629
10970
  readonly query: readonly [{
10630
10971
  readonly name: "path";
@@ -10644,6 +10985,7 @@ export declare const operations: readonly [{
10644
10985
  readonly pathParams: readonly [{
10645
10986
  readonly name: "sandbox_id";
10646
10987
  readonly sdkName: "sandbox_id";
10988
+ readonly description: "Sandbox ID returned by sandboxes.create or sandboxes.list.";
10647
10989
  }];
10648
10990
  readonly query: readonly [{
10649
10991
  readonly name: "path";
@@ -10694,6 +11036,7 @@ export declare const operations: readonly [{
10694
11036
  readonly pathParams: readonly [{
10695
11037
  readonly name: "snapshotID";
10696
11038
  readonly sdkName: "snapshotID";
11039
+ readonly description: "Id of the snapshot, the `snapshotID` returned by createSnapshot or listSnapshots. A snapshot that does not exist or belongs to someone else answers 404.";
10697
11040
  }];
10698
11041
  readonly query: readonly [];
10699
11042
  }, {
@@ -10765,6 +11108,7 @@ export declare const operations: readonly [{
10765
11108
  readonly pathParams: readonly [{
10766
11109
  readonly name: "volumeID";
10767
11110
  readonly sdkName: "volumeID";
11111
+ readonly description: "Id of the team volume, the `volumeID` returned by createVolume or listVolumes.";
10768
11112
  }];
10769
11113
  readonly query: readonly [];
10770
11114
  }, {
@@ -10779,6 +11123,7 @@ export declare const operations: readonly [{
10779
11123
  readonly pathParams: readonly [{
10780
11124
  readonly name: "volumeID";
10781
11125
  readonly sdkName: "volumeID";
11126
+ readonly description: "Id of the team volume, the `volumeID` returned by createVolume or listVolumes.";
10782
11127
  }];
10783
11128
  readonly query: readonly [];
10784
11129
  }, {
@@ -11218,6 +11563,7 @@ export declare const operations: readonly [{
11218
11563
  readonly pathParams: readonly [{
11219
11564
  readonly name: "id";
11220
11565
  readonly sdkName: "id";
11566
+ readonly description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers.";
11221
11567
  }];
11222
11568
  readonly query: readonly [{
11223
11569
  readonly name: "repository";
@@ -11237,6 +11583,7 @@ export declare const operations: readonly [{
11237
11583
  readonly pathParams: readonly [{
11238
11584
  readonly name: "id";
11239
11585
  readonly sdkName: "id";
11586
+ readonly description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers.";
11240
11587
  }];
11241
11588
  readonly query: readonly [{
11242
11589
  readonly name: "repository";
@@ -11256,6 +11603,7 @@ export declare const operations: readonly [{
11256
11603
  readonly pathParams: readonly [{
11257
11604
  readonly name: "id";
11258
11605
  readonly sdkName: "id";
11606
+ readonly description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers.";
11259
11607
  }];
11260
11608
  readonly query: readonly [{
11261
11609
  readonly name: "repository";
@@ -11289,6 +11637,7 @@ export declare const operations: readonly [{
11289
11637
  readonly pathParams: readonly [{
11290
11638
  readonly name: "id";
11291
11639
  readonly sdkName: "id";
11640
+ readonly description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers.";
11292
11641
  }];
11293
11642
  readonly query: readonly [{
11294
11643
  readonly name: "repository";
@@ -11318,6 +11667,7 @@ export declare const operations: readonly [{
11318
11667
  readonly pathParams: readonly [{
11319
11668
  readonly name: "id";
11320
11669
  readonly sdkName: "id";
11670
+ readonly description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers.";
11321
11671
  }];
11322
11672
  readonly query: readonly [{
11323
11673
  readonly name: "repository";
@@ -11347,9 +11697,11 @@ export declare const operations: readonly [{
11347
11697
  readonly pathParams: readonly [{
11348
11698
  readonly name: "id";
11349
11699
  readonly sdkName: "id";
11700
+ readonly description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers.";
11350
11701
  }, {
11351
11702
  readonly name: "content";
11352
11703
  readonly sdkName: "content";
11704
+ readonly description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers.";
11353
11705
  }];
11354
11706
  readonly query: readonly [{
11355
11707
  readonly name: "repository";
@@ -11430,6 +11782,7 @@ export declare const operations: readonly [{
11430
11782
  readonly pathParams: readonly [{
11431
11783
  readonly name: "name";
11432
11784
  readonly sdkName: "name";
11785
+ readonly description: "Label name from the repository label list.";
11433
11786
  }];
11434
11787
  readonly query: readonly [{
11435
11788
  readonly name: "repository";
@@ -11449,6 +11802,7 @@ export declare const operations: readonly [{
11449
11802
  readonly pathParams: readonly [{
11450
11803
  readonly name: "name";
11451
11804
  readonly sdkName: "name";
11805
+ readonly description: "Label name from the repository label list.";
11452
11806
  }];
11453
11807
  readonly query: readonly [{
11454
11808
  readonly name: "repository";
@@ -11554,6 +11908,8 @@ export declare const operations: readonly [{
11554
11908
  readonly pathParams: readonly [{
11555
11909
  readonly name: "number";
11556
11910
  readonly sdkName: "number";
11911
+ readonly type: "integer";
11912
+ readonly description: "Milestone number shown by create and list; not the object id.";
11557
11913
  }];
11558
11914
  readonly query: readonly [{
11559
11915
  readonly name: "repository";
@@ -11573,6 +11929,8 @@ export declare const operations: readonly [{
11573
11929
  readonly pathParams: readonly [{
11574
11930
  readonly name: "number";
11575
11931
  readonly sdkName: "number";
11932
+ readonly type: "integer";
11933
+ readonly description: "Milestone number shown by create and list; not the object id.";
11576
11934
  }];
11577
11935
  readonly query: readonly [{
11578
11936
  readonly name: "repository";
@@ -11592,6 +11950,8 @@ export declare const operations: readonly [{
11592
11950
  readonly pathParams: readonly [{
11593
11951
  readonly name: "number";
11594
11952
  readonly sdkName: "number";
11953
+ readonly type: "integer";
11954
+ readonly description: "Milestone number shown by create and list; not the object id.";
11595
11955
  }];
11596
11956
  readonly query: readonly [{
11597
11957
  readonly name: "repository";
@@ -11745,6 +12105,8 @@ export declare const operations: readonly [{
11745
12105
  readonly pathParams: readonly [{
11746
12106
  readonly name: "number";
11747
12107
  readonly sdkName: "number";
12108
+ readonly type: "integer";
12109
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
11748
12110
  }];
11749
12111
  readonly query: readonly [{
11750
12112
  readonly name: "repository";
@@ -11764,6 +12126,8 @@ export declare const operations: readonly [{
11764
12126
  readonly pathParams: readonly [{
11765
12127
  readonly name: "number";
11766
12128
  readonly sdkName: "number";
12129
+ readonly type: "integer";
12130
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
11767
12131
  }];
11768
12132
  readonly query: readonly [{
11769
12133
  readonly name: "repository";
@@ -11836,6 +12200,8 @@ export declare const operations: readonly [{
11836
12200
  readonly pathParams: readonly [{
11837
12201
  readonly name: "number";
11838
12202
  readonly sdkName: "number";
12203
+ readonly type: "integer";
12204
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
11839
12205
  }];
11840
12206
  readonly query: readonly [{
11841
12207
  readonly name: "repository";
@@ -11865,6 +12231,8 @@ export declare const operations: readonly [{
11865
12231
  readonly pathParams: readonly [{
11866
12232
  readonly name: "number";
11867
12233
  readonly sdkName: "number";
12234
+ readonly type: "integer";
12235
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
11868
12236
  }];
11869
12237
  readonly query: readonly [{
11870
12238
  readonly name: "repository";
@@ -11898,6 +12266,8 @@ export declare const operations: readonly [{
11898
12266
  readonly pathParams: readonly [{
11899
12267
  readonly name: "number";
11900
12268
  readonly sdkName: "number";
12269
+ readonly type: "integer";
12270
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
11901
12271
  }];
11902
12272
  readonly query: readonly [{
11903
12273
  readonly name: "repository";
@@ -11927,6 +12297,8 @@ export declare const operations: readonly [{
11927
12297
  readonly pathParams: readonly [{
11928
12298
  readonly name: "number";
11929
12299
  readonly sdkName: "number";
12300
+ readonly type: "integer";
12301
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
11930
12302
  }];
11931
12303
  readonly query: readonly [{
11932
12304
  readonly name: "repository";
@@ -11955,9 +12327,13 @@ export declare const operations: readonly [{
11955
12327
  readonly pathParams: readonly [{
11956
12328
  readonly name: "number";
11957
12329
  readonly sdkName: "number";
12330
+ readonly type: "integer";
12331
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
11958
12332
  }, {
11959
12333
  readonly name: "n";
11960
12334
  readonly sdkName: "n";
12335
+ readonly type: "integer";
12336
+ readonly description: "Number of the other ticket in the relation or dependency.";
11961
12337
  }];
11962
12338
  readonly query: readonly [{
11963
12339
  readonly name: "repository";
@@ -11977,6 +12353,8 @@ export declare const operations: readonly [{
11977
12353
  readonly pathParams: readonly [{
11978
12354
  readonly name: "number";
11979
12355
  readonly sdkName: "number";
12356
+ readonly type: "integer";
12357
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
11980
12358
  }];
11981
12359
  readonly query: readonly [{
11982
12360
  readonly name: "repository";
@@ -12006,6 +12384,8 @@ export declare const operations: readonly [{
12006
12384
  readonly pathParams: readonly [{
12007
12385
  readonly name: "number";
12008
12386
  readonly sdkName: "number";
12387
+ readonly type: "integer";
12388
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12009
12389
  }];
12010
12390
  readonly query: readonly [{
12011
12391
  readonly name: "repository";
@@ -12035,6 +12415,8 @@ export declare const operations: readonly [{
12035
12415
  readonly pathParams: readonly [{
12036
12416
  readonly name: "number";
12037
12417
  readonly sdkName: "number";
12418
+ readonly type: "integer";
12419
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12038
12420
  }];
12039
12421
  readonly query: readonly [{
12040
12422
  readonly name: "repository";
@@ -12054,6 +12436,8 @@ export declare const operations: readonly [{
12054
12436
  readonly pathParams: readonly [{
12055
12437
  readonly name: "number";
12056
12438
  readonly sdkName: "number";
12439
+ readonly type: "integer";
12440
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12057
12441
  }];
12058
12442
  readonly query: readonly [{
12059
12443
  readonly name: "repository";
@@ -12083,6 +12467,8 @@ export declare const operations: readonly [{
12083
12467
  readonly pathParams: readonly [{
12084
12468
  readonly name: "number";
12085
12469
  readonly sdkName: "number";
12470
+ readonly type: "integer";
12471
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12086
12472
  }];
12087
12473
  readonly query: readonly [{
12088
12474
  readonly name: "repository";
@@ -12112,6 +12498,8 @@ export declare const operations: readonly [{
12112
12498
  readonly pathParams: readonly [{
12113
12499
  readonly name: "number";
12114
12500
  readonly sdkName: "number";
12501
+ readonly type: "integer";
12502
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12115
12503
  }];
12116
12504
  readonly query: readonly [{
12117
12505
  readonly name: "repository";
@@ -12141,9 +12529,12 @@ export declare const operations: readonly [{
12141
12529
  readonly pathParams: readonly [{
12142
12530
  readonly name: "number";
12143
12531
  readonly sdkName: "number";
12532
+ readonly type: "integer";
12533
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12144
12534
  }, {
12145
12535
  readonly name: "content";
12146
12536
  readonly sdkName: "content";
12537
+ readonly description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers.";
12147
12538
  }];
12148
12539
  readonly query: readonly [{
12149
12540
  readonly name: "repository";
@@ -12163,6 +12554,8 @@ export declare const operations: readonly [{
12163
12554
  readonly pathParams: readonly [{
12164
12555
  readonly name: "number";
12165
12556
  readonly sdkName: "number";
12557
+ readonly type: "integer";
12558
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12166
12559
  }];
12167
12560
  readonly query: readonly [{
12168
12561
  readonly name: "repository";
@@ -12192,6 +12585,8 @@ export declare const operations: readonly [{
12192
12585
  readonly pathParams: readonly [{
12193
12586
  readonly name: "number";
12194
12587
  readonly sdkName: "number";
12588
+ readonly type: "integer";
12589
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12195
12590
  }];
12196
12591
  readonly query: readonly [{
12197
12592
  readonly name: "repository";
@@ -12220,9 +12615,13 @@ export declare const operations: readonly [{
12220
12615
  readonly pathParams: readonly [{
12221
12616
  readonly name: "number";
12222
12617
  readonly sdkName: "number";
12618
+ readonly type: "integer";
12619
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12223
12620
  }, {
12224
12621
  readonly name: "n";
12225
12622
  readonly sdkName: "n";
12623
+ readonly type: "integer";
12624
+ readonly description: "Number of the other ticket in the relation or dependency.";
12226
12625
  }];
12227
12626
  readonly query: readonly [{
12228
12627
  readonly name: "repository";
@@ -12242,6 +12641,8 @@ export declare const operations: readonly [{
12242
12641
  readonly pathParams: readonly [{
12243
12642
  readonly name: "number";
12244
12643
  readonly sdkName: "number";
12644
+ readonly type: "integer";
12645
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12245
12646
  }];
12246
12647
  readonly query: readonly [{
12247
12648
  readonly name: "repository";
@@ -12271,6 +12672,8 @@ export declare const operations: readonly [{
12271
12672
  readonly pathParams: readonly [{
12272
12673
  readonly name: "number";
12273
12674
  readonly sdkName: "number";
12675
+ readonly type: "integer";
12676
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12274
12677
  }];
12275
12678
  readonly query: readonly [{
12276
12679
  readonly name: "repository";
@@ -12304,9 +12707,13 @@ export declare const operations: readonly [{
12304
12707
  readonly pathParams: readonly [{
12305
12708
  readonly name: "number";
12306
12709
  readonly sdkName: "number";
12710
+ readonly type: "integer";
12711
+ readonly description: "Ticket number shown by create and list (#12 is 12); not the tk_ id.";
12307
12712
  }, {
12308
12713
  readonly name: "child";
12309
12714
  readonly sdkName: "child";
12715
+ readonly type: "integer";
12716
+ readonly description: "Number of the sub-ticket to detach.";
12310
12717
  }];
12311
12718
  readonly query: readonly [{
12312
12719
  readonly name: "repository";
@@ -12389,6 +12796,7 @@ export declare const operations: readonly [{
12389
12796
  readonly pathParams: readonly [{
12390
12797
  readonly name: "authorization_id";
12391
12798
  readonly sdkName: "authorization_id";
12799
+ readonly description: "ID of the authorization in your account, returned when authorization is created.";
12392
12800
  }];
12393
12801
  readonly query: readonly [];
12394
12802
  }, {
@@ -12403,6 +12811,7 @@ export declare const operations: readonly [{
12403
12811
  readonly pathParams: readonly [{
12404
12812
  readonly name: "token";
12405
12813
  readonly sdkName: "token";
12814
+ readonly description: "One-time token from connect_url.";
12406
12815
  }];
12407
12816
  readonly query: readonly [];
12408
12817
  }, {
@@ -12417,6 +12826,7 @@ export declare const operations: readonly [{
12417
12826
  readonly pathParams: readonly [{
12418
12827
  readonly name: "token";
12419
12828
  readonly sdkName: "token";
12829
+ readonly description: "One-time token from connect_url.";
12420
12830
  }];
12421
12831
  readonly query: readonly [];
12422
12832
  }, {
@@ -12431,6 +12841,7 @@ export declare const operations: readonly [{
12431
12841
  readonly pathParams: readonly [{
12432
12842
  readonly name: "token";
12433
12843
  readonly sdkName: "token";
12844
+ readonly description: "One-time token from connect_url.";
12434
12845
  }];
12435
12846
  readonly query: readonly [];
12436
12847
  }, {
@@ -12550,6 +12961,7 @@ export declare const operations: readonly [{
12550
12961
  readonly pathParams: readonly [{
12551
12962
  readonly name: "vault_id";
12552
12963
  readonly sdkName: "vault_id";
12964
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12553
12965
  }];
12554
12966
  readonly query: readonly [];
12555
12967
  }, {
@@ -12564,6 +12976,7 @@ export declare const operations: readonly [{
12564
12976
  readonly pathParams: readonly [{
12565
12977
  readonly name: "vault_id";
12566
12978
  readonly sdkName: "vault_id";
12979
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12567
12980
  }];
12568
12981
  readonly query: readonly [];
12569
12982
  }, {
@@ -12578,6 +12991,7 @@ export declare const operations: readonly [{
12578
12991
  readonly pathParams: readonly [{
12579
12992
  readonly name: "vault_id";
12580
12993
  readonly sdkName: "vault_id";
12994
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12581
12995
  }];
12582
12996
  readonly query: readonly [];
12583
12997
  readonly body: {
@@ -12606,6 +13020,7 @@ export declare const operations: readonly [{
12606
13020
  readonly pathParams: readonly [{
12607
13021
  readonly name: "vault_id";
12608
13022
  readonly sdkName: "vault_id";
13023
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12609
13024
  }];
12610
13025
  readonly query: readonly [];
12611
13026
  }, {
@@ -12620,6 +13035,7 @@ export declare const operations: readonly [{
12620
13035
  readonly pathParams: readonly [{
12621
13036
  readonly name: "vault_id";
12622
13037
  readonly sdkName: "vault_id";
13038
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12623
13039
  }];
12624
13040
  readonly query: readonly [{
12625
13041
  readonly name: "secret";
@@ -12649,6 +13065,7 @@ export declare const operations: readonly [{
12649
13065
  readonly pathParams: readonly [{
12650
13066
  readonly name: "vault_id";
12651
13067
  readonly sdkName: "vault_id";
13068
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12652
13069
  }];
12653
13070
  readonly query: readonly [{
12654
13071
  readonly name: "cursor";
@@ -12678,6 +13095,7 @@ export declare const operations: readonly [{
12678
13095
  readonly pathParams: readonly [{
12679
13096
  readonly name: "vault_id";
12680
13097
  readonly sdkName: "vault_id";
13098
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12681
13099
  }];
12682
13100
  readonly query: readonly [];
12683
13101
  readonly body: {
@@ -12734,9 +13152,11 @@ export declare const operations: readonly [{
12734
13152
  readonly pathParams: readonly [{
12735
13153
  readonly name: "vault_id";
12736
13154
  readonly sdkName: "vault_id";
13155
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12737
13156
  }, {
12738
13157
  readonly name: "secret";
12739
13158
  readonly sdkName: "secret";
13159
+ readonly description: "Secret name, or its vsec_ ID.";
12740
13160
  }];
12741
13161
  readonly query: readonly [];
12742
13162
  }, {
@@ -12751,9 +13171,11 @@ export declare const operations: readonly [{
12751
13171
  readonly pathParams: readonly [{
12752
13172
  readonly name: "vault_id";
12753
13173
  readonly sdkName: "vault_id";
13174
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12754
13175
  }, {
12755
13176
  readonly name: "secret";
12756
13177
  readonly sdkName: "secret";
13178
+ readonly description: "Secret name, or its vsec_ ID.";
12757
13179
  }];
12758
13180
  readonly query: readonly [];
12759
13181
  }, {
@@ -12768,9 +13190,11 @@ export declare const operations: readonly [{
12768
13190
  readonly pathParams: readonly [{
12769
13191
  readonly name: "vault_id";
12770
13192
  readonly sdkName: "vault_id";
13193
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12771
13194
  }, {
12772
13195
  readonly name: "secret";
12773
13196
  readonly sdkName: "secret";
13197
+ readonly description: "Secret name, or its vsec_ ID.";
12774
13198
  }];
12775
13199
  readonly query: readonly [];
12776
13200
  readonly body: {
@@ -12810,9 +13234,11 @@ export declare const operations: readonly [{
12810
13234
  readonly pathParams: readonly [{
12811
13235
  readonly name: "vault_id";
12812
13236
  readonly sdkName: "vault_id";
13237
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12813
13238
  }, {
12814
13239
  readonly name: "secret";
12815
13240
  readonly sdkName: "secret";
13241
+ readonly description: "Secret name, or its vsec_ ID.";
12816
13242
  }];
12817
13243
  readonly query: readonly [];
12818
13244
  }, {
@@ -12827,9 +13253,11 @@ export declare const operations: readonly [{
12827
13253
  readonly pathParams: readonly [{
12828
13254
  readonly name: "vault_id";
12829
13255
  readonly sdkName: "vault_id";
13256
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12830
13257
  }, {
12831
13258
  readonly name: "secret";
12832
13259
  readonly sdkName: "secret";
13260
+ readonly description: "Secret name, or its vsec_ ID.";
12833
13261
  }];
12834
13262
  readonly query: readonly [];
12835
13263
  readonly body: {
@@ -12854,9 +13282,11 @@ export declare const operations: readonly [{
12854
13282
  readonly pathParams: readonly [{
12855
13283
  readonly name: "vault_id";
12856
13284
  readonly sdkName: "vault_id";
13285
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12857
13286
  }, {
12858
13287
  readonly name: "secret";
12859
13288
  readonly sdkName: "secret";
13289
+ readonly description: "Secret name, or its vsec_ ID.";
12860
13290
  }];
12861
13291
  readonly query: readonly [];
12862
13292
  }, {
@@ -12871,6 +13301,7 @@ export declare const operations: readonly [{
12871
13301
  readonly pathParams: readonly [{
12872
13302
  readonly name: "vault_id";
12873
13303
  readonly sdkName: "vault_id";
13304
+ readonly description: "ID of the vault in your account, returned when the vault is created.";
12874
13305
  }];
12875
13306
  readonly query: readonly [];
12876
13307
  readonly body: {