@deepraxis/cli 0.1.0-dev.ff6425a → 0.1.1-dev.69cffcf

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.
Files changed (3) hide show
  1. package/COMMANDS.md +9 -5
  2. package/dist/praxis.js +1174 -510
  3. package/package.json +1 -1
package/dist/praxis.js CHANGED
@@ -68,7 +68,7 @@ var operations = [
68
68
  resource: "agent.agents",
69
69
  method: "create",
70
70
  summary: "Create agent",
71
- 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"}]}.',
71
+ 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"}]}.`,
72
72
  http: "POST",
73
73
  path: "/agent/v1/agents",
74
74
  streaming: "no",
@@ -82,13 +82,13 @@ var operations = [
82
82
  name: "model",
83
83
  type: "object",
84
84
  required: true,
85
- 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"
85
+ 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."
86
86
  },
87
87
  {
88
88
  name: "name",
89
89
  type: "string",
90
90
  required: true,
91
- description: "Human-readable name for the agent."
91
+ 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."
92
92
  },
93
93
  {
94
94
  name: "description",
@@ -120,7 +120,7 @@ var operations = [
120
120
  type: "array",
121
121
  itemType: "object",
122
122
  required: false,
123
- 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."
123
+ 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.`
124
124
  },
125
125
  {
126
126
  name: "system",
@@ -141,7 +141,7 @@ across all toolsets allowed.`
141
141
  type: "array",
142
142
  itemType: "object",
143
143
  required: false,
144
- 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."
144
+ 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."
145
145
  },
146
146
  {
147
147
  name: "kind",
@@ -165,6 +165,12 @@ across all toolsets allowed.`
165
165
  required: false,
166
166
  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."
167
167
  },
168
+ {
169
+ name: "image_model",
170
+ type: "string",
171
+ required: false,
172
+ 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."
173
+ },
168
174
  {
169
175
  name: "subagents",
170
176
  type: "array",
@@ -228,7 +234,7 @@ across all toolsets allowed.`
228
234
  resource: "agent.agents",
229
235
  method: "retrieve",
230
236
  summary: "Get agent",
231
- 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.",
237
+ description: "Read one agent by id. The top level is the latest saved version, the editable head whose version you send back for optimistic concurrency; after a save with apply false it differs from active_version, and new sessions use active_version, which you read with version=active. With version, read a specific saved 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.",
232
238
  http: "GET",
233
239
  path: "/agent/v1/agents/{agent_id}",
234
240
  streaming: "no",
@@ -236,7 +242,8 @@ across all toolsets allowed.`
236
242
  pathParams: [
237
243
  {
238
244
  name: "agent_id",
239
- sdkName: "agent_id"
245
+ sdkName: "agent_id",
246
+ 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."
240
247
  }
241
248
  ],
242
249
  query: [
@@ -244,7 +251,7 @@ across all toolsets allowed.`
244
251
  name: "version",
245
252
  type: "number",
246
253
  required: false,
247
- description: "Agent version to read; omit for the latest. Integer of at least 1; versions are listed by agents.versions.list."
254
+ description: "Agent version to read; omit for the latest saved version. An integer of at least 1 (versions are listed by agents.versions.list), or the string active for the version new sessions use."
248
255
  }
249
256
  ]
250
257
  },
@@ -252,7 +259,7 @@ across all toolsets allowed.`
252
259
  resource: "agent.agents",
253
260
  method: "update",
254
261
  summary: "Update agent",
255
- 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.",
262
+ 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; null means no note, and a note sent when the request changes nothing else returns 400 because a note is stored only with a new 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.",
256
263
  http: "POST",
257
264
  path: "/agent/v1/agents/{agent_id}",
258
265
  streaming: "no",
@@ -260,7 +267,8 @@ across all toolsets allowed.`
260
267
  pathParams: [
261
268
  {
262
269
  name: "agent_id",
263
- sdkName: "agent_id"
270
+ sdkName: "agent_id",
271
+ 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."
264
272
  }
265
273
  ],
266
274
  query: [],
@@ -292,7 +300,7 @@ to 64 chars each) with values up to 512 chars.`
292
300
  name: "model",
293
301
  type: "object",
294
302
  required: false,
295
- 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."
303
+ 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."
296
304
  },
297
305
  {
298
306
  name: "multiagent",
@@ -304,15 +312,14 @@ to 64 chars each) with values up to 512 chars.`
304
312
  name: "name",
305
313
  type: "string",
306
314
  required: false,
307
- description: `Human-readable name. Must be non-empty. Omit to preserve. Cannot be
308
- cleared.`
315
+ 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."
309
316
  },
310
317
  {
311
318
  name: "skills",
312
319
  type: "array",
313
320
  itemType: "object",
314
321
  required: false,
315
- 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."
322
+ 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.`
316
323
  },
317
324
  {
318
325
  name: "system",
@@ -348,14 +355,14 @@ current version; omit to apply the update unconditionally.`
348
355
  name: "version_note",
349
356
  type: "string",
350
357
  required: false,
351
- 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."
358
+ description: "Optional change explanation stored as note on the new immutable version, up to 280 characters. Omission or null stores no note. A note sent when nothing else changes returns 400 (nothing to save), because a note is stored only with a new version."
352
359
  },
353
360
  {
354
361
  name: "bindings",
355
362
  type: "array",
356
363
  itemType: "object",
357
364
  required: false,
358
- 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."
365
+ 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."
359
366
  },
360
367
  {
361
368
  name: "kind",
@@ -379,6 +386,12 @@ current version; omit to apply the update unconditionally.`
379
386
  required: false,
380
387
  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."
381
388
  },
389
+ {
390
+ name: "image_model",
391
+ type: "string",
392
+ required: false,
393
+ 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."
394
+ },
382
395
  {
383
396
  name: "subagents",
384
397
  type: "array",
@@ -450,11 +463,168 @@ current version; omit to apply the update unconditionally.`
450
463
  pathParams: [
451
464
  {
452
465
  name: "agent_id",
453
- sdkName: "agent_id"
466
+ sdkName: "agent_id",
467
+ 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."
468
+ }
469
+ ],
470
+ query: []
471
+ },
472
+ {
473
+ resource: "agent.agents.customers.auth.accessTokens",
474
+ method: "create",
475
+ summary: "Create customer access token",
476
+ 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.
477
+
478
+ No 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_…"}.`,
479
+ http: "POST",
480
+ path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens",
481
+ streaming: "no",
482
+ pagination: false,
483
+ pathParams: [
484
+ {
485
+ name: "agent_id",
486
+ sdkName: "agent_id",
487
+ description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
488
+ }
489
+ ],
490
+ query: [],
491
+ body: {
492
+ required: true,
493
+ fields: []
494
+ }
495
+ },
496
+ {
497
+ resource: "agent.agents.customers.auth.accessTokens",
498
+ method: "deleteCurrent",
499
+ summary: "Log out customer",
500
+ description: `Log the customer out by revoking the sign-in of the presented access token and every token issued in it.
501
+
502
+ Send 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.`,
503
+ http: "DELETE",
504
+ path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current",
505
+ streaming: "no",
506
+ pagination: false,
507
+ pathParams: [
508
+ {
509
+ name: "agent_id",
510
+ sdkName: "agent_id",
511
+ description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
454
512
  }
455
513
  ],
456
514
  query: []
457
515
  },
516
+ {
517
+ resource: "agent.agents.customers.auth.accessTokens.renew",
518
+ method: "create",
519
+ summary: "Renew customer access token",
520
+ description: `Get a fresh customer access token in the same sign-in, authenticated with the current one.
521
+
522
+ Send 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.`,
523
+ http: "POST",
524
+ path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew",
525
+ streaming: "no",
526
+ pagination: false,
527
+ pathParams: [
528
+ {
529
+ name: "agent_id",
530
+ sdkName: "agent_id",
531
+ description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
532
+ }
533
+ ],
534
+ query: []
535
+ },
536
+ {
537
+ resource: "agent.agents.customers.auth.grantCodes",
538
+ method: "create",
539
+ summary: "Create customer grant code",
540
+ 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.
541
+
542
+ Call 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"}.`,
543
+ http: "POST",
544
+ path: "/agent/v1/agents/{agent_id}/customers/auth/grant_codes",
545
+ streaming: "no",
546
+ pagination: false,
547
+ pathParams: [
548
+ {
549
+ name: "agent_id",
550
+ sdkName: "agent_id",
551
+ description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
552
+ }
553
+ ],
554
+ query: [],
555
+ body: {
556
+ required: true,
557
+ fields: [
558
+ {
559
+ name: "customer_id",
560
+ type: "string",
561
+ required: true,
562
+ 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.'
563
+ },
564
+ {
565
+ name: "version",
566
+ type: "integer",
567
+ required: false,
568
+ description: "Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued."
569
+ },
570
+ {
571
+ name: "budget",
572
+ type: "object",
573
+ required: false,
574
+ 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."
575
+ },
576
+ {
577
+ name: "system_message",
578
+ type: "array",
579
+ itemType: "object",
580
+ required: false,
581
+ description: "Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total."
582
+ },
583
+ {
584
+ name: "agent_override",
585
+ type: "object",
586
+ required: false,
587
+ description: "Optional system prompt override, accepted only when the embed policy allows agent overrides."
588
+ },
589
+ {
590
+ name: "metadata",
591
+ type: "object",
592
+ required: false,
593
+ description: "Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved."
594
+ },
595
+ {
596
+ name: "origin",
597
+ type: "string",
598
+ required: false,
599
+ 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."
600
+ },
601
+ {
602
+ name: "expires_in",
603
+ type: "integer",
604
+ required: false,
605
+ description: "Seconds the code stays redeemable, from 60 to 86400. Defaults to 900."
606
+ },
607
+ {
608
+ name: "max_session_seconds",
609
+ type: "integer",
610
+ required: false,
611
+ 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."
612
+ },
613
+ {
614
+ name: "anonymous_access_token",
615
+ type: "string",
616
+ required: false,
617
+ 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."
618
+ },
619
+ {
620
+ name: "hosted",
621
+ type: "boolean",
622
+ required: false,
623
+ 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."
624
+ }
625
+ ]
626
+ }
627
+ },
458
628
  {
459
629
  resource: "agent.agents.endUsers",
460
630
  method: "list",
@@ -469,7 +639,8 @@ Ordered by last_active_at and external_user_id descending. q is a case-sensitive
469
639
  pathParams: [
470
640
  {
471
641
  name: "agent_id",
472
- sdkName: "agent_id"
642
+ sdkName: "agent_id",
643
+ description: "Active service agent identifier from agent creation or listing."
473
644
  }
474
645
  ],
475
646
  query: [
@@ -507,11 +678,13 @@ Develop only. Set confirm to the exact external_user_id; missing or mismatched c
507
678
  pathParams: [
508
679
  {
509
680
  name: "agent_id",
510
- sdkName: "agent_id"
681
+ sdkName: "agent_id",
682
+ description: "Active service agent identifier from agent creation or listing."
511
683
  },
512
684
  {
513
685
  name: "external_user_id",
514
- sdkName: "external_user_id"
686
+ sdkName: "external_user_id",
687
+ description: "Host user identifier supplied at issuance or from end-user listing."
515
688
  }
516
689
  ],
517
690
  query: [
@@ -537,11 +710,13 @@ Use external_user_id from listing or your host application. Users without sessio
537
710
  pathParams: [
538
711
  {
539
712
  name: "agent_id",
540
- sdkName: "agent_id"
713
+ sdkName: "agent_id",
714
+ description: "Active service agent identifier from agent creation or listing."
541
715
  },
542
716
  {
543
717
  name: "external_user_id",
544
- sdkName: "external_user_id"
718
+ sdkName: "external_user_id",
719
+ description: "Host user identifier supplied at issuance or from end-user listing."
545
720
  }
546
721
  ],
547
722
  query: []
@@ -560,11 +735,13 @@ May block a user before any history exists; timestamps are then null and counts
560
735
  pathParams: [
561
736
  {
562
737
  name: "agent_id",
563
- sdkName: "agent_id"
738
+ sdkName: "agent_id",
739
+ description: "Active service agent identifier from agent creation or listing."
564
740
  },
565
741
  {
566
742
  name: "external_user_id",
567
- sdkName: "external_user_id"
743
+ sdkName: "external_user_id",
744
+ description: "Host user identifier supplied at issuance or from end-user listing."
568
745
  }
569
746
  ],
570
747
  query: []
@@ -583,11 +760,13 @@ Use the same agent_id and external_user_id as the confirmed DELETE. Status is pe
583
760
  pathParams: [
584
761
  {
585
762
  name: "agent_id",
586
- sdkName: "agent_id"
763
+ sdkName: "agent_id",
764
+ description: "Active service agent identifier from agent creation or listing."
587
765
  },
588
766
  {
589
767
  name: "external_user_id",
590
- sdkName: "external_user_id"
768
+ sdkName: "external_user_id",
769
+ description: "Host user identifier supplied at issuance or from end-user listing."
591
770
  }
592
771
  ],
593
772
  query: []
@@ -606,11 +785,13 @@ Revokes credentials before marking grants revoked. Upstream failure returns 502
606
785
  pathParams: [
607
786
  {
608
787
  name: "agent_id",
609
- sdkName: "agent_id"
788
+ sdkName: "agent_id",
789
+ description: "Active service agent identifier from agent creation or listing."
610
790
  },
611
791
  {
612
792
  name: "external_user_id",
613
- sdkName: "external_user_id"
793
+ sdkName: "external_user_id",
794
+ description: "Host user identifier supplied at issuance or from end-user listing."
614
795
  }
615
796
  ],
616
797
  query: []
@@ -629,11 +810,13 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
629
810
  pathParams: [
630
811
  {
631
812
  name: "agent_id",
632
- sdkName: "agent_id"
813
+ sdkName: "agent_id",
814
+ description: "Active service agent identifier from agent creation or listing."
633
815
  },
634
816
  {
635
817
  name: "external_user_id",
636
- sdkName: "external_user_id"
818
+ sdkName: "external_user_id",
819
+ description: "Host user identifier supplied at issuance or from end-user listing."
637
820
  }
638
821
  ],
639
822
  query: []
@@ -650,7 +833,8 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
650
833
  pathParams: [
651
834
  {
652
835
  name: "agent_id",
653
- sdkName: "agent_id"
836
+ sdkName: "agent_id",
837
+ description: "Agent id from creation or listing."
654
838
  }
655
839
  ],
656
840
  query: []
@@ -659,7 +843,7 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
659
843
  resource: "agent.agents.versions",
660
844
  method: "list",
661
845
  summary: "List agent versions",
662
- 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.",
846
+ 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. active is true only for the item that new sessions use; active_version on each item is the agent-level value, kept for compatibility. Use agents.retrieve with version to read a single one; agent_id comes from agents.list or agents.create.",
663
847
  http: "GET",
664
848
  path: "/agent/v1/agents/{agent_id}/versions",
665
849
  streaming: "no",
@@ -667,7 +851,8 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
667
851
  pathParams: [
668
852
  {
669
853
  name: "agent_id",
670
- sdkName: "agent_id"
854
+ sdkName: "agent_id",
855
+ 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."
671
856
  }
672
857
  ],
673
858
  query: [
@@ -697,11 +882,14 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
697
882
  pathParams: [
698
883
  {
699
884
  name: "agent_id",
700
- sdkName: "agent_id"
885
+ sdkName: "agent_id",
886
+ description: "Agent identifier from agents.create or agents.list."
701
887
  },
702
888
  {
703
889
  name: "version",
704
- sdkName: "version"
890
+ sdkName: "version",
891
+ type: "integer",
892
+ description: "Existing version number from agents.versions.list to use for new sessions and tokens."
705
893
  }
706
894
  ],
707
895
  query: []
@@ -709,8 +897,8 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
709
897
  {
710
898
  resource: "agent.computers",
711
899
  method: "list",
712
- summary: "ComputersList",
713
- description: `Tenant-owned durable computer resource.
900
+ summary: "List Computers",
901
+ description: `List the computers of your organization, archived ones included.
714
902
 
715
903
  Praxis 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.`,
716
904
  http: "GET",
@@ -736,8 +924,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
736
924
  {
737
925
  resource: "agent.computers",
738
926
  method: "create",
739
- summary: "ComputersCreate",
740
- description: `Tenant-owned durable computer resource.
927
+ summary: "Create Computer",
928
+ description: `Create a durable computer: a named machine whose files outlive sessions, for personal agents.
741
929
 
742
930
  Praxis 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.`,
743
931
  http: "POST",
@@ -778,7 +966,8 @@ Own-face superset: Managed Agents has no persistent Computer deletion lifecycle.
778
966
  pathParams: [
779
967
  {
780
968
  name: "computer_id",
781
- sdkName: "computer_id"
969
+ sdkName: "computer_id",
970
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
782
971
  }
783
972
  ],
784
973
  query: []
@@ -786,8 +975,8 @@ Own-face superset: Managed Agents has no persistent Computer deletion lifecycle.
786
975
  {
787
976
  resource: "agent.computers",
788
977
  method: "retrieve",
789
- summary: "ComputersRetrieve",
790
- description: `Tenant-owned durable computer resource.
978
+ summary: "Get Computer",
979
+ description: `Read one computer's status, storage use and sandbox id.
791
980
 
792
981
  Praxis 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.`,
793
982
  http: "GET",
@@ -797,7 +986,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
797
986
  pathParams: [
798
987
  {
799
988
  name: "computer_id",
800
- sdkName: "computer_id"
989
+ sdkName: "computer_id",
990
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
801
991
  }
802
992
  ],
803
993
  query: []
@@ -805,8 +995,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
805
995
  {
806
996
  resource: "agent.computers",
807
997
  method: "update",
808
- summary: "ComputersUpdate",
809
- description: `Tenant-owned durable computer resource.
998
+ summary: "Update Computer",
999
+ description: `Rename a computer.
810
1000
 
811
1001
  Praxis 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.`,
812
1002
  http: "POST",
@@ -816,7 +1006,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
816
1006
  pathParams: [
817
1007
  {
818
1008
  name: "computer_id",
819
- sdkName: "computer_id"
1009
+ sdkName: "computer_id",
1010
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
820
1011
  }
821
1012
  ],
822
1013
  query: [],
@@ -835,8 +1026,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
835
1026
  {
836
1027
  resource: "agent.computers",
837
1028
  method: "archive",
838
- summary: "ComputersArchive",
839
- description: `Tenant-owned durable computer resource.
1029
+ summary: "Archive Computer",
1030
+ description: `Archive a computer: its files stay readable but new sessions cannot use it.
840
1031
 
841
1032
  Praxis 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.`,
842
1033
  http: "POST",
@@ -846,7 +1037,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
846
1037
  pathParams: [
847
1038
  {
848
1039
  name: "computer_id",
849
- sdkName: "computer_id"
1040
+ sdkName: "computer_id",
1041
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
850
1042
  }
851
1043
  ],
852
1044
  query: []
@@ -865,7 +1057,8 @@ Own-face superset: Managed Agents has no persistent Computer attachment director
865
1057
  pathParams: [
866
1058
  {
867
1059
  name: "computer_id",
868
- sdkName: "computer_id"
1060
+ sdkName: "computer_id",
1061
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
869
1062
  }
870
1063
  ],
871
1064
  query: [
@@ -897,7 +1090,8 @@ Connect to a computer with a caller-held lease. Omit the body or send {} to requ
897
1090
  pathParams: [
898
1091
  {
899
1092
  name: "computer_id",
900
- sdkName: "computer_id"
1093
+ sdkName: "computer_id",
1094
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
901
1095
  }
902
1096
  ],
903
1097
  query: [],
@@ -920,8 +1114,8 @@ Connect to a computer with a caller-held lease. Omit the body or send {} to requ
920
1114
  {
921
1115
  resource: "agent.computers.files",
922
1116
  method: "list",
923
- summary: "ComputersFilesList",
924
- description: `Tenant-owned durable computer resource.
1117
+ summary: "List Computer Files",
1118
+ description: `List the entries of one directory on a computer.
925
1119
 
926
1120
  Praxis 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.`,
927
1121
  http: "GET",
@@ -931,7 +1125,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
931
1125
  pathParams: [
932
1126
  {
933
1127
  name: "computer_id",
934
- sdkName: "computer_id"
1128
+ sdkName: "computer_id",
1129
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
935
1130
  }
936
1131
  ],
937
1132
  query: [
@@ -946,8 +1141,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
946
1141
  {
947
1142
  resource: "agent.computers.files",
948
1143
  method: "retrieveContent",
949
- summary: "ComputersFilesContent",
950
- description: `Tenant-owned durable computer resource.
1144
+ summary: "Get Computer File Content",
1145
+ description: `Download the bytes of one file on a computer, up to 16 MiB, with single-range support.
951
1146
 
952
1147
  Praxis 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.`,
953
1148
  http: "GET",
@@ -957,7 +1152,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
957
1152
  pathParams: [
958
1153
  {
959
1154
  name: "computer_id",
960
- sdkName: "computer_id"
1155
+ sdkName: "computer_id",
1156
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
961
1157
  }
962
1158
  ],
963
1159
  query: [
@@ -983,11 +1179,13 @@ Own-face extension. Idempotent: an unknown or already released lease succeeds as
983
1179
  pathParams: [
984
1180
  {
985
1181
  name: "computer_id",
986
- sdkName: "computer_id"
1182
+ sdkName: "computer_id",
1183
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
987
1184
  },
988
1185
  {
989
1186
  name: "lease_id",
990
- sdkName: "lease_id"
1187
+ sdkName: "lease_id",
1188
+ description: "lease_id from the connect response."
991
1189
  }
992
1190
  ],
993
1191
  query: []
@@ -1006,11 +1204,13 @@ Own-face extension. A lease that is no longer valid (released, expired, or the c
1006
1204
  pathParams: [
1007
1205
  {
1008
1206
  name: "computer_id",
1009
- sdkName: "computer_id"
1207
+ sdkName: "computer_id",
1208
+ description: "Computer id (cmp_...), as returned by computers.create or computers.list."
1010
1209
  },
1011
1210
  {
1012
1211
  name: "lease_id",
1013
- sdkName: "lease_id"
1212
+ sdkName: "lease_id",
1213
+ description: "lease_id from the connect response."
1014
1214
  }
1015
1215
  ],
1016
1216
  query: []
@@ -1102,7 +1302,8 @@ Own-face extension. A lease that is no longer valid (released, expired, or the c
1102
1302
  pathParams: [
1103
1303
  {
1104
1304
  name: "deployment_run_id",
1105
- sdkName: "deployment_run_id"
1305
+ sdkName: "deployment_run_id",
1306
+ description: "Deployment run id (drun_...), returned by deployments.run or deployment_runs.list."
1106
1307
  }
1107
1308
  ],
1108
1309
  query: []
@@ -1273,7 +1474,8 @@ created from this deployment. Maximum 50.`
1273
1474
  pathParams: [
1274
1475
  {
1275
1476
  name: "deployment_id",
1276
- sdkName: "deployment_id"
1477
+ sdkName: "deployment_id",
1478
+ description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
1277
1479
  }
1278
1480
  ],
1279
1481
  query: []
@@ -1290,7 +1492,8 @@ created from this deployment. Maximum 50.`
1290
1492
  pathParams: [
1291
1493
  {
1292
1494
  name: "deployment_id",
1293
- sdkName: "deployment_id"
1495
+ sdkName: "deployment_id",
1496
+ description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
1294
1497
  }
1295
1498
  ],
1296
1499
  query: [],
@@ -1388,7 +1591,8 @@ null to clear. Maximum 50.`
1388
1591
  pathParams: [
1389
1592
  {
1390
1593
  name: "deployment_id",
1391
- sdkName: "deployment_id"
1594
+ sdkName: "deployment_id",
1595
+ description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
1392
1596
  }
1393
1597
  ],
1394
1598
  query: []
@@ -1405,7 +1609,8 @@ null to clear. Maximum 50.`
1405
1609
  pathParams: [
1406
1610
  {
1407
1611
  name: "deployment_id",
1408
- sdkName: "deployment_id"
1612
+ sdkName: "deployment_id",
1613
+ description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
1409
1614
  }
1410
1615
  ],
1411
1616
  query: []
@@ -1422,7 +1627,8 @@ null to clear. Maximum 50.`
1422
1627
  pathParams: [
1423
1628
  {
1424
1629
  name: "deployment_id",
1425
- sdkName: "deployment_id"
1630
+ sdkName: "deployment_id",
1631
+ description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
1426
1632
  }
1427
1633
  ],
1428
1634
  query: []
@@ -1439,7 +1645,8 @@ null to clear. Maximum 50.`
1439
1645
  pathParams: [
1440
1646
  {
1441
1647
  name: "deployment_id",
1442
- sdkName: "deployment_id"
1648
+ sdkName: "deployment_id",
1649
+ description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
1443
1650
  }
1444
1651
  ],
1445
1652
  query: []
@@ -1646,7 +1853,8 @@ Use an id from issuance or listing. Revokes the credential before setting revoke
1646
1853
  pathParams: [
1647
1854
  {
1648
1855
  name: "id",
1649
- sdkName: "id"
1856
+ sdkName: "id",
1857
+ description: "Grant id returned by issuance or listing."
1650
1858
  }
1651
1859
  ],
1652
1860
  query: []
@@ -1690,7 +1898,7 @@ Use an id from issuance or listing. Revokes the credential before setting revoke
1690
1898
  resource: "agent.environments",
1691
1899
  method: "create",
1692
1900
  summary: "Create environment",
1693
- 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.",
1901
+ 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.",
1694
1902
  http: "POST",
1695
1903
  path: "/agent/v1/environments",
1696
1904
  streaming: "no",
@@ -1723,19 +1931,6 @@ Use an id from issuance or listing. Revokes the credential before setting revoke
1723
1931
  type: "object",
1724
1932
  required: false,
1725
1933
  description: "Free-form string key/value pairs."
1726
- },
1727
- {
1728
- name: "scope",
1729
- type: "string",
1730
- enum: [
1731
- "organization",
1732
- "account"
1733
- ],
1734
- required: false,
1735
- description: `The visibility scope for this environment. 'organization' makes the
1736
- environment visible to all accounts. 'account' restricts visibility to the
1737
- owning account only. API organizations support only 'organization'; 'account' is
1738
- rejected. If not specified, defaults based on organization type.`
1739
1934
  }
1740
1935
  ]
1741
1936
  }
@@ -1752,7 +1947,8 @@ rejected. If not specified, defaults based on organization type.`
1752
1947
  pathParams: [
1753
1948
  {
1754
1949
  name: "environment_id",
1755
- sdkName: "environment_id"
1950
+ sdkName: "environment_id",
1951
+ description: "Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed."
1756
1952
  }
1757
1953
  ],
1758
1954
  query: []
@@ -1761,7 +1957,7 @@ rejected. If not specified, defaults based on organization type.`
1761
1957
  resource: "agent.environments",
1762
1958
  method: "update",
1763
1959
  summary: "Update environment",
1764
- 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.",
1960
+ 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.",
1765
1961
  http: "POST",
1766
1962
  path: "/agent/v1/environments/{environment_id}",
1767
1963
  streaming: "no",
@@ -1769,7 +1965,8 @@ rejected. If not specified, defaults based on organization type.`
1769
1965
  pathParams: [
1770
1966
  {
1771
1967
  name: "environment_id",
1772
- sdkName: "environment_id"
1968
+ sdkName: "environment_id",
1969
+ description: "Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed."
1773
1970
  }
1774
1971
  ],
1775
1972
  query: [],
@@ -1800,18 +1997,6 @@ clears to null; an empty string is stored as an empty string.`
1800
1997
  type: "string",
1801
1998
  required: false,
1802
1999
  description: "Updated name for the environment"
1803
- },
1804
- {
1805
- name: "scope",
1806
- type: "string",
1807
- enum: [
1808
- "organization",
1809
- "account"
1810
- ],
1811
- required: false,
1812
- description: `The visibility scope for this environment. 'organization' makes the
1813
- environment visible to all accounts. 'account' restricts visibility to the
1814
- owning account only.`
1815
2000
  }
1816
2001
  ]
1817
2002
  }
@@ -1820,7 +2005,7 @@ owning account only.`
1820
2005
  resource: "agent.environments",
1821
2006
  method: "archive",
1822
2007
  summary: "Archive environment",
1823
- 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.",
2008
+ 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.",
1824
2009
  http: "POST",
1825
2010
  path: "/agent/v1/environments/{environment_id}/archive",
1826
2011
  streaming: "no",
@@ -1828,7 +2013,8 @@ owning account only.`
1828
2013
  pathParams: [
1829
2014
  {
1830
2015
  name: "environment_id",
1831
- sdkName: "environment_id"
2016
+ sdkName: "environment_id",
2017
+ description: "Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed."
1832
2018
  }
1833
2019
  ],
1834
2020
  query: []
@@ -1837,7 +2023,7 @@ owning account only.`
1837
2023
  resource: "agent.sessions",
1838
2024
  method: "list",
1839
2025
  summary: "List sessions",
1840
- 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.",
2026
+ 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.",
1841
2027
  http: "GET",
1842
2028
  path: "/agent/v1/sessions",
1843
2029
  streaming: "no",
@@ -1866,7 +2052,7 @@ owning account only.`
1866
2052
  name: "created_at[gte]",
1867
2053
  type: "string",
1868
2054
  required: false,
1869
- 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."
2055
+ 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."
1870
2056
  },
1871
2057
  {
1872
2058
  name: "created_at[lt]",
@@ -1878,7 +2064,7 @@ owning account only.`
1878
2064
  name: "created_at[lte]",
1879
2065
  type: "string",
1880
2066
  required: false,
1881
- 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."
2067
+ 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."
1882
2068
  },
1883
2069
  {
1884
2070
  name: "deployment_id",
@@ -1894,7 +2080,7 @@ owning account only.`
1894
2080
  true
1895
2081
  ],
1896
2082
  required: false,
1897
- description: "Declared by the Managed Agents shape but not supported by sessions.list; sending it returns 400. Archived sessions are retrievable by id."
2083
+ 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."
1898
2084
  },
1899
2085
  {
1900
2086
  name: "memory_store_id",
@@ -1962,7 +2148,7 @@ owning account only.`
1962
2148
  resource: "agent.sessions",
1963
2149
  method: "create",
1964
2150
  summary: "Create session",
1965
- 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.`,
2151
+ 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.`,
1966
2152
  http: "POST",
1967
2153
  path: "/agent/v1/sessions",
1968
2154
  streaming: "no",
@@ -1976,19 +2162,19 @@ owning account only.`
1976
2162
  name: "agent",
1977
2163
  type: "object",
1978
2164
  required: true,
1979
- 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."
2165
+ 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.`
1980
2166
  },
1981
2167
  {
1982
2168
  name: "environment_id",
1983
2169
  type: "string",
1984
2170
  required: false,
1985
- 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."
2171
+ 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."
1986
2172
  },
1987
2173
  {
1988
2174
  name: "budget",
1989
2175
  type: "object",
1990
2176
  required: false,
1991
- 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."
2177
+ 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.'
1992
2178
  },
1993
2179
  {
1994
2180
  name: "initial_events",
@@ -2074,7 +2260,8 @@ offsets ("+08:00") and unknown names return 400. Never stored in
2074
2260
  pathParams: [
2075
2261
  {
2076
2262
  name: "session_id",
2077
- sdkName: "session_id"
2263
+ sdkName: "session_id",
2264
+ 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."
2078
2265
  }
2079
2266
  ],
2080
2267
  query: []
@@ -2091,7 +2278,8 @@ offsets ("+08:00") and unknown names return 400. Never stored in
2091
2278
  pathParams: [
2092
2279
  {
2093
2280
  name: "session_id",
2094
- sdkName: "session_id"
2281
+ sdkName: "session_id",
2282
+ 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."
2095
2283
  }
2096
2284
  ],
2097
2285
  query: []
@@ -2108,19 +2296,14 @@ offsets ("+08:00") and unknown names return 400. Never stored in
2108
2296
  pathParams: [
2109
2297
  {
2110
2298
  name: "session_id",
2111
- sdkName: "session_id"
2299
+ sdkName: "session_id",
2300
+ 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."
2112
2301
  }
2113
2302
  ],
2114
2303
  query: [],
2115
2304
  body: {
2116
2305
  required: true,
2117
2306
  fields: [
2118
- {
2119
- name: "agent",
2120
- type: "object",
2121
- required: false,
2122
- description: "Agent definition the session uses after the change; null when unchanged."
2123
- },
2124
2307
  {
2125
2308
  name: "budget",
2126
2309
  type: "object",
@@ -2174,7 +2357,8 @@ delete it. Omit the field to preserve.`
2174
2357
  pathParams: [
2175
2358
  {
2176
2359
  name: "session_id",
2177
- sdkName: "session_id"
2360
+ sdkName: "session_id",
2361
+ 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."
2178
2362
  }
2179
2363
  ],
2180
2364
  query: []
@@ -2193,7 +2377,8 @@ Own-face extension. Returns { data: BackgroundTask[] }. Each task has id, kind,
2193
2377
  pathParams: [
2194
2378
  {
2195
2379
  name: "session_id",
2196
- sdkName: "session_id"
2380
+ sdkName: "session_id",
2381
+ 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."
2197
2382
  }
2198
2383
  ],
2199
2384
  query: []
@@ -2212,11 +2397,13 @@ Own-face extension. offset defaults to 0; max_bytes defaults to 65536 and must b
2212
2397
  pathParams: [
2213
2398
  {
2214
2399
  name: "session_id",
2215
- sdkName: "session_id"
2400
+ sdkName: "session_id",
2401
+ 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."
2216
2402
  },
2217
2403
  {
2218
2404
  name: "task_id",
2219
- sdkName: "task_id"
2405
+ sdkName: "task_id",
2406
+ description: "Background task id (task_...), as listed by sessions.background_tasks.list."
2220
2407
  }
2221
2408
  ],
2222
2409
  query: [
@@ -2248,11 +2435,13 @@ Own-face extension. No request body is required. Uses the same stop implementati
2248
2435
  pathParams: [
2249
2436
  {
2250
2437
  name: "session_id",
2251
- sdkName: "session_id"
2438
+ sdkName: "session_id",
2439
+ 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."
2252
2440
  },
2253
2441
  {
2254
2442
  name: "task_id",
2255
- sdkName: "task_id"
2443
+ sdkName: "task_id",
2444
+ description: "Background task id (task_...), as listed by sessions.background_tasks.list."
2256
2445
  }
2257
2446
  ],
2258
2447
  query: []
@@ -2271,7 +2460,8 @@ Available only on /agent/v1. The body may be omitted or {}. Optional instruction
2271
2460
  pathParams: [
2272
2461
  {
2273
2462
  name: "session_id",
2274
- sdkName: "session_id"
2463
+ sdkName: "session_id",
2464
+ 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."
2275
2465
  }
2276
2466
  ],
2277
2467
  query: [],
@@ -2301,11 +2491,13 @@ Available only on /agent/v1. Returns { type: session_compaction, id, status, rea
2301
2491
  pathParams: [
2302
2492
  {
2303
2493
  name: "session_id",
2304
- sdkName: "session_id"
2494
+ sdkName: "session_id",
2495
+ 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."
2305
2496
  },
2306
2497
  {
2307
2498
  name: "operation_id",
2308
- sdkName: "operation_id"
2499
+ sdkName: "operation_id",
2500
+ description: "Compaction operation id returned by sessions.compact in the id field of the session_compaction object."
2309
2501
  }
2310
2502
  ],
2311
2503
  query: []
@@ -2324,7 +2516,8 @@ Available only on /agent/v1. Returns { data: [...] }. Each entry contains type,
2324
2516
  pathParams: [
2325
2517
  {
2326
2518
  name: "session_id",
2327
- sdkName: "session_id"
2519
+ sdkName: "session_id",
2520
+ 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."
2328
2521
  }
2329
2522
  ],
2330
2523
  query: []
@@ -2343,7 +2536,8 @@ Praxis extension available only on /agent/v1, following Claude Agent SDK getCont
2343
2536
  pathParams: [
2344
2537
  {
2345
2538
  name: "session_id",
2346
- sdkName: "session_id"
2539
+ sdkName: "session_id",
2540
+ 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."
2347
2541
  }
2348
2542
  ],
2349
2543
  query: []
@@ -2360,7 +2554,8 @@ Praxis extension available only on /agent/v1, following Claude Agent SDK getCont
2360
2554
  pathParams: [
2361
2555
  {
2362
2556
  name: "session_id",
2363
- sdkName: "session_id"
2557
+ sdkName: "session_id",
2558
+ 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."
2364
2559
  }
2365
2560
  ],
2366
2561
  query: [
@@ -2431,7 +2626,8 @@ Praxis extension available only on /agent/v1, following Claude Agent SDK getCont
2431
2626
  pathParams: [
2432
2627
  {
2433
2628
  name: "session_id",
2434
- sdkName: "session_id"
2629
+ sdkName: "session_id",
2630
+ 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."
2435
2631
  }
2436
2632
  ],
2437
2633
  query: [],
@@ -2460,7 +2656,8 @@ Praxis extension available only on /agent/v1, following Claude Agent SDK getCont
2460
2656
  pathParams: [
2461
2657
  {
2462
2658
  name: "session_id",
2463
- sdkName: "session_id"
2659
+ sdkName: "session_id",
2660
+ 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."
2464
2661
  }
2465
2662
  ],
2466
2663
  query: [
@@ -2491,7 +2688,8 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
2491
2688
  pathParams: [
2492
2689
  {
2493
2690
  name: "session_id",
2494
- sdkName: "session_id"
2691
+ sdkName: "session_id",
2692
+ 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."
2495
2693
  }
2496
2694
  ],
2497
2695
  query: [],
@@ -2519,7 +2717,8 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
2519
2717
  pathParams: [
2520
2718
  {
2521
2719
  name: "session_id",
2522
- sdkName: "session_id"
2720
+ sdkName: "session_id",
2721
+ 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."
2523
2722
  }
2524
2723
  ],
2525
2724
  query: [
@@ -2549,7 +2748,8 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
2549
2748
  pathParams: [
2550
2749
  {
2551
2750
  name: "session_id",
2552
- sdkName: "session_id"
2751
+ sdkName: "session_id",
2752
+ 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."
2553
2753
  }
2554
2754
  ],
2555
2755
  query: [
@@ -2593,11 +2793,13 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
2593
2793
  pathParams: [
2594
2794
  {
2595
2795
  name: "session_id",
2596
- sdkName: "session_id"
2796
+ sdkName: "session_id",
2797
+ 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."
2597
2798
  },
2598
2799
  {
2599
2800
  name: "resource_id",
2600
- sdkName: "resource_id"
2801
+ sdkName: "resource_id",
2802
+ description: "Id of a resource attached to the session, as returned by sessions.resources.add or sessions.resources.list."
2601
2803
  }
2602
2804
  ],
2603
2805
  query: [
@@ -2622,11 +2824,13 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
2622
2824
  pathParams: [
2623
2825
  {
2624
2826
  name: "session_id",
2625
- sdkName: "session_id"
2827
+ sdkName: "session_id",
2828
+ 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."
2626
2829
  },
2627
2830
  {
2628
2831
  name: "resource_id",
2629
- sdkName: "resource_id"
2832
+ sdkName: "resource_id",
2833
+ description: "Id of a resource attached to the session, as returned by sessions.resources.add or sessions.resources.list."
2630
2834
  }
2631
2835
  ],
2632
2836
  query: [
@@ -2653,11 +2857,13 @@ Own-face extension. Use the session id from session creation or listing and the
2653
2857
  pathParams: [
2654
2858
  {
2655
2859
  name: "session_id",
2656
- sdkName: "session_id"
2860
+ sdkName: "session_id",
2861
+ description: "Session id from session creation or listing."
2657
2862
  },
2658
2863
  {
2659
2864
  name: "run_id",
2660
- sdkName: "run_id"
2865
+ sdkName: "run_id",
2866
+ description: "Existing run_id from this session's events."
2661
2867
  }
2662
2868
  ],
2663
2869
  query: []
@@ -2676,11 +2882,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
2676
2882
  pathParams: [
2677
2883
  {
2678
2884
  name: "session_id",
2679
- sdkName: "session_id"
2885
+ sdkName: "session_id",
2886
+ description: "Session id from session creation or listing."
2680
2887
  },
2681
2888
  {
2682
2889
  name: "run_id",
2683
- sdkName: "run_id"
2890
+ sdkName: "run_id",
2891
+ description: "Existing run_id from this session's events."
2684
2892
  }
2685
2893
  ],
2686
2894
  query: [],
@@ -2718,7 +2926,8 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
2718
2926
  pathParams: [
2719
2927
  {
2720
2928
  name: "session_id",
2721
- sdkName: "session_id"
2929
+ sdkName: "session_id",
2930
+ 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."
2722
2931
  }
2723
2932
  ],
2724
2933
  query: [
@@ -2748,11 +2957,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
2748
2957
  pathParams: [
2749
2958
  {
2750
2959
  name: "session_id",
2751
- sdkName: "session_id"
2960
+ sdkName: "session_id",
2961
+ 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."
2752
2962
  },
2753
2963
  {
2754
2964
  name: "thread_id",
2755
- sdkName: "thread_id"
2965
+ sdkName: "thread_id",
2966
+ 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."
2756
2967
  }
2757
2968
  ],
2758
2969
  query: [
@@ -2777,11 +2988,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
2777
2988
  pathParams: [
2778
2989
  {
2779
2990
  name: "session_id",
2780
- sdkName: "session_id"
2991
+ sdkName: "session_id",
2992
+ 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."
2781
2993
  },
2782
2994
  {
2783
2995
  name: "thread_id",
2784
- sdkName: "thread_id"
2996
+ sdkName: "thread_id",
2997
+ 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."
2785
2998
  }
2786
2999
  ],
2787
3000
  query: [
@@ -2806,11 +3019,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
2806
3019
  pathParams: [
2807
3020
  {
2808
3021
  name: "session_id",
2809
- sdkName: "session_id"
3022
+ sdkName: "session_id",
3023
+ 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."
2810
3024
  },
2811
3025
  {
2812
3026
  name: "thread_id",
2813
- sdkName: "thread_id"
3027
+ sdkName: "thread_id",
3028
+ 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."
2814
3029
  }
2815
3030
  ],
2816
3031
  query: [
@@ -2847,11 +3062,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
2847
3062
  pathParams: [
2848
3063
  {
2849
3064
  name: "session_id",
2850
- sdkName: "session_id"
3065
+ sdkName: "session_id",
3066
+ 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."
2851
3067
  },
2852
3068
  {
2853
3069
  name: "thread_id",
2854
- sdkName: "thread_id"
3070
+ sdkName: "thread_id",
3071
+ 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."
2855
3072
  }
2856
3073
  ],
2857
3074
  query: [
@@ -2915,7 +3132,7 @@ If provided, only skills from the specified source will be returned:
2915
3132
  resource: "agent.skills",
2916
3133
  method: "create",
2917
3134
  summary: "Create skill",
2918
- 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.",
3135
+ 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.',
2919
3136
  http: "POST",
2920
3137
  path: "/agent/v1/skills",
2921
3138
  streaming: "no",
@@ -2949,7 +3166,7 @@ file at the root of that directory.`
2949
3166
  resource: "agent.skills",
2950
3167
  method: "delete",
2951
3168
  summary: "Delete skill",
2952
- 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.",
3169
+ 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.",
2953
3170
  http: "DELETE",
2954
3171
  path: "/agent/v1/skills/{skill_id}",
2955
3172
  streaming: "no",
@@ -2957,7 +3174,8 @@ file at the root of that directory.`
2957
3174
  pathParams: [
2958
3175
  {
2959
3176
  name: "skill_id",
2960
- sdkName: "skill_id"
3177
+ sdkName: "skill_id",
3178
+ description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
2961
3179
  }
2962
3180
  ],
2963
3181
  query: []
@@ -2974,7 +3192,8 @@ file at the root of that directory.`
2974
3192
  pathParams: [
2975
3193
  {
2976
3194
  name: "skill_id",
2977
- sdkName: "skill_id"
3195
+ sdkName: "skill_id",
3196
+ description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
2978
3197
  }
2979
3198
  ],
2980
3199
  query: []
@@ -2991,7 +3210,8 @@ file at the root of that directory.`
2991
3210
  pathParams: [
2992
3211
  {
2993
3212
  name: "skill_id",
2994
- sdkName: "skill_id"
3213
+ sdkName: "skill_id",
3214
+ description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
2995
3215
  }
2996
3216
  ],
2997
3217
  query: [
@@ -3022,7 +3242,8 @@ file at the root of that directory.`
3022
3242
  pathParams: [
3023
3243
  {
3024
3244
  name: "skill_id",
3025
- sdkName: "skill_id"
3245
+ sdkName: "skill_id",
3246
+ description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
3026
3247
  }
3027
3248
  ],
3028
3249
  query: [],
@@ -3046,7 +3267,7 @@ file at the root of that directory.`
3046
3267
  resource: "agent.skills.versions",
3047
3268
  method: "delete",
3048
3269
  summary: "Delete skill version",
3049
- 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.",
3270
+ 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.",
3050
3271
  http: "DELETE",
3051
3272
  path: "/agent/v1/skills/{skill_id}/versions/{version}",
3052
3273
  streaming: "no",
@@ -3054,11 +3275,13 @@ file at the root of that directory.`
3054
3275
  pathParams: [
3055
3276
  {
3056
3277
  name: "skill_id",
3057
- sdkName: "skill_id"
3278
+ sdkName: "skill_id",
3279
+ description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
3058
3280
  },
3059
3281
  {
3060
3282
  name: "version",
3061
- sdkName: "version"
3283
+ sdkName: "version",
3284
+ description: "Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload."
3062
3285
  }
3063
3286
  ],
3064
3287
  query: []
@@ -3075,11 +3298,13 @@ file at the root of that directory.`
3075
3298
  pathParams: [
3076
3299
  {
3077
3300
  name: "skill_id",
3078
- sdkName: "skill_id"
3301
+ sdkName: "skill_id",
3302
+ description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
3079
3303
  },
3080
3304
  {
3081
3305
  name: "version",
3082
- sdkName: "version"
3306
+ sdkName: "version",
3307
+ description: "Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload."
3083
3308
  }
3084
3309
  ],
3085
3310
  query: []
@@ -3096,11 +3321,13 @@ file at the root of that directory.`
3096
3321
  pathParams: [
3097
3322
  {
3098
3323
  name: "skill_id",
3099
- sdkName: "skill_id"
3324
+ sdkName: "skill_id",
3325
+ description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
3100
3326
  },
3101
3327
  {
3102
3328
  name: "version",
3103
- sdkName: "version"
3329
+ sdkName: "version",
3330
+ description: "Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload."
3104
3331
  }
3105
3332
  ],
3106
3333
  query: []
@@ -3272,7 +3499,8 @@ file at the root of that directory.`
3272
3499
  pathParams: [
3273
3500
  {
3274
3501
  name: "worker_id",
3275
- sdkName: "worker_id"
3502
+ sdkName: "worker_id",
3503
+ description: "Worker ID (wkr_…)."
3276
3504
  }
3277
3505
  ],
3278
3506
  query: []
@@ -3289,7 +3517,8 @@ file at the root of that directory.`
3289
3517
  pathParams: [
3290
3518
  {
3291
3519
  name: "worker_id",
3292
- sdkName: "worker_id"
3520
+ sdkName: "worker_id",
3521
+ description: "Worker ID (wkr_…)."
3293
3522
  }
3294
3523
  ],
3295
3524
  query: [
@@ -3313,7 +3542,8 @@ file at the root of that directory.`
3313
3542
  pathParams: [
3314
3543
  {
3315
3544
  name: "worker_id",
3316
- sdkName: "worker_id"
3545
+ sdkName: "worker_id",
3546
+ description: "Worker ID (wkr_…)."
3317
3547
  }
3318
3548
  ],
3319
3549
  query: [],
@@ -3366,7 +3596,8 @@ file at the root of that directory.`
3366
3596
  pathParams: [
3367
3597
  {
3368
3598
  name: "worker_id",
3369
- sdkName: "worker_id"
3599
+ sdkName: "worker_id",
3600
+ description: "Worker ID (wkr_…)."
3370
3601
  }
3371
3602
  ],
3372
3603
  query: [],
@@ -3394,7 +3625,8 @@ file at the root of that directory.`
3394
3625
  pathParams: [
3395
3626
  {
3396
3627
  name: "worker_id",
3397
- sdkName: "worker_id"
3628
+ sdkName: "worker_id",
3629
+ description: "Worker ID (wkr_…)."
3398
3630
  }
3399
3631
  ],
3400
3632
  query: []
@@ -3411,7 +3643,8 @@ file at the root of that directory.`
3411
3643
  pathParams: [
3412
3644
  {
3413
3645
  name: "worker_id",
3414
- sdkName: "worker_id"
3646
+ sdkName: "worker_id",
3647
+ description: "Worker ID (wkr_…)."
3415
3648
  }
3416
3649
  ],
3417
3650
  query: [
@@ -3441,7 +3674,8 @@ file at the root of that directory.`
3441
3674
  pathParams: [
3442
3675
  {
3443
3676
  name: "worker_id",
3444
- sdkName: "worker_id"
3677
+ sdkName: "worker_id",
3678
+ description: "Worker ID (wkr_…)."
3445
3679
  }
3446
3680
  ],
3447
3681
  query: [],
@@ -3491,11 +3725,13 @@ file at the root of that directory.`
3491
3725
  pathParams: [
3492
3726
  {
3493
3727
  name: "worker_id",
3494
- sdkName: "worker_id"
3728
+ sdkName: "worker_id",
3729
+ description: "Worker ID (wkr_…)."
3495
3730
  },
3496
3731
  {
3497
3732
  name: "deployment_id",
3498
- sdkName: "deployment_id"
3733
+ sdkName: "deployment_id",
3734
+ description: "ID from the id of CreateDeployment or ListDeployments, prefixed dep_."
3499
3735
  }
3500
3736
  ],
3501
3737
  query: []
@@ -3512,7 +3748,8 @@ file at the root of that directory.`
3512
3748
  pathParams: [
3513
3749
  {
3514
3750
  name: "worker_id",
3515
- sdkName: "worker_id"
3751
+ sdkName: "worker_id",
3752
+ description: "Worker ID (wkr_…)."
3516
3753
  }
3517
3754
  ],
3518
3755
  query: [
@@ -3542,7 +3779,8 @@ file at the root of that directory.`
3542
3779
  pathParams: [
3543
3780
  {
3544
3781
  name: "worker_id",
3545
- sdkName: "worker_id"
3782
+ sdkName: "worker_id",
3783
+ description: "Worker ID (wkr_…)."
3546
3784
  }
3547
3785
  ],
3548
3786
  query: []
@@ -3559,7 +3797,8 @@ file at the root of that directory.`
3559
3797
  pathParams: [
3560
3798
  {
3561
3799
  name: "worker_id",
3562
- sdkName: "worker_id"
3800
+ sdkName: "worker_id",
3801
+ description: "Worker ID (wkr_…)."
3563
3802
  }
3564
3803
  ],
3565
3804
  query: [],
@@ -3597,11 +3836,13 @@ file at the root of that directory.`
3597
3836
  pathParams: [
3598
3837
  {
3599
3838
  name: "worker_id",
3600
- sdkName: "worker_id"
3839
+ sdkName: "worker_id",
3840
+ description: "Worker ID (wkr_…)."
3601
3841
  },
3602
3842
  {
3603
3843
  name: "grant_id",
3604
- sdkName: "grant_id"
3844
+ sdkName: "grant_id",
3845
+ description: "Grant ID (grt_…)."
3605
3846
  }
3606
3847
  ],
3607
3848
  query: []
@@ -3618,7 +3859,8 @@ file at the root of that directory.`
3618
3859
  pathParams: [
3619
3860
  {
3620
3861
  name: "worker_id",
3621
- sdkName: "worker_id"
3862
+ sdkName: "worker_id",
3863
+ description: "Worker ID (wkr_…)."
3622
3864
  }
3623
3865
  ],
3624
3866
  query: []
@@ -3635,7 +3877,8 @@ file at the root of that directory.`
3635
3877
  pathParams: [
3636
3878
  {
3637
3879
  name: "worker_id",
3638
- sdkName: "worker_id"
3880
+ sdkName: "worker_id",
3881
+ description: "Worker ID (wkr_…)."
3639
3882
  }
3640
3883
  ],
3641
3884
  query: []
@@ -3652,11 +3895,13 @@ file at the root of that directory.`
3652
3895
  pathParams: [
3653
3896
  {
3654
3897
  name: "worker_id",
3655
- sdkName: "worker_id"
3898
+ sdkName: "worker_id",
3899
+ description: "Worker ID (wkr_…)."
3656
3900
  },
3657
3901
  {
3658
3902
  name: "name",
3659
- sdkName: "name"
3903
+ sdkName: "name",
3904
+ description: "Secret name as seen in the Worker's env: 1–64 letters, digits or underscores, not starting with a digit."
3660
3905
  }
3661
3906
  ],
3662
3907
  query: []
@@ -3673,11 +3918,13 @@ file at the root of that directory.`
3673
3918
  pathParams: [
3674
3919
  {
3675
3920
  name: "worker_id",
3676
- sdkName: "worker_id"
3921
+ sdkName: "worker_id",
3922
+ description: "Worker ID (wkr_…)."
3677
3923
  },
3678
3924
  {
3679
3925
  name: "name",
3680
- sdkName: "name"
3926
+ sdkName: "name",
3927
+ description: "Secret name as seen in the Worker's env: 1–64 letters, digits or underscores, not starting with a digit."
3681
3928
  }
3682
3929
  ],
3683
3930
  query: [],
@@ -3705,7 +3952,8 @@ file at the root of that directory.`
3705
3952
  pathParams: [
3706
3953
  {
3707
3954
  name: "worker_id",
3708
- sdkName: "worker_id"
3955
+ sdkName: "worker_id",
3956
+ description: "Worker ID (wkr_…)."
3709
3957
  }
3710
3958
  ],
3711
3959
  query: [
@@ -3735,7 +3983,8 @@ file at the root of that directory.`
3735
3983
  pathParams: [
3736
3984
  {
3737
3985
  name: "worker_id",
3738
- sdkName: "worker_id"
3986
+ sdkName: "worker_id",
3987
+ description: "Worker ID (wkr_…)."
3739
3988
  }
3740
3989
  ],
3741
3990
  query: [],
@@ -3814,11 +4063,13 @@ file at the root of that directory.`
3814
4063
  pathParams: [
3815
4064
  {
3816
4065
  name: "worker_id",
3817
- sdkName: "worker_id"
4066
+ sdkName: "worker_id",
4067
+ description: "Worker ID (wkr_…)."
3818
4068
  },
3819
4069
  {
3820
4070
  name: "version_id",
3821
- sdkName: "version_id"
4071
+ sdkName: "version_id",
4072
+ description: "Version ID (ver_…)."
3822
4073
  }
3823
4074
  ],
3824
4075
  query: []
@@ -3835,11 +4086,13 @@ file at the root of that directory.`
3835
4086
  pathParams: [
3836
4087
  {
3837
4088
  name: "worker_id",
3838
- sdkName: "worker_id"
4089
+ sdkName: "worker_id",
4090
+ description: "Worker ID (wkr_…)."
3839
4091
  },
3840
4092
  {
3841
4093
  name: "version_id",
3842
- sdkName: "version_id"
4094
+ sdkName: "version_id",
4095
+ description: "Version ID from versions.list or the active deployment."
3843
4096
  }
3844
4097
  ],
3845
4098
  query: []
@@ -4025,11 +4278,13 @@ file at the root of that directory.`
4025
4278
  pathParams: [
4026
4279
  {
4027
4280
  name: "ns",
4028
- sdkName: "ns"
4281
+ sdkName: "ns",
4282
+ 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."
4029
4283
  },
4030
4284
  {
4031
4285
  name: "name",
4032
- sdkName: "name"
4286
+ sdkName: "name",
4287
+ 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}."
4033
4288
  }
4034
4289
  ],
4035
4290
  query: []
@@ -4046,11 +4301,13 @@ file at the root of that directory.`
4046
4301
  pathParams: [
4047
4302
  {
4048
4303
  name: "ns",
4049
- sdkName: "ns"
4304
+ sdkName: "ns",
4305
+ 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
4306
  },
4051
4307
  {
4052
4308
  name: "name",
4053
- sdkName: "name"
4309
+ sdkName: "name",
4310
+ 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}."
4054
4311
  }
4055
4312
  ],
4056
4313
  query: [
@@ -4134,11 +4391,13 @@ file at the root of that directory.`
4134
4391
  pathParams: [
4135
4392
  {
4136
4393
  name: "ns",
4137
- sdkName: "ns"
4394
+ sdkName: "ns",
4395
+ 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."
4138
4396
  },
4139
4397
  {
4140
4398
  name: "name",
4141
- sdkName: "name"
4399
+ sdkName: "name",
4400
+ 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}."
4142
4401
  }
4143
4402
  ],
4144
4403
  query: [],
@@ -4159,11 +4418,13 @@ file at the root of that directory.`
4159
4418
  pathParams: [
4160
4419
  {
4161
4420
  name: "ns",
4162
- sdkName: "ns"
4421
+ sdkName: "ns",
4422
+ 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."
4163
4423
  },
4164
4424
  {
4165
4425
  name: "name",
4166
- sdkName: "name"
4426
+ sdkName: "name",
4427
+ 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}."
4167
4428
  }
4168
4429
  ],
4169
4430
  query: [
@@ -4193,11 +4454,13 @@ file at the root of that directory.`
4193
4454
  pathParams: [
4194
4455
  {
4195
4456
  name: "ns",
4196
- sdkName: "ns"
4457
+ sdkName: "ns",
4458
+ 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."
4197
4459
  },
4198
4460
  {
4199
4461
  name: "name",
4200
- sdkName: "name"
4462
+ sdkName: "name",
4463
+ 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}."
4201
4464
  }
4202
4465
  ],
4203
4466
  query: [
@@ -4268,11 +4531,13 @@ file at the root of that directory.`
4268
4531
  pathParams: [
4269
4532
  {
4270
4533
  name: "ns",
4271
- sdkName: "ns"
4534
+ sdkName: "ns",
4535
+ 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."
4272
4536
  },
4273
4537
  {
4274
4538
  name: "name",
4275
- sdkName: "name"
4539
+ sdkName: "name",
4540
+ 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}."
4276
4541
  }
4277
4542
  ],
4278
4543
  query: [],
@@ -4293,11 +4558,13 @@ file at the root of that directory.`
4293
4558
  pathParams: [
4294
4559
  {
4295
4560
  name: "ns",
4296
- sdkName: "ns"
4561
+ sdkName: "ns",
4562
+ 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."
4297
4563
  },
4298
4564
  {
4299
4565
  name: "name",
4300
- sdkName: "name"
4566
+ sdkName: "name",
4567
+ 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}."
4301
4568
  }
4302
4569
  ],
4303
4570
  query: [
@@ -4336,15 +4603,18 @@ file at the root of that directory.`
4336
4603
  pathParams: [
4337
4604
  {
4338
4605
  name: "ns",
4339
- sdkName: "ns"
4606
+ sdkName: "ns",
4607
+ 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."
4340
4608
  },
4341
4609
  {
4342
4610
  name: "name",
4343
- sdkName: "name"
4611
+ sdkName: "name",
4612
+ 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}."
4344
4613
  },
4345
4614
  {
4346
4615
  name: "revision",
4347
- sdkName: "revision"
4616
+ sdkName: "revision",
4617
+ description: "Action revision ID (actr_); the query parameter filters invocation records."
4348
4618
  }
4349
4619
  ],
4350
4620
  query: []
@@ -4361,11 +4631,13 @@ file at the root of that directory.`
4361
4631
  pathParams: [
4362
4632
  {
4363
4633
  name: "ns",
4364
- sdkName: "ns"
4634
+ sdkName: "ns",
4635
+ 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."
4365
4636
  },
4366
4637
  {
4367
4638
  name: "name",
4368
- sdkName: "name"
4639
+ sdkName: "name",
4640
+ 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}."
4369
4641
  }
4370
4642
  ],
4371
4643
  query: [],
@@ -4399,11 +4671,13 @@ file at the root of that directory.`
4399
4671
  pathParams: [
4400
4672
  {
4401
4673
  name: "trigger_id",
4402
- sdkName: "trigger_id"
4674
+ sdkName: "trigger_id",
4675
+ description: "Trigger ID (trg_)."
4403
4676
  },
4404
4677
  {
4405
4678
  name: "token",
4406
- sdkName: "token"
4679
+ sdkName: "token",
4680
+ description: "Secret URL token returned on creation or rotation; do not disclose it."
4407
4681
  }
4408
4682
  ],
4409
4683
  query: [],
@@ -4616,7 +4890,8 @@ file at the root of that directory.`
4616
4890
  pathParams: [
4617
4891
  {
4618
4892
  name: "id",
4619
- sdkName: "id"
4893
+ sdkName: "id",
4894
+ description: "Run ID (run_)."
4620
4895
  }
4621
4896
  ],
4622
4897
  query: [
@@ -4654,7 +4929,8 @@ file at the root of that directory.`
4654
4929
  pathParams: [
4655
4930
  {
4656
4931
  name: "id",
4657
- sdkName: "id"
4932
+ sdkName: "id",
4933
+ description: "Run ID (run_)."
4658
4934
  }
4659
4935
  ],
4660
4936
  query: [
@@ -4684,7 +4960,8 @@ file at the root of that directory.`
4684
4960
  pathParams: [
4685
4961
  {
4686
4962
  name: "id",
4687
- sdkName: "id"
4963
+ sdkName: "id",
4964
+ description: "Run ID (run_)."
4688
4965
  }
4689
4966
  ],
4690
4967
  query: [
@@ -4714,7 +4991,8 @@ file at the root of that directory.`
4714
4991
  pathParams: [
4715
4992
  {
4716
4993
  name: "id",
4717
- sdkName: "id"
4994
+ sdkName: "id",
4995
+ description: "Run ID (run_)."
4718
4996
  }
4719
4997
  ],
4720
4998
  query: [],
@@ -4742,7 +5020,8 @@ file at the root of that directory.`
4742
5020
  pathParams: [
4743
5021
  {
4744
5022
  name: "id",
4745
- sdkName: "id"
5023
+ sdkName: "id",
5024
+ description: "Run ID (run_)."
4746
5025
  }
4747
5026
  ],
4748
5027
  query: [
@@ -4772,7 +5051,8 @@ file at the root of that directory.`
4772
5051
  pathParams: [
4773
5052
  {
4774
5053
  name: "id",
4775
- sdkName: "id"
5054
+ sdkName: "id",
5055
+ description: "Run ID (run_)."
4776
5056
  }
4777
5057
  ],
4778
5058
  query: [
@@ -4802,7 +5082,8 @@ file at the root of that directory.`
4802
5082
  pathParams: [
4803
5083
  {
4804
5084
  name: "id",
4805
- sdkName: "id"
5085
+ sdkName: "id",
5086
+ description: "Run ID (run_)."
4806
5087
  }
4807
5088
  ],
4808
5089
  query: [],
@@ -4830,7 +5111,8 @@ file at the root of that directory.`
4830
5111
  pathParams: [
4831
5112
  {
4832
5113
  name: "id",
4833
- sdkName: "id"
5114
+ sdkName: "id",
5115
+ description: "Run ID (run_)."
4834
5116
  }
4835
5117
  ],
4836
5118
  query: [],
@@ -4851,7 +5133,8 @@ file at the root of that directory.`
4851
5133
  pathParams: [
4852
5134
  {
4853
5135
  name: "id",
4854
- sdkName: "id"
5136
+ sdkName: "id",
5137
+ description: "Run ID (run_)."
4855
5138
  }
4856
5139
  ],
4857
5140
  query: []
@@ -4868,7 +5151,8 @@ file at the root of that directory.`
4868
5151
  pathParams: [
4869
5152
  {
4870
5153
  name: "id",
4871
- sdkName: "id"
5154
+ sdkName: "id",
5155
+ description: "Run ID (run_)."
4872
5156
  }
4873
5157
  ],
4874
5158
  query: [],
@@ -4889,7 +5173,8 @@ file at the root of that directory.`
4889
5173
  pathParams: [
4890
5174
  {
4891
5175
  name: "id",
4892
- sdkName: "id"
5176
+ sdkName: "id",
5177
+ description: "Run ID (run_)."
4893
5178
  }
4894
5179
  ],
4895
5180
  query: [
@@ -4937,7 +5222,8 @@ file at the root of that directory.`
4937
5222
  pathParams: [
4938
5223
  {
4939
5224
  name: "id",
4940
- sdkName: "id"
5225
+ sdkName: "id",
5226
+ description: "Run ID (run_)."
4941
5227
  }
4942
5228
  ],
4943
5229
  query: [
@@ -4967,11 +5253,13 @@ file at the root of that directory.`
4967
5253
  pathParams: [
4968
5254
  {
4969
5255
  name: "id",
4970
- sdkName: "id"
5256
+ sdkName: "id",
5257
+ description: "Run ID (run_)."
4971
5258
  },
4972
5259
  {
4973
5260
  name: "wait_id",
4974
- sdkName: "wait_id"
5261
+ sdkName: "wait_id",
5262
+ description: "Wait ID (wait_) belonging to this run."
4975
5263
  }
4976
5264
  ],
4977
5265
  query: [],
@@ -5125,11 +5413,13 @@ file at the root of that directory.`
5125
5413
  pathParams: [
5126
5414
  {
5127
5415
  name: "ns",
5128
- sdkName: "ns"
5416
+ sdkName: "ns",
5417
+ 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."
5129
5418
  },
5130
5419
  {
5131
5420
  name: "name",
5132
- sdkName: "name"
5421
+ sdkName: "name",
5422
+ 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}."
5133
5423
  }
5134
5424
  ],
5135
5425
  query: []
@@ -5146,11 +5436,13 @@ file at the root of that directory.`
5146
5436
  pathParams: [
5147
5437
  {
5148
5438
  name: "ns",
5149
- sdkName: "ns"
5439
+ sdkName: "ns",
5440
+ 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."
5150
5441
  },
5151
5442
  {
5152
5443
  name: "name",
5153
- sdkName: "name"
5444
+ sdkName: "name",
5445
+ 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}."
5154
5446
  }
5155
5447
  ],
5156
5448
  query: [],
@@ -5190,11 +5482,13 @@ file at the root of that directory.`
5190
5482
  pathParams: [
5191
5483
  {
5192
5484
  name: "ns",
5193
- sdkName: "ns"
5485
+ sdkName: "ns",
5486
+ 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."
5194
5487
  },
5195
5488
  {
5196
5489
  name: "name",
5197
- sdkName: "name"
5490
+ sdkName: "name",
5491
+ 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}."
5198
5492
  }
5199
5493
  ],
5200
5494
  query: [],
@@ -5215,11 +5509,13 @@ file at the root of that directory.`
5215
5509
  pathParams: [
5216
5510
  {
5217
5511
  name: "ns",
5218
- sdkName: "ns"
5512
+ sdkName: "ns",
5513
+ 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."
5219
5514
  },
5220
5515
  {
5221
5516
  name: "name",
5222
- sdkName: "name"
5517
+ sdkName: "name",
5518
+ 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}."
5223
5519
  }
5224
5520
  ],
5225
5521
  query: []
@@ -5236,15 +5532,18 @@ file at the root of that directory.`
5236
5532
  pathParams: [
5237
5533
  {
5238
5534
  name: "ns",
5239
- sdkName: "ns"
5535
+ sdkName: "ns",
5536
+ 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."
5240
5537
  },
5241
5538
  {
5242
5539
  name: "name",
5243
- sdkName: "name"
5540
+ sdkName: "name",
5541
+ 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}."
5244
5542
  },
5245
5543
  {
5246
5544
  name: "tag",
5247
- sdkName: "tag"
5545
+ sdkName: "tag",
5546
+ 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."
5248
5547
  }
5249
5548
  ],
5250
5549
  query: []
@@ -5261,15 +5560,18 @@ file at the root of that directory.`
5261
5560
  pathParams: [
5262
5561
  {
5263
5562
  name: "ns",
5264
- sdkName: "ns"
5563
+ sdkName: "ns",
5564
+ 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."
5265
5565
  },
5266
5566
  {
5267
5567
  name: "name",
5268
- sdkName: "name"
5568
+ sdkName: "name",
5569
+ 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}."
5269
5570
  },
5270
5571
  {
5271
5572
  name: "tag",
5272
- sdkName: "tag"
5573
+ sdkName: "tag",
5574
+ 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."
5273
5575
  }
5274
5576
  ],
5275
5577
  query: [],
@@ -5297,11 +5599,13 @@ file at the root of that directory.`
5297
5599
  pathParams: [
5298
5600
  {
5299
5601
  name: "ns",
5300
- sdkName: "ns"
5602
+ sdkName: "ns",
5603
+ 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."
5301
5604
  },
5302
5605
  {
5303
5606
  name: "name",
5304
- sdkName: "name"
5607
+ sdkName: "name",
5608
+ 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}."
5305
5609
  }
5306
5610
  ],
5307
5611
  query: [],
@@ -5322,11 +5626,13 @@ file at the root of that directory.`
5322
5626
  pathParams: [
5323
5627
  {
5324
5628
  name: "ns",
5325
- sdkName: "ns"
5629
+ sdkName: "ns",
5630
+ 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."
5326
5631
  },
5327
5632
  {
5328
5633
  name: "name",
5329
- sdkName: "name"
5634
+ sdkName: "name",
5635
+ 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}."
5330
5636
  }
5331
5637
  ],
5332
5638
  query: [
@@ -5368,11 +5674,13 @@ file at the root of that directory.`
5368
5674
  pathParams: [
5369
5675
  {
5370
5676
  name: "ns",
5371
- sdkName: "ns"
5677
+ sdkName: "ns",
5678
+ 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."
5372
5679
  },
5373
5680
  {
5374
5681
  name: "name",
5375
- sdkName: "name"
5682
+ sdkName: "name",
5683
+ 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}."
5376
5684
  }
5377
5685
  ],
5378
5686
  query: [],
@@ -5393,15 +5701,18 @@ file at the root of that directory.`
5393
5701
  pathParams: [
5394
5702
  {
5395
5703
  name: "ns",
5396
- sdkName: "ns"
5704
+ sdkName: "ns",
5705
+ 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."
5397
5706
  },
5398
5707
  {
5399
5708
  name: "name",
5400
- sdkName: "name"
5709
+ sdkName: "name",
5710
+ 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}."
5401
5711
  },
5402
5712
  {
5403
5713
  name: "version",
5404
- sdkName: "version"
5714
+ sdkName: "version",
5715
+ description: "Exact version or dist-tag; ranges are rejected with 400 and a hint."
5405
5716
  }
5406
5717
  ],
5407
5718
  query: []
@@ -5418,15 +5729,18 @@ file at the root of that directory.`
5418
5729
  pathParams: [
5419
5730
  {
5420
5731
  name: "ns",
5421
- sdkName: "ns"
5732
+ sdkName: "ns",
5733
+ 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."
5422
5734
  },
5423
5735
  {
5424
5736
  name: "name",
5425
- sdkName: "name"
5737
+ sdkName: "name",
5738
+ 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}."
5426
5739
  },
5427
5740
  {
5428
5741
  name: "version",
5429
- sdkName: "version"
5742
+ sdkName: "version",
5743
+ description: "An exact canonical semantic version, such as 1.2.0 or 1.3.0-beta.1, not a range."
5430
5744
  }
5431
5745
  ],
5432
5746
  query: [],
@@ -5732,7 +6046,8 @@ file at the root of that directory.`
5732
6046
  pathParams: [
5733
6047
  {
5734
6048
  name: "id",
5735
- sdkName: "id"
6049
+ sdkName: "id",
6050
+ description: "Trigger ID (trg_)."
5736
6051
  }
5737
6052
  ],
5738
6053
  query: []
@@ -5749,7 +6064,8 @@ file at the root of that directory.`
5749
6064
  pathParams: [
5750
6065
  {
5751
6066
  name: "id",
5752
- sdkName: "id"
6067
+ sdkName: "id",
6068
+ description: "Trigger ID (trg_)."
5753
6069
  }
5754
6070
  ],
5755
6071
  query: []
@@ -5766,7 +6082,8 @@ file at the root of that directory.`
5766
6082
  pathParams: [
5767
6083
  {
5768
6084
  name: "id",
5769
- sdkName: "id"
6085
+ sdkName: "id",
6086
+ description: "Trigger ID (trg_)."
5770
6087
  }
5771
6088
  ],
5772
6089
  query: [],
@@ -5874,7 +6191,8 @@ file at the root of that directory.`
5874
6191
  pathParams: [
5875
6192
  {
5876
6193
  name: "id",
5877
- sdkName: "id"
6194
+ sdkName: "id",
6195
+ description: "Trigger ID (trg_)."
5878
6196
  }
5879
6197
  ],
5880
6198
  query: []
@@ -5891,7 +6209,8 @@ file at the root of that directory.`
5891
6209
  pathParams: [
5892
6210
  {
5893
6211
  name: "id",
5894
- sdkName: "id"
6212
+ sdkName: "id",
6213
+ description: "Trigger ID (trg_)."
5895
6214
  }
5896
6215
  ],
5897
6216
  query: [
@@ -5942,7 +6261,8 @@ file at the root of that directory.`
5942
6261
  pathParams: [
5943
6262
  {
5944
6263
  name: "id",
5945
- sdkName: "id"
6264
+ sdkName: "id",
6265
+ description: "Trigger ID (trg_)."
5946
6266
  }
5947
6267
  ],
5948
6268
  query: []
@@ -5959,7 +6279,8 @@ file at the root of that directory.`
5959
6279
  pathParams: [
5960
6280
  {
5961
6281
  name: "id",
5962
- sdkName: "id"
6282
+ sdkName: "id",
6283
+ description: "Trigger ID (trg_)."
5963
6284
  }
5964
6285
  ],
5965
6286
  query: []
@@ -5976,7 +6297,8 @@ file at the root of that directory.`
5976
6297
  pathParams: [
5977
6298
  {
5978
6299
  name: "id",
5979
- sdkName: "id"
6300
+ sdkName: "id",
6301
+ description: "Trigger ID (trg_)."
5980
6302
  }
5981
6303
  ],
5982
6304
  query: []
@@ -6147,11 +6469,13 @@ file at the root of that directory.`
6147
6469
  pathParams: [
6148
6470
  {
6149
6471
  name: "ns",
6150
- sdkName: "ns"
6472
+ sdkName: "ns",
6473
+ 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."
6151
6474
  },
6152
6475
  {
6153
6476
  name: "name",
6154
- sdkName: "name"
6477
+ sdkName: "name",
6478
+ 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}."
6155
6479
  }
6156
6480
  ],
6157
6481
  query: []
@@ -6168,11 +6492,13 @@ file at the root of that directory.`
6168
6492
  pathParams: [
6169
6493
  {
6170
6494
  name: "ns",
6171
- sdkName: "ns"
6495
+ sdkName: "ns",
6496
+ 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."
6172
6497
  },
6173
6498
  {
6174
6499
  name: "name",
6175
- sdkName: "name"
6500
+ sdkName: "name",
6501
+ 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}."
6176
6502
  }
6177
6503
  ],
6178
6504
  query: [],
@@ -6212,11 +6538,13 @@ file at the root of that directory.`
6212
6538
  pathParams: [
6213
6539
  {
6214
6540
  name: "ns",
6215
- sdkName: "ns"
6541
+ sdkName: "ns",
6542
+ 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."
6216
6543
  },
6217
6544
  {
6218
6545
  name: "name",
6219
- sdkName: "name"
6546
+ sdkName: "name",
6547
+ 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}."
6220
6548
  }
6221
6549
  ],
6222
6550
  query: [],
@@ -6237,11 +6565,13 @@ file at the root of that directory.`
6237
6565
  pathParams: [
6238
6566
  {
6239
6567
  name: "ns",
6240
- sdkName: "ns"
6568
+ sdkName: "ns",
6569
+ 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."
6241
6570
  },
6242
6571
  {
6243
6572
  name: "name",
6244
- sdkName: "name"
6573
+ sdkName: "name",
6574
+ 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}."
6245
6575
  }
6246
6576
  ],
6247
6577
  query: []
@@ -6258,15 +6588,18 @@ file at the root of that directory.`
6258
6588
  pathParams: [
6259
6589
  {
6260
6590
  name: "ns",
6261
- sdkName: "ns"
6591
+ sdkName: "ns",
6592
+ 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."
6262
6593
  },
6263
6594
  {
6264
6595
  name: "name",
6265
- sdkName: "name"
6596
+ sdkName: "name",
6597
+ 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}."
6266
6598
  },
6267
6599
  {
6268
6600
  name: "tag",
6269
- sdkName: "tag"
6601
+ sdkName: "tag",
6602
+ 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."
6270
6603
  }
6271
6604
  ],
6272
6605
  query: []
@@ -6283,15 +6616,18 @@ file at the root of that directory.`
6283
6616
  pathParams: [
6284
6617
  {
6285
6618
  name: "ns",
6286
- sdkName: "ns"
6619
+ sdkName: "ns",
6620
+ 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."
6287
6621
  },
6288
6622
  {
6289
6623
  name: "name",
6290
- sdkName: "name"
6624
+ sdkName: "name",
6625
+ 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}."
6291
6626
  },
6292
6627
  {
6293
6628
  name: "tag",
6294
- sdkName: "tag"
6629
+ sdkName: "tag",
6630
+ 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."
6295
6631
  }
6296
6632
  ],
6297
6633
  query: [],
@@ -6319,11 +6655,13 @@ file at the root of that directory.`
6319
6655
  pathParams: [
6320
6656
  {
6321
6657
  name: "ns",
6322
- sdkName: "ns"
6658
+ sdkName: "ns",
6659
+ 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."
6323
6660
  },
6324
6661
  {
6325
6662
  name: "name",
6326
- sdkName: "name"
6663
+ sdkName: "name",
6664
+ 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}."
6327
6665
  }
6328
6666
  ],
6329
6667
  query: [],
@@ -6344,11 +6682,13 @@ file at the root of that directory.`
6344
6682
  pathParams: [
6345
6683
  {
6346
6684
  name: "ns",
6347
- sdkName: "ns"
6685
+ sdkName: "ns",
6686
+ 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."
6348
6687
  },
6349
6688
  {
6350
6689
  name: "name",
6351
- sdkName: "name"
6690
+ sdkName: "name",
6691
+ 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}."
6352
6692
  }
6353
6693
  ],
6354
6694
  query: [
@@ -6390,11 +6730,13 @@ file at the root of that directory.`
6390
6730
  pathParams: [
6391
6731
  {
6392
6732
  name: "ns",
6393
- sdkName: "ns"
6733
+ sdkName: "ns",
6734
+ 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."
6394
6735
  },
6395
6736
  {
6396
6737
  name: "name",
6397
- sdkName: "name"
6738
+ sdkName: "name",
6739
+ 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}."
6398
6740
  }
6399
6741
  ],
6400
6742
  query: [],
@@ -6415,15 +6757,18 @@ file at the root of that directory.`
6415
6757
  pathParams: [
6416
6758
  {
6417
6759
  name: "ns",
6418
- sdkName: "ns"
6760
+ sdkName: "ns",
6761
+ 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."
6419
6762
  },
6420
6763
  {
6421
6764
  name: "name",
6422
- sdkName: "name"
6765
+ sdkName: "name",
6766
+ 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}."
6423
6767
  },
6424
6768
  {
6425
6769
  name: "version",
6426
- sdkName: "version"
6770
+ sdkName: "version",
6771
+ description: "Exact version or dist-tag; ranges are rejected with 400 and a hint."
6427
6772
  }
6428
6773
  ],
6429
6774
  query: []
@@ -6440,15 +6785,18 @@ file at the root of that directory.`
6440
6785
  pathParams: [
6441
6786
  {
6442
6787
  name: "ns",
6443
- sdkName: "ns"
6788
+ sdkName: "ns",
6789
+ 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."
6444
6790
  },
6445
6791
  {
6446
6792
  name: "name",
6447
- sdkName: "name"
6793
+ sdkName: "name",
6794
+ 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}."
6448
6795
  },
6449
6796
  {
6450
6797
  name: "version",
6451
- sdkName: "version"
6798
+ sdkName: "version",
6799
+ description: "An exact canonical semantic version, such as 1.2.0 or 1.3.0-beta.1, not a range."
6452
6800
  }
6453
6801
  ],
6454
6802
  query: [],
@@ -6603,7 +6951,8 @@ file at the root of that directory.`
6603
6951
  pathParams: [
6604
6952
  {
6605
6953
  name: "contextId",
6606
- sdkName: "contextId"
6954
+ sdkName: "contextId",
6955
+ description: "登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。"
6607
6956
  }
6608
6957
  ],
6609
6958
  query: []
@@ -6620,7 +6969,8 @@ file at the root of that directory.`
6620
6969
  pathParams: [
6621
6970
  {
6622
6971
  name: "contextId",
6623
- sdkName: "contextId"
6972
+ sdkName: "contextId",
6973
+ description: "登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。"
6624
6974
  }
6625
6975
  ],
6626
6976
  query: []
@@ -6637,7 +6987,8 @@ file at the root of that directory.`
6637
6987
  pathParams: [
6638
6988
  {
6639
6989
  name: "contextId",
6640
- sdkName: "contextId"
6990
+ sdkName: "contextId",
6991
+ description: "登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。"
6641
6992
  }
6642
6993
  ],
6643
6994
  query: [],
@@ -6671,11 +7022,13 @@ file at the root of that directory.`
6671
7022
  pathParams: [
6672
7023
  {
6673
7024
  name: "sessionId",
6674
- sdkName: "sessionId"
7025
+ sdkName: "sessionId",
7026
+ description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
6675
7027
  },
6676
7028
  {
6677
7029
  name: "pageId",
6678
- sdkName: "pageId"
7030
+ sdkName: "pageId",
7031
+ description: "实时观看地址中的标签页 ID;使用 debug 返回链接中的原值,_ 表示会话级画面。"
6679
7032
  }
6680
7033
  ],
6681
7034
  query: [
@@ -6844,7 +7197,8 @@ file at the root of that directory.`
6844
7197
  pathParams: [
6845
7198
  {
6846
7199
  name: "sessionId",
6847
- sdkName: "sessionId"
7200
+ sdkName: "sessionId",
7201
+ description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
6848
7202
  }
6849
7203
  ],
6850
7204
  query: [
@@ -6868,7 +7222,8 @@ file at the root of that directory.`
6868
7222
  pathParams: [
6869
7223
  {
6870
7224
  name: "sessionId",
6871
- sdkName: "sessionId"
7225
+ sdkName: "sessionId",
7226
+ description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
6872
7227
  }
6873
7228
  ],
6874
7229
  query: [],
@@ -6899,7 +7254,8 @@ file at the root of that directory.`
6899
7254
  pathParams: [
6900
7255
  {
6901
7256
  name: "sessionId",
6902
- sdkName: "sessionId"
7257
+ sdkName: "sessionId",
7258
+ description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
6903
7259
  }
6904
7260
  ],
6905
7261
  query: []
@@ -6916,7 +7272,8 @@ file at the root of that directory.`
6916
7272
  pathParams: [
6917
7273
  {
6918
7274
  name: "sessionId",
6919
- sdkName: "sessionId"
7275
+ sdkName: "sessionId",
7276
+ description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
6920
7277
  }
6921
7278
  ],
6922
7279
  query: [
@@ -6952,7 +7309,8 @@ file at the root of that directory.`
6952
7309
  pathParams: [
6953
7310
  {
6954
7311
  name: "sessionId",
6955
- sdkName: "sessionId"
7312
+ sdkName: "sessionId",
7313
+ description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
6956
7314
  }
6957
7315
  ],
6958
7316
  query: [],
@@ -6986,7 +7344,8 @@ file at the root of that directory.`
6986
7344
  pathParams: [
6987
7345
  {
6988
7346
  name: "sessionId",
6989
- sdkName: "sessionId"
7347
+ sdkName: "sessionId",
7348
+ description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
6990
7349
  }
6991
7350
  ],
6992
7351
  query: []
@@ -7003,7 +7362,8 @@ file at the root of that directory.`
7003
7362
  pathParams: [
7004
7363
  {
7005
7364
  name: "sessionId",
7006
- sdkName: "sessionId"
7365
+ sdkName: "sessionId",
7366
+ description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
7007
7367
  }
7008
7368
  ],
7009
7369
  query: []
@@ -7020,7 +7380,8 @@ file at the root of that directory.`
7020
7380
  pathParams: [
7021
7381
  {
7022
7382
  name: "sessionId",
7023
- sdkName: "sessionId"
7383
+ sdkName: "sessionId",
7384
+ description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
7024
7385
  }
7025
7386
  ],
7026
7387
  query: [],
@@ -7118,7 +7479,8 @@ file at the root of that directory.`
7118
7479
  pathParams: [
7119
7480
  {
7120
7481
  name: "database_id",
7121
- sdkName: "database_id"
7482
+ sdkName: "database_id",
7483
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7122
7484
  }
7123
7485
  ],
7124
7486
  query: []
@@ -7135,7 +7497,8 @@ file at the root of that directory.`
7135
7497
  pathParams: [
7136
7498
  {
7137
7499
  name: "database_id",
7138
- sdkName: "database_id"
7500
+ sdkName: "database_id",
7501
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7139
7502
  }
7140
7503
  ],
7141
7504
  query: []
@@ -7152,7 +7515,8 @@ file at the root of that directory.`
7152
7515
  pathParams: [
7153
7516
  {
7154
7517
  name: "database_id",
7155
- sdkName: "database_id"
7518
+ sdkName: "database_id",
7519
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7156
7520
  }
7157
7521
  ],
7158
7522
  query: [],
@@ -7186,7 +7550,8 @@ file at the root of that directory.`
7186
7550
  pathParams: [
7187
7551
  {
7188
7552
  name: "database_id",
7189
- sdkName: "database_id"
7553
+ sdkName: "database_id",
7554
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7190
7555
  }
7191
7556
  ],
7192
7557
  query: [
@@ -7232,7 +7597,8 @@ file at the root of that directory.`
7232
7597
  pathParams: [
7233
7598
  {
7234
7599
  name: "database_id",
7235
- sdkName: "database_id"
7600
+ sdkName: "database_id",
7601
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7236
7602
  }
7237
7603
  ],
7238
7604
  query: []
@@ -7249,11 +7615,13 @@ file at the root of that directory.`
7249
7615
  pathParams: [
7250
7616
  {
7251
7617
  name: "database_id",
7252
- sdkName: "database_id"
7618
+ sdkName: "database_id",
7619
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7253
7620
  },
7254
7621
  {
7255
7622
  name: "table",
7256
- sdkName: "table"
7623
+ sdkName: "table",
7624
+ description: "table ID or name."
7257
7625
  }
7258
7626
  ],
7259
7627
  query: [
@@ -7337,11 +7705,13 @@ file at the root of that directory.`
7337
7705
  pathParams: [
7338
7706
  {
7339
7707
  name: "database_id",
7340
- sdkName: "database_id"
7708
+ sdkName: "database_id",
7709
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7341
7710
  },
7342
7711
  {
7343
7712
  name: "table",
7344
- sdkName: "table"
7713
+ sdkName: "table",
7714
+ description: "table ID or name."
7345
7715
  }
7346
7716
  ],
7347
7717
  query: [
@@ -7425,11 +7795,13 @@ file at the root of that directory.`
7425
7795
  pathParams: [
7426
7796
  {
7427
7797
  name: "database_id",
7428
- sdkName: "database_id"
7798
+ sdkName: "database_id",
7799
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7429
7800
  },
7430
7801
  {
7431
7802
  name: "table",
7432
- sdkName: "table"
7803
+ sdkName: "table",
7804
+ description: "table ID or name."
7433
7805
  }
7434
7806
  ],
7435
7807
  query: [
@@ -7513,11 +7885,13 @@ file at the root of that directory.`
7513
7885
  pathParams: [
7514
7886
  {
7515
7887
  name: "database_id",
7516
- sdkName: "database_id"
7888
+ sdkName: "database_id",
7889
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7517
7890
  },
7518
7891
  {
7519
7892
  name: "table",
7520
- sdkName: "table"
7893
+ sdkName: "table",
7894
+ description: "table ID or name."
7521
7895
  }
7522
7896
  ],
7523
7897
  query: [
@@ -7607,11 +7981,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7607
7981
  pathParams: [
7608
7982
  {
7609
7983
  name: "database_id",
7610
- sdkName: "database_id"
7984
+ sdkName: "database_id",
7985
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7611
7986
  },
7612
7987
  {
7613
7988
  name: "table",
7614
- sdkName: "table"
7989
+ sdkName: "table",
7990
+ description: "table ID or name."
7615
7991
  }
7616
7992
  ],
7617
7993
  query: [
@@ -7699,7 +8075,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7699
8075
  pathParams: [
7700
8076
  {
7701
8077
  name: "database_id",
7702
- sdkName: "database_id"
8078
+ sdkName: "database_id",
8079
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7703
8080
  }
7704
8081
  ],
7705
8082
  query: []
@@ -7716,7 +8093,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7716
8093
  pathParams: [
7717
8094
  {
7718
8095
  name: "database_id",
7719
- sdkName: "database_id"
8096
+ sdkName: "database_id",
8097
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7720
8098
  }
7721
8099
  ],
7722
8100
  query: []
@@ -7733,7 +8111,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7733
8111
  pathParams: [
7734
8112
  {
7735
8113
  name: "database_id",
7736
- sdkName: "database_id"
8114
+ sdkName: "database_id",
8115
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7737
8116
  }
7738
8117
  ],
7739
8118
  query: [],
@@ -7774,11 +8153,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7774
8153
  pathParams: [
7775
8154
  {
7776
8155
  name: "database_id",
7777
- sdkName: "database_id"
8156
+ sdkName: "database_id",
8157
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7778
8158
  },
7779
8159
  {
7780
8160
  name: "table",
7781
- sdkName: "table"
8161
+ sdkName: "table",
8162
+ description: "table ID or name."
7782
8163
  }
7783
8164
  ],
7784
8165
  query: []
@@ -7795,11 +8176,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7795
8176
  pathParams: [
7796
8177
  {
7797
8178
  name: "database_id",
7798
- sdkName: "database_id"
8179
+ sdkName: "database_id",
8180
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7799
8181
  },
7800
8182
  {
7801
8183
  name: "table",
7802
- sdkName: "table"
8184
+ sdkName: "table",
8185
+ description: "table ID or name."
7803
8186
  }
7804
8187
  ],
7805
8188
  query: []
@@ -7816,11 +8199,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7816
8199
  pathParams: [
7817
8200
  {
7818
8201
  name: "database_id",
7819
- sdkName: "database_id"
8202
+ sdkName: "database_id",
8203
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7820
8204
  },
7821
8205
  {
7822
8206
  name: "table",
7823
- sdkName: "table"
8207
+ sdkName: "table",
8208
+ description: "table ID or name."
7824
8209
  }
7825
8210
  ],
7826
8211
  query: [],
@@ -7854,11 +8239,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7854
8239
  pathParams: [
7855
8240
  {
7856
8241
  name: "database_id",
7857
- sdkName: "database_id"
8242
+ sdkName: "database_id",
8243
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7858
8244
  },
7859
8245
  {
7860
8246
  name: "table",
7861
- sdkName: "table"
8247
+ sdkName: "table",
8248
+ description: "table ID or name."
7862
8249
  }
7863
8250
  ],
7864
8251
  query: [],
@@ -7879,15 +8266,18 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7879
8266
  pathParams: [
7880
8267
  {
7881
8268
  name: "database_id",
7882
- sdkName: "database_id"
8269
+ sdkName: "database_id",
8270
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7883
8271
  },
7884
8272
  {
7885
8273
  name: "table",
7886
- sdkName: "table"
8274
+ sdkName: "table",
8275
+ description: "table ID or name."
7887
8276
  },
7888
8277
  {
7889
8278
  name: "field",
7890
- sdkName: "field"
8279
+ sdkName: "field",
8280
+ description: "field ID or name."
7891
8281
  }
7892
8282
  ],
7893
8283
  query: []
@@ -7904,15 +8294,18 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
7904
8294
  pathParams: [
7905
8295
  {
7906
8296
  name: "database_id",
7907
- sdkName: "database_id"
8297
+ sdkName: "database_id",
8298
+ description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7908
8299
  },
7909
8300
  {
7910
8301
  name: "table",
7911
- sdkName: "table"
8302
+ sdkName: "table",
8303
+ description: "table ID or name."
7912
8304
  },
7913
8305
  {
7914
8306
  name: "field",
7915
- sdkName: "field"
8307
+ sdkName: "field",
8308
+ description: "field ID or name."
7916
8309
  }
7917
8310
  ],
7918
8311
  query: [],
@@ -8071,7 +8464,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8071
8464
  pathParams: [
8072
8465
  {
8073
8466
  name: "file_id",
8074
- sdkName: "file_id"
8467
+ sdkName: "file_id",
8468
+ description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-."
8075
8469
  }
8076
8470
  ],
8077
8471
  query: []
@@ -8088,7 +8482,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8088
8482
  pathParams: [
8089
8483
  {
8090
8484
  name: "file_id",
8091
- sdkName: "file_id"
8485
+ sdkName: "file_id",
8486
+ description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-."
8092
8487
  }
8093
8488
  ],
8094
8489
  query: []
@@ -8105,7 +8500,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8105
8500
  pathParams: [
8106
8501
  {
8107
8502
  name: "file_id",
8108
- sdkName: "file_id"
8503
+ sdkName: "file_id",
8504
+ description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-."
8109
8505
  }
8110
8506
  ],
8111
8507
  query: []
@@ -8180,7 +8576,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8180
8576
  pathParams: [
8181
8577
  {
8182
8578
  name: "upload_id",
8183
- sdkName: "upload_id"
8579
+ sdkName: "upload_id",
8580
+ description: "Upload identifier returned by create; belongs to your organization."
8184
8581
  }
8185
8582
  ],
8186
8583
  query: []
@@ -8197,7 +8594,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8197
8594
  pathParams: [
8198
8595
  {
8199
8596
  name: "upload_id",
8200
- sdkName: "upload_id"
8597
+ sdkName: "upload_id",
8598
+ description: "Upload identifier returned by create; belongs to your organization."
8201
8599
  }
8202
8600
  ],
8203
8601
  query: [],
@@ -8233,7 +8631,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8233
8631
  pathParams: [
8234
8632
  {
8235
8633
  name: "upload_id",
8236
- sdkName: "upload_id"
8634
+ sdkName: "upload_id",
8635
+ description: "Upload identifier returned by create; belongs to your organization."
8237
8636
  }
8238
8637
  ],
8239
8638
  query: [
@@ -8379,7 +8778,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8379
8778
  pathParams: [
8380
8779
  {
8381
8780
  name: "vector_store_id",
8382
- sdkName: "vector_store_id"
8781
+ sdkName: "vector_store_id",
8782
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8383
8783
  }
8384
8784
  ],
8385
8785
  query: []
@@ -8396,7 +8796,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8396
8796
  pathParams: [
8397
8797
  {
8398
8798
  name: "vector_store_id",
8399
- sdkName: "vector_store_id"
8799
+ sdkName: "vector_store_id",
8800
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8400
8801
  }
8401
8802
  ],
8402
8803
  query: [
@@ -8434,7 +8835,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8434
8835
  pathParams: [
8435
8836
  {
8436
8837
  name: "vector_store_id",
8437
- sdkName: "vector_store_id"
8838
+ sdkName: "vector_store_id",
8839
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8438
8840
  }
8439
8841
  ],
8440
8842
  query: [],
@@ -8480,7 +8882,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8480
8882
  pathParams: [
8481
8883
  {
8482
8884
  name: "vector_store_id",
8483
- sdkName: "vector_store_id"
8885
+ sdkName: "vector_store_id",
8886
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8484
8887
  }
8485
8888
  ],
8486
8889
  query: [
@@ -8510,7 +8913,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8510
8913
  pathParams: [
8511
8914
  {
8512
8915
  name: "vector_store_id",
8513
- sdkName: "vector_store_id"
8916
+ sdkName: "vector_store_id",
8917
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8514
8918
  }
8515
8919
  ],
8516
8920
  query: [],
@@ -8531,11 +8935,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8531
8935
  pathParams: [
8532
8936
  {
8533
8937
  name: "vector_store_id",
8534
- sdkName: "vector_store_id"
8938
+ sdkName: "vector_store_id",
8939
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8535
8940
  },
8536
8941
  {
8537
8942
  name: "batch_id",
8538
- sdkName: "batch_id"
8943
+ sdkName: "batch_id",
8944
+ description: "File-batch ID returned by batch creation in this knowledge base."
8539
8945
  }
8540
8946
  ],
8541
8947
  query: []
@@ -8552,11 +8958,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8552
8958
  pathParams: [
8553
8959
  {
8554
8960
  name: "vector_store_id",
8555
- sdkName: "vector_store_id"
8961
+ sdkName: "vector_store_id",
8962
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8556
8963
  },
8557
8964
  {
8558
8965
  name: "batch_id",
8559
- sdkName: "batch_id"
8966
+ sdkName: "batch_id",
8967
+ description: "File-batch ID returned by batch creation in this knowledge base."
8560
8968
  }
8561
8969
  ],
8562
8970
  query: []
@@ -8573,11 +8981,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8573
8981
  pathParams: [
8574
8982
  {
8575
8983
  name: "vector_store_id",
8576
- sdkName: "vector_store_id"
8984
+ sdkName: "vector_store_id",
8985
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8577
8986
  },
8578
8987
  {
8579
8988
  name: "batch_id",
8580
- sdkName: "batch_id"
8989
+ sdkName: "batch_id",
8990
+ description: "File-batch ID returned by batch creation in this knowledge base."
8581
8991
  }
8582
8992
  ],
8583
8993
  query: [
@@ -8635,7 +9045,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8635
9045
  pathParams: [
8636
9046
  {
8637
9047
  name: "vector_store_id",
8638
- sdkName: "vector_store_id"
9048
+ sdkName: "vector_store_id",
9049
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8639
9050
  }
8640
9051
  ],
8641
9052
  query: [
@@ -8693,7 +9104,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8693
9104
  pathParams: [
8694
9105
  {
8695
9106
  name: "vector_store_id",
8696
- sdkName: "vector_store_id"
9107
+ sdkName: "vector_store_id",
9108
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8697
9109
  }
8698
9110
  ],
8699
9111
  query: [],
@@ -8733,11 +9145,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8733
9145
  pathParams: [
8734
9146
  {
8735
9147
  name: "vector_store_id",
8736
- sdkName: "vector_store_id"
9148
+ sdkName: "vector_store_id",
9149
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8737
9150
  },
8738
9151
  {
8739
9152
  name: "file_id",
8740
- sdkName: "file_id"
9153
+ sdkName: "file_id",
9154
+ description: "Source File ID of an attachment, returned by file attachment or listing."
8741
9155
  }
8742
9156
  ],
8743
9157
  query: []
@@ -8754,11 +9168,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8754
9168
  pathParams: [
8755
9169
  {
8756
9170
  name: "vector_store_id",
8757
- sdkName: "vector_store_id"
9171
+ sdkName: "vector_store_id",
9172
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8758
9173
  },
8759
9174
  {
8760
9175
  name: "file_id",
8761
- sdkName: "file_id"
9176
+ sdkName: "file_id",
9177
+ description: "Source File ID of an attachment, returned by file attachment or listing."
8762
9178
  }
8763
9179
  ],
8764
9180
  query: []
@@ -8775,11 +9191,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8775
9191
  pathParams: [
8776
9192
  {
8777
9193
  name: "vector_store_id",
8778
- sdkName: "vector_store_id"
9194
+ sdkName: "vector_store_id",
9195
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8779
9196
  },
8780
9197
  {
8781
9198
  name: "file_id",
8782
- sdkName: "file_id"
9199
+ sdkName: "file_id",
9200
+ description: "Source File ID of an attachment, returned by file attachment or listing."
8783
9201
  }
8784
9202
  ],
8785
9203
  query: [],
@@ -8807,11 +9225,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8807
9225
  pathParams: [
8808
9226
  {
8809
9227
  name: "vector_store_id",
8810
- sdkName: "vector_store_id"
9228
+ sdkName: "vector_store_id",
9229
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8811
9230
  },
8812
9231
  {
8813
9232
  name: "file_id",
8814
- sdkName: "file_id"
9233
+ sdkName: "file_id",
9234
+ description: "Source File ID of an attachment, returned by file attachment or listing."
8815
9235
  }
8816
9236
  ],
8817
9237
  query: []
@@ -8828,11 +9248,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8828
9248
  pathParams: [
8829
9249
  {
8830
9250
  name: "vector_store_id",
8831
- sdkName: "vector_store_id"
9251
+ sdkName: "vector_store_id",
9252
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8832
9253
  },
8833
9254
  {
8834
9255
  name: "file_id",
8835
- sdkName: "file_id"
9256
+ sdkName: "file_id",
9257
+ description: "Source File ID of an attachment, returned by file attachment or listing."
8836
9258
  }
8837
9259
  ],
8838
9260
  query: []
@@ -8849,11 +9271,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8849
9271
  pathParams: [
8850
9272
  {
8851
9273
  name: "vector_store_id",
8852
- sdkName: "vector_store_id"
9274
+ sdkName: "vector_store_id",
9275
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8853
9276
  },
8854
9277
  {
8855
9278
  name: "file_id",
8856
- sdkName: "file_id"
9279
+ sdkName: "file_id",
9280
+ description: "Source File ID of an attachment, returned by file attachment or listing."
8857
9281
  }
8858
9282
  ],
8859
9283
  query: [
@@ -8899,7 +9323,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8899
9323
  pathParams: [
8900
9324
  {
8901
9325
  name: "vector_store_id",
8902
- sdkName: "vector_store_id"
9326
+ sdkName: "vector_store_id",
9327
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8903
9328
  }
8904
9329
  ],
8905
9330
  query: []
@@ -8916,7 +9341,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8916
9341
  pathParams: [
8917
9342
  {
8918
9343
  name: "vector_store_id",
8919
- sdkName: "vector_store_id"
9344
+ sdkName: "vector_store_id",
9345
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8920
9346
  }
8921
9347
  ],
8922
9348
  query: []
@@ -8933,7 +9359,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8933
9359
  pathParams: [
8934
9360
  {
8935
9361
  name: "vector_store_id",
8936
- sdkName: "vector_store_id"
9362
+ sdkName: "vector_store_id",
9363
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
8937
9364
  }
8938
9365
  ],
8939
9366
  query: [],
@@ -8997,11 +9424,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
8997
9424
  pathParams: [
8998
9425
  {
8999
9426
  name: "vector_store_id",
9000
- sdkName: "vector_store_id"
9427
+ sdkName: "vector_store_id",
9428
+ description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
9001
9429
  },
9002
9430
  {
9003
9431
  name: "chunk_id",
9004
- sdkName: "chunk_id"
9432
+ sdkName: "chunk_id",
9433
+ description: "Chunk ID returned by segment listing or native search content."
9005
9434
  }
9006
9435
  ],
9007
9436
  query: []
@@ -9100,7 +9529,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9100
9529
  pathParams: [
9101
9530
  {
9102
9531
  name: "library_id",
9103
- sdkName: "library_id"
9532
+ sdkName: "library_id",
9533
+ description: "Library ID returned by creation."
9104
9534
  }
9105
9535
  ],
9106
9536
  query: []
@@ -9117,7 +9547,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9117
9547
  pathParams: [
9118
9548
  {
9119
9549
  name: "library_id",
9120
- sdkName: "library_id"
9550
+ sdkName: "library_id",
9551
+ description: "Library ID returned by creation."
9121
9552
  }
9122
9553
  ],
9123
9554
  query: []
@@ -9134,7 +9565,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9134
9565
  pathParams: [
9135
9566
  {
9136
9567
  name: "library_id",
9137
- sdkName: "library_id"
9568
+ sdkName: "library_id",
9569
+ description: "Library ID returned by creation."
9138
9570
  }
9139
9571
  ],
9140
9572
  query: [],
@@ -9180,7 +9612,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9180
9612
  pathParams: [
9181
9613
  {
9182
9614
  name: "library_id",
9183
- sdkName: "library_id"
9615
+ sdkName: "library_id",
9616
+ description: "Library ID returned by creation."
9184
9617
  }
9185
9618
  ],
9186
9619
  query: [
@@ -9228,7 +9661,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9228
9661
  pathParams: [
9229
9662
  {
9230
9663
  name: "library_id",
9231
- sdkName: "library_id"
9664
+ sdkName: "library_id",
9665
+ description: "Library ID returned by creation."
9232
9666
  }
9233
9667
  ],
9234
9668
  query: [],
@@ -9340,7 +9774,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9340
9774
  pathParams: [
9341
9775
  {
9342
9776
  name: "library_id",
9343
- sdkName: "library_id"
9777
+ sdkName: "library_id",
9778
+ description: "Library ID returned by creation."
9344
9779
  }
9345
9780
  ],
9346
9781
  query: [],
@@ -9451,11 +9886,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9451
9886
  pathParams: [
9452
9887
  {
9453
9888
  name: "library_id",
9454
- sdkName: "library_id"
9889
+ sdkName: "library_id",
9890
+ description: "Library ID returned by creation."
9455
9891
  },
9456
9892
  {
9457
9893
  name: "asset_id",
9458
- sdkName: "asset_id"
9894
+ sdkName: "asset_id",
9895
+ description: "32-character asset ID."
9459
9896
  }
9460
9897
  ],
9461
9898
  query: []
@@ -9472,11 +9909,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9472
9909
  pathParams: [
9473
9910
  {
9474
9911
  name: "library_id",
9475
- sdkName: "library_id"
9912
+ sdkName: "library_id",
9913
+ description: "Library ID returned by creation."
9476
9914
  },
9477
9915
  {
9478
9916
  name: "asset_id",
9479
- sdkName: "asset_id"
9917
+ sdkName: "asset_id",
9918
+ description: "32-character asset ID."
9480
9919
  }
9481
9920
  ],
9482
9921
  query: []
@@ -9493,11 +9932,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9493
9932
  pathParams: [
9494
9933
  {
9495
9934
  name: "library_id",
9496
- sdkName: "library_id"
9935
+ sdkName: "library_id",
9936
+ description: "Library ID returned by creation."
9497
9937
  },
9498
9938
  {
9499
9939
  name: "asset_id",
9500
- sdkName: "asset_id"
9940
+ sdkName: "asset_id",
9941
+ description: "32-character asset ID."
9501
9942
  }
9502
9943
  ],
9503
9944
  query: [],
@@ -9544,11 +9985,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9544
9985
  pathParams: [
9545
9986
  {
9546
9987
  name: "library_id",
9547
- sdkName: "library_id"
9988
+ sdkName: "library_id",
9989
+ description: "Library ID returned by creation."
9548
9990
  },
9549
9991
  {
9550
9992
  name: "asset_id",
9551
- sdkName: "asset_id"
9993
+ sdkName: "asset_id",
9994
+ description: "32-character asset ID."
9552
9995
  }
9553
9996
  ],
9554
9997
  query: [],
@@ -9583,11 +10026,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9583
10026
  pathParams: [
9584
10027
  {
9585
10028
  name: "library_id",
9586
- sdkName: "library_id"
10029
+ sdkName: "library_id",
10030
+ description: "Library ID returned by creation."
9587
10031
  },
9588
10032
  {
9589
10033
  name: "asset_id",
9590
- sdkName: "asset_id"
10034
+ sdkName: "asset_id",
10035
+ description: "32-character asset ID."
9591
10036
  }
9592
10037
  ],
9593
10038
  query: [
@@ -9636,7 +10081,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9636
10081
  pathParams: [
9637
10082
  {
9638
10083
  name: "library_id",
9639
- sdkName: "library_id"
10084
+ sdkName: "library_id",
10085
+ description: "Library ID returned by creation."
9640
10086
  }
9641
10087
  ],
9642
10088
  query: [],
@@ -9664,7 +10110,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9664
10110
  pathParams: [
9665
10111
  {
9666
10112
  name: "library_id",
9667
- sdkName: "library_id"
10113
+ sdkName: "library_id",
10114
+ description: "Library ID returned by creation."
9668
10115
  }
9669
10116
  ],
9670
10117
  query: [],
@@ -9692,11 +10139,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9692
10139
  pathParams: [
9693
10140
  {
9694
10141
  name: "library_id",
9695
- sdkName: "library_id"
10142
+ sdkName: "library_id",
10143
+ description: "Library ID returned by creation."
9696
10144
  },
9697
10145
  {
9698
10146
  name: "job_id",
9699
- sdkName: "job_id"
10147
+ sdkName: "job_id",
10148
+ description: "Batch identifier returned by createBatch or batchAssets; resolved within this library."
9700
10149
  }
9701
10150
  ],
9702
10151
  query: []
@@ -9713,7 +10162,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9713
10162
  pathParams: [
9714
10163
  {
9715
10164
  name: "library_id",
9716
- sdkName: "library_id"
10165
+ sdkName: "library_id",
10166
+ description: "Library ID returned by creation."
9717
10167
  }
9718
10168
  ],
9719
10169
  query: [
@@ -9759,7 +10209,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9759
10209
  pathParams: [
9760
10210
  {
9761
10211
  name: "library_id",
9762
- sdkName: "library_id"
10212
+ sdkName: "library_id",
10213
+ description: "Library ID returned by creation."
9763
10214
  }
9764
10215
  ],
9765
10216
  query: [
@@ -9783,11 +10234,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9783
10234
  pathParams: [
9784
10235
  {
9785
10236
  name: "library_id",
9786
- sdkName: "library_id"
10237
+ sdkName: "library_id",
10238
+ description: "Library ID returned by creation."
9787
10239
  },
9788
10240
  {
9789
10241
  name: "job_id",
9790
- sdkName: "job_id"
10242
+ sdkName: "job_id",
10243
+ description: "Batch identifier returned by createBatch or batchAssets; resolved within this library."
9791
10244
  }
9792
10245
  ],
9793
10246
  query: []
@@ -9804,7 +10257,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9804
10257
  pathParams: [
9805
10258
  {
9806
10259
  name: "library_id",
9807
- sdkName: "library_id"
10260
+ sdkName: "library_id",
10261
+ description: "Library ID returned by creation."
9808
10262
  }
9809
10263
  ],
9810
10264
  query: []
@@ -9821,7 +10275,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9821
10275
  pathParams: [
9822
10276
  {
9823
10277
  name: "library_id",
9824
- sdkName: "library_id"
10278
+ sdkName: "library_id",
10279
+ description: "Library ID returned by creation."
9825
10280
  }
9826
10281
  ],
9827
10282
  query: []
@@ -9838,7 +10293,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9838
10293
  pathParams: [
9839
10294
  {
9840
10295
  name: "library_id",
9841
- sdkName: "library_id"
10296
+ sdkName: "library_id",
10297
+ description: "Library ID returned by creation."
9842
10298
  }
9843
10299
  ],
9844
10300
  query: [],
@@ -9888,7 +10344,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9888
10344
  pathParams: [
9889
10345
  {
9890
10346
  name: "library_id",
9891
- sdkName: "library_id"
10347
+ sdkName: "library_id",
10348
+ description: "Library ID returned by creation."
9892
10349
  }
9893
10350
  ],
9894
10351
  query: [],
@@ -9959,7 +10416,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
9959
10416
  pathParams: [
9960
10417
  {
9961
10418
  name: "library_id",
9962
- sdkName: "library_id"
10419
+ sdkName: "library_id",
10420
+ description: "Library ID returned by creation."
9963
10421
  }
9964
10422
  ],
9965
10423
  query: [],
@@ -10009,7 +10467,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
10009
10467
  pathParams: [
10010
10468
  {
10011
10469
  name: "library_id",
10012
- sdkName: "library_id"
10470
+ sdkName: "library_id",
10471
+ description: "Library ID returned by creation."
10013
10472
  }
10014
10473
  ],
10015
10474
  query: [],
@@ -10102,7 +10561,8 @@ services (model, agent, automation…); call the operation you need and read its
10102
10561
  pathParams: [
10103
10562
  {
10104
10563
  name: "name",
10105
- sdkName: "name"
10564
+ sdkName: "name",
10565
+ description: "Exact method name from the search results, for example `praxis.database.databases.tables.create`."
10106
10566
  }
10107
10567
  ],
10108
10568
  query: []
@@ -10759,7 +11219,8 @@ services (model, agent, automation…); call the operation you need and read its
10759
11219
  pathParams: [
10760
11220
  {
10761
11221
  name: "conversation_id",
10762
- sdkName: "conversation_id"
11222
+ sdkName: "conversation_id",
11223
+ 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."
10763
11224
  }
10764
11225
  ],
10765
11226
  query: []
@@ -10776,7 +11237,8 @@ services (model, agent, automation…); call the operation you need and read its
10776
11237
  pathParams: [
10777
11238
  {
10778
11239
  name: "conversation_id",
10779
- sdkName: "conversation_id"
11240
+ sdkName: "conversation_id",
11241
+ 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."
10780
11242
  }
10781
11243
  ],
10782
11244
  query: []
@@ -10793,7 +11255,8 @@ services (model, agent, automation…); call the operation you need and read its
10793
11255
  pathParams: [
10794
11256
  {
10795
11257
  name: "conversation_id",
10796
- sdkName: "conversation_id"
11258
+ sdkName: "conversation_id",
11259
+ 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."
10797
11260
  }
10798
11261
  ],
10799
11262
  query: [],
@@ -10821,7 +11284,8 @@ services (model, agent, automation…); call the operation you need and read its
10821
11284
  pathParams: [
10822
11285
  {
10823
11286
  name: "conversation_id",
10824
- sdkName: "conversation_id"
11287
+ sdkName: "conversation_id",
11288
+ 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."
10825
11289
  }
10826
11290
  ],
10827
11291
  query: []
@@ -10838,7 +11302,8 @@ services (model, agent, automation…); call the operation you need and read its
10838
11302
  pathParams: [
10839
11303
  {
10840
11304
  name: "conversation_id",
10841
- sdkName: "conversation_id"
11305
+ sdkName: "conversation_id",
11306
+ 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."
10842
11307
  }
10843
11308
  ],
10844
11309
  query: [],
@@ -10867,11 +11332,13 @@ services (model, agent, automation…); call the operation you need and read its
10867
11332
  pathParams: [
10868
11333
  {
10869
11334
  name: "conversation_id",
10870
- sdkName: "conversation_id"
11335
+ sdkName: "conversation_id",
11336
+ 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."
10871
11337
  },
10872
11338
  {
10873
11339
  name: "item_id",
10874
- sdkName: "item_id"
11340
+ sdkName: "item_id",
11341
+ 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."
10875
11342
  }
10876
11343
  ],
10877
11344
  query: []
@@ -10888,11 +11355,13 @@ services (model, agent, automation…); call the operation you need and read its
10888
11355
  pathParams: [
10889
11356
  {
10890
11357
  name: "conversation_id",
10891
- sdkName: "conversation_id"
11358
+ sdkName: "conversation_id",
11359
+ 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."
10892
11360
  },
10893
11361
  {
10894
11362
  name: "item_id",
10895
- sdkName: "item_id"
11363
+ sdkName: "item_id",
11364
+ 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."
10896
11365
  }
10897
11366
  ],
10898
11367
  query: []
@@ -11658,7 +12127,8 @@ for more details.`
11658
12127
  pathParams: [
11659
12128
  {
11660
12129
  name: "model",
11661
- sdkName: "model"
12130
+ sdkName: "model",
12131
+ 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."
11662
12132
  }
11663
12133
  ],
11664
12134
  query: []
@@ -12117,7 +12587,8 @@ for more details.`
12117
12587
  pathParams: [
12118
12588
  {
12119
12589
  name: "response_id",
12120
- sdkName: "response_id"
12590
+ sdkName: "response_id",
12591
+ 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."
12121
12592
  }
12122
12593
  ],
12123
12594
  query: []
@@ -12134,7 +12605,8 @@ for more details.`
12134
12605
  pathParams: [
12135
12606
  {
12136
12607
  name: "response_id",
12137
- sdkName: "response_id"
12608
+ sdkName: "response_id",
12609
+ 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."
12138
12610
  }
12139
12611
  ],
12140
12612
  query: []
@@ -12151,7 +12623,8 @@ for more details.`
12151
12623
  pathParams: [
12152
12624
  {
12153
12625
  name: "response_id",
12154
- sdkName: "response_id"
12626
+ sdkName: "response_id",
12627
+ 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."
12155
12628
  }
12156
12629
  ],
12157
12630
  query: []
@@ -12168,7 +12641,8 @@ for more details.`
12168
12641
  pathParams: [
12169
12642
  {
12170
12643
  name: "response_id",
12171
- sdkName: "response_id"
12644
+ sdkName: "response_id",
12645
+ 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."
12172
12646
  }
12173
12647
  ],
12174
12648
  query: []
@@ -12324,7 +12798,8 @@ for more details.`
12324
12798
  pathParams: [
12325
12799
  {
12326
12800
  name: "video_id",
12327
- sdkName: "video_id"
12801
+ sdkName: "video_id",
12802
+ 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."
12328
12803
  }
12329
12804
  ],
12330
12805
  query: []
@@ -12341,7 +12816,8 @@ for more details.`
12341
12816
  pathParams: [
12342
12817
  {
12343
12818
  name: "video_id",
12344
- sdkName: "video_id"
12819
+ sdkName: "video_id",
12820
+ 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."
12345
12821
  }
12346
12822
  ],
12347
12823
  query: []
@@ -12358,7 +12834,8 @@ for more details.`
12358
12834
  pathParams: [
12359
12835
  {
12360
12836
  name: "video_id",
12361
- sdkName: "video_id"
12837
+ sdkName: "video_id",
12838
+ 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."
12362
12839
  }
12363
12840
  ],
12364
12841
  query: [
@@ -12393,7 +12870,8 @@ for more details.`
12393
12870
  pathParams: [
12394
12871
  {
12395
12872
  name: "video_id",
12396
- sdkName: "video_id"
12873
+ sdkName: "video_id",
12874
+ 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."
12397
12875
  }
12398
12876
  ],
12399
12877
  query: []
@@ -12538,7 +13016,8 @@ for more details.`
12538
13016
  pathParams: [
12539
13017
  {
12540
13018
  name: "id",
12541
- sdkName: "id"
13019
+ sdkName: "id",
13020
+ description: "The event id from the events list."
12542
13021
  }
12543
13022
  ],
12544
13023
  query: []
@@ -12692,7 +13171,8 @@ for more details.`
12692
13171
  pathParams: [
12693
13172
  {
12694
13173
  name: "id",
12695
- sdkName: "id"
13174
+ sdkName: "id",
13175
+ description: "Feedback identifier, prefixed with fb_."
12696
13176
  }
12697
13177
  ],
12698
13178
  query: []
@@ -12709,7 +13189,8 @@ for more details.`
12709
13189
  pathParams: [
12710
13190
  {
12711
13191
  name: "id",
12712
- sdkName: "id"
13192
+ sdkName: "id",
13193
+ description: "Feedback identifier, prefixed with fb_."
12713
13194
  }
12714
13195
  ],
12715
13196
  query: [
@@ -12739,7 +13220,8 @@ for more details.`
12739
13220
  pathParams: [
12740
13221
  {
12741
13222
  name: "id",
12742
- sdkName: "id"
13223
+ sdkName: "id",
13224
+ description: "Feedback identifier, prefixed with fb_."
12743
13225
  }
12744
13226
  ],
12745
13227
  query: [],
@@ -12997,7 +13479,8 @@ for more details.`
12997
13479
  pathParams: [
12998
13480
  {
12999
13481
  name: "sandboxID",
13000
- sdkName: "sandboxID"
13482
+ sdkName: "sandboxID",
13483
+ 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."
13001
13484
  }
13002
13485
  ],
13003
13486
  query: []
@@ -13014,7 +13497,8 @@ for more details.`
13014
13497
  pathParams: [
13015
13498
  {
13016
13499
  name: "sandboxID",
13017
- sdkName: "sandboxID"
13500
+ sdkName: "sandboxID",
13501
+ 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."
13018
13502
  }
13019
13503
  ],
13020
13504
  query: []
@@ -13031,7 +13515,8 @@ for more details.`
13031
13515
  pathParams: [
13032
13516
  {
13033
13517
  name: "sandboxID",
13034
- sdkName: "sandboxID"
13518
+ sdkName: "sandboxID",
13519
+ 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."
13035
13520
  }
13036
13521
  ],
13037
13522
  query: [],
@@ -13059,7 +13544,8 @@ for more details.`
13059
13544
  pathParams: [
13060
13545
  {
13061
13546
  name: "sandboxID",
13062
- sdkName: "sandboxID"
13547
+ sdkName: "sandboxID",
13548
+ 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."
13063
13549
  }
13064
13550
  ],
13065
13551
  query: [],
@@ -13093,7 +13579,8 @@ for more details.`
13093
13579
  pathParams: [
13094
13580
  {
13095
13581
  name: "sandboxID",
13096
- sdkName: "sandboxID"
13582
+ sdkName: "sandboxID",
13583
+ 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."
13097
13584
  }
13098
13585
  ],
13099
13586
  query: [],
@@ -13126,7 +13613,8 @@ for more details.`
13126
13613
  pathParams: [
13127
13614
  {
13128
13615
  name: "sandboxID",
13129
- sdkName: "sandboxID"
13616
+ sdkName: "sandboxID",
13617
+ 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."
13130
13618
  }
13131
13619
  ],
13132
13620
  query: [],
@@ -13160,7 +13648,8 @@ for more details.`
13160
13648
  pathParams: [
13161
13649
  {
13162
13650
  name: "sandboxID",
13163
- sdkName: "sandboxID"
13651
+ sdkName: "sandboxID",
13652
+ 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."
13164
13653
  }
13165
13654
  ],
13166
13655
  query: [
@@ -13218,7 +13707,8 @@ for more details.`
13218
13707
  pathParams: [
13219
13708
  {
13220
13709
  name: "sandboxID",
13221
- sdkName: "sandboxID"
13710
+ sdkName: "sandboxID",
13711
+ 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."
13222
13712
  }
13223
13713
  ],
13224
13714
  query: [
@@ -13248,7 +13738,8 @@ for more details.`
13248
13738
  pathParams: [
13249
13739
  {
13250
13740
  name: "sandboxID",
13251
- sdkName: "sandboxID"
13741
+ sdkName: "sandboxID",
13742
+ 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."
13252
13743
  }
13253
13744
  ],
13254
13745
  query: [],
@@ -13303,7 +13794,8 @@ for more details.`
13303
13794
  pathParams: [
13304
13795
  {
13305
13796
  name: "sandboxID",
13306
- sdkName: "sandboxID"
13797
+ sdkName: "sandboxID",
13798
+ 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."
13307
13799
  }
13308
13800
  ],
13309
13801
  query: [],
@@ -13331,7 +13823,8 @@ for more details.`
13331
13823
  pathParams: [
13332
13824
  {
13333
13825
  name: "sandboxID",
13334
- sdkName: "sandboxID"
13826
+ sdkName: "sandboxID",
13827
+ 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."
13335
13828
  }
13336
13829
  ],
13337
13830
  query: [
@@ -13360,11 +13853,13 @@ for more details.`
13360
13853
  pathParams: [
13361
13854
  {
13362
13855
  name: "sandboxID",
13363
- sdkName: "sandboxID"
13856
+ sdkName: "sandboxID",
13857
+ 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."
13364
13858
  },
13365
13859
  {
13366
13860
  name: "processID",
13367
- sdkName: "processID"
13861
+ sdkName: "processID",
13862
+ 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."
13368
13863
  }
13369
13864
  ],
13370
13865
  query: []
@@ -13381,7 +13876,8 @@ for more details.`
13381
13876
  pathParams: [
13382
13877
  {
13383
13878
  name: "sandboxID",
13384
- sdkName: "sandboxID"
13879
+ sdkName: "sandboxID",
13880
+ 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."
13385
13881
  }
13386
13882
  ],
13387
13883
  query: [],
@@ -13409,7 +13905,8 @@ for more details.`
13409
13905
  pathParams: [
13410
13906
  {
13411
13907
  name: "sandboxID",
13412
- sdkName: "sandboxID"
13908
+ sdkName: "sandboxID",
13909
+ 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."
13413
13910
  }
13414
13911
  ],
13415
13912
  query: [],
@@ -13437,7 +13934,8 @@ for more details.`
13437
13934
  pathParams: [
13438
13935
  {
13439
13936
  name: "sandboxID",
13440
- sdkName: "sandboxID"
13937
+ sdkName: "sandboxID",
13938
+ 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."
13441
13939
  }
13442
13940
  ],
13443
13941
  query: [],
@@ -13465,7 +13963,8 @@ for more details.`
13465
13963
  pathParams: [
13466
13964
  {
13467
13965
  name: "sandbox_id",
13468
- sdkName: "sandbox_id"
13966
+ sdkName: "sandbox_id",
13967
+ description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
13469
13968
  }
13470
13969
  ],
13471
13970
  query: [],
@@ -13511,7 +14010,8 @@ for more details.`
13511
14010
  pathParams: [
13512
14011
  {
13513
14012
  name: "sandbox_id",
13514
- sdkName: "sandbox_id"
14013
+ sdkName: "sandbox_id",
14014
+ description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
13515
14015
  }
13516
14016
  ],
13517
14017
  query: [
@@ -13535,7 +14035,8 @@ for more details.`
13535
14035
  pathParams: [
13536
14036
  {
13537
14037
  name: "sandbox_id",
13538
- sdkName: "sandbox_id"
14038
+ sdkName: "sandbox_id",
14039
+ description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
13539
14040
  }
13540
14041
  ],
13541
14042
  query: [
@@ -13559,7 +14060,8 @@ for more details.`
13559
14060
  pathParams: [
13560
14061
  {
13561
14062
  name: "sandbox_id",
13562
- sdkName: "sandbox_id"
14063
+ sdkName: "sandbox_id",
14064
+ description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
13563
14065
  }
13564
14066
  ],
13565
14067
  query: [],
@@ -13593,7 +14095,8 @@ for more details.`
13593
14095
  pathParams: [
13594
14096
  {
13595
14097
  name: "sandbox_id",
13596
- sdkName: "sandbox_id"
14098
+ sdkName: "sandbox_id",
14099
+ description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
13597
14100
  }
13598
14101
  ],
13599
14102
  query: [
@@ -13617,7 +14120,8 @@ for more details.`
13617
14120
  pathParams: [
13618
14121
  {
13619
14122
  name: "sandbox_id",
13620
- sdkName: "sandbox_id"
14123
+ sdkName: "sandbox_id",
14124
+ description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
13621
14125
  }
13622
14126
  ],
13623
14127
  query: [
@@ -13678,7 +14182,8 @@ for more details.`
13678
14182
  pathParams: [
13679
14183
  {
13680
14184
  name: "snapshotID",
13681
- sdkName: "snapshotID"
14185
+ sdkName: "snapshotID",
14186
+ 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."
13682
14187
  }
13683
14188
  ],
13684
14189
  query: []
@@ -13761,7 +14266,8 @@ for more details.`
13761
14266
  pathParams: [
13762
14267
  {
13763
14268
  name: "volumeID",
13764
- sdkName: "volumeID"
14269
+ sdkName: "volumeID",
14270
+ description: "Id of the team volume, the `volumeID` returned by createVolume or listVolumes."
13765
14271
  }
13766
14272
  ],
13767
14273
  query: []
@@ -13778,7 +14284,8 @@ for more details.`
13778
14284
  pathParams: [
13779
14285
  {
13780
14286
  name: "volumeID",
13781
- sdkName: "volumeID"
14287
+ sdkName: "volumeID",
14288
+ description: "Id of the team volume, the `volumeID` returned by createVolume or listVolumes."
13782
14289
  }
13783
14290
  ],
13784
14291
  query: []
@@ -14497,7 +15004,8 @@ for more details.`
14497
15004
  pathParams: [
14498
15005
  {
14499
15006
  name: "id",
14500
- sdkName: "id"
15007
+ sdkName: "id",
15008
+ description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
14501
15009
  }
14502
15010
  ],
14503
15011
  query: [
@@ -14521,7 +15029,8 @@ for more details.`
14521
15029
  pathParams: [
14522
15030
  {
14523
15031
  name: "id",
14524
- sdkName: "id"
15032
+ sdkName: "id",
15033
+ description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
14525
15034
  }
14526
15035
  ],
14527
15036
  query: [
@@ -14545,7 +15054,8 @@ for more details.`
14545
15054
  pathParams: [
14546
15055
  {
14547
15056
  name: "id",
14548
- sdkName: "id"
15057
+ sdkName: "id",
15058
+ description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
14549
15059
  }
14550
15060
  ],
14551
15061
  query: [
@@ -14586,7 +15096,8 @@ for more details.`
14586
15096
  pathParams: [
14587
15097
  {
14588
15098
  name: "id",
14589
- sdkName: "id"
15099
+ sdkName: "id",
15100
+ description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
14590
15101
  }
14591
15102
  ],
14592
15103
  query: [
@@ -14622,7 +15133,8 @@ for more details.`
14622
15133
  pathParams: [
14623
15134
  {
14624
15135
  name: "id",
14625
- sdkName: "id"
15136
+ sdkName: "id",
15137
+ description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
14626
15138
  }
14627
15139
  ],
14628
15140
  query: [
@@ -14667,11 +15179,13 @@ for more details.`
14667
15179
  pathParams: [
14668
15180
  {
14669
15181
  name: "id",
14670
- sdkName: "id"
15182
+ sdkName: "id",
15183
+ description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
14671
15184
  },
14672
15185
  {
14673
15186
  name: "content",
14674
- sdkName: "content"
15187
+ sdkName: "content",
15188
+ description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
14675
15189
  }
14676
15190
  ],
14677
15191
  query: [
@@ -14768,7 +15282,8 @@ for more details.`
14768
15282
  pathParams: [
14769
15283
  {
14770
15284
  name: "name",
14771
- sdkName: "name"
15285
+ sdkName: "name",
15286
+ description: "Label name from the repository label list."
14772
15287
  }
14773
15288
  ],
14774
15289
  query: [
@@ -14792,7 +15307,8 @@ for more details.`
14792
15307
  pathParams: [
14793
15308
  {
14794
15309
  name: "name",
14795
- sdkName: "name"
15310
+ sdkName: "name",
15311
+ description: "Label name from the repository label list."
14796
15312
  }
14797
15313
  ],
14798
15314
  query: [
@@ -14922,7 +15438,9 @@ for more details.`
14922
15438
  pathParams: [
14923
15439
  {
14924
15440
  name: "number",
14925
- sdkName: "number"
15441
+ sdkName: "number",
15442
+ type: "integer",
15443
+ description: "Milestone number shown by create and list; not the object id."
14926
15444
  }
14927
15445
  ],
14928
15446
  query: [
@@ -14946,7 +15464,9 @@ for more details.`
14946
15464
  pathParams: [
14947
15465
  {
14948
15466
  name: "number",
14949
- sdkName: "number"
15467
+ sdkName: "number",
15468
+ type: "integer",
15469
+ description: "Milestone number shown by create and list; not the object id."
14950
15470
  }
14951
15471
  ],
14952
15472
  query: [
@@ -14970,7 +15490,9 @@ for more details.`
14970
15490
  pathParams: [
14971
15491
  {
14972
15492
  name: "number",
14973
- sdkName: "number"
15493
+ sdkName: "number",
15494
+ type: "integer",
15495
+ description: "Milestone number shown by create and list; not the object id."
14974
15496
  }
14975
15497
  ],
14976
15498
  query: [
@@ -15157,7 +15679,9 @@ for more details.`
15157
15679
  pathParams: [
15158
15680
  {
15159
15681
  name: "number",
15160
- sdkName: "number"
15682
+ sdkName: "number",
15683
+ type: "integer",
15684
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15161
15685
  }
15162
15686
  ],
15163
15687
  query: [
@@ -15181,7 +15705,9 @@ for more details.`
15181
15705
  pathParams: [
15182
15706
  {
15183
15707
  name: "number",
15184
- sdkName: "number"
15708
+ sdkName: "number",
15709
+ type: "integer",
15710
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15185
15711
  }
15186
15712
  ],
15187
15713
  query: [
@@ -15275,7 +15801,9 @@ for more details.`
15275
15801
  pathParams: [
15276
15802
  {
15277
15803
  name: "number",
15278
- sdkName: "number"
15804
+ sdkName: "number",
15805
+ type: "integer",
15806
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15279
15807
  }
15280
15808
  ],
15281
15809
  query: [
@@ -15311,7 +15839,9 @@ for more details.`
15311
15839
  pathParams: [
15312
15840
  {
15313
15841
  name: "number",
15314
- sdkName: "number"
15842
+ sdkName: "number",
15843
+ type: "integer",
15844
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15315
15845
  }
15316
15846
  ],
15317
15847
  query: [
@@ -15352,7 +15882,9 @@ for more details.`
15352
15882
  pathParams: [
15353
15883
  {
15354
15884
  name: "number",
15355
- sdkName: "number"
15885
+ sdkName: "number",
15886
+ type: "integer",
15887
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15356
15888
  }
15357
15889
  ],
15358
15890
  query: [
@@ -15388,7 +15920,9 @@ for more details.`
15388
15920
  pathParams: [
15389
15921
  {
15390
15922
  name: "number",
15391
- sdkName: "number"
15923
+ sdkName: "number",
15924
+ type: "integer",
15925
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15392
15926
  }
15393
15927
  ],
15394
15928
  query: [
@@ -15423,11 +15957,15 @@ for more details.`
15423
15957
  pathParams: [
15424
15958
  {
15425
15959
  name: "number",
15426
- sdkName: "number"
15960
+ sdkName: "number",
15961
+ type: "integer",
15962
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15427
15963
  },
15428
15964
  {
15429
15965
  name: "n",
15430
- sdkName: "n"
15966
+ sdkName: "n",
15967
+ type: "integer",
15968
+ description: "Number of the other ticket in the relation or dependency."
15431
15969
  }
15432
15970
  ],
15433
15971
  query: [
@@ -15451,7 +15989,9 @@ for more details.`
15451
15989
  pathParams: [
15452
15990
  {
15453
15991
  name: "number",
15454
- sdkName: "number"
15992
+ sdkName: "number",
15993
+ type: "integer",
15994
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15455
15995
  }
15456
15996
  ],
15457
15997
  query: [
@@ -15487,7 +16027,9 @@ for more details.`
15487
16027
  pathParams: [
15488
16028
  {
15489
16029
  name: "number",
15490
- sdkName: "number"
16030
+ sdkName: "number",
16031
+ type: "integer",
16032
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15491
16033
  }
15492
16034
  ],
15493
16035
  query: [
@@ -15523,7 +16065,9 @@ for more details.`
15523
16065
  pathParams: [
15524
16066
  {
15525
16067
  name: "number",
15526
- sdkName: "number"
16068
+ sdkName: "number",
16069
+ type: "integer",
16070
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15527
16071
  }
15528
16072
  ],
15529
16073
  query: [
@@ -15547,7 +16091,9 @@ for more details.`
15547
16091
  pathParams: [
15548
16092
  {
15549
16093
  name: "number",
15550
- sdkName: "number"
16094
+ sdkName: "number",
16095
+ type: "integer",
16096
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15551
16097
  }
15552
16098
  ],
15553
16099
  query: [
@@ -15588,7 +16134,9 @@ for more details.`
15588
16134
  pathParams: [
15589
16135
  {
15590
16136
  name: "number",
15591
- sdkName: "number"
16137
+ sdkName: "number",
16138
+ type: "integer",
16139
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15592
16140
  }
15593
16141
  ],
15594
16142
  query: [
@@ -15624,7 +16172,9 @@ for more details.`
15624
16172
  pathParams: [
15625
16173
  {
15626
16174
  name: "number",
15627
- sdkName: "number"
16175
+ sdkName: "number",
16176
+ type: "integer",
16177
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15628
16178
  }
15629
16179
  ],
15630
16180
  query: [
@@ -15669,11 +16219,14 @@ for more details.`
15669
16219
  pathParams: [
15670
16220
  {
15671
16221
  name: "number",
15672
- sdkName: "number"
16222
+ sdkName: "number",
16223
+ type: "integer",
16224
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15673
16225
  },
15674
16226
  {
15675
16227
  name: "content",
15676
- sdkName: "content"
16228
+ sdkName: "content",
16229
+ description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
15677
16230
  }
15678
16231
  ],
15679
16232
  query: [
@@ -15697,7 +16250,9 @@ for more details.`
15697
16250
  pathParams: [
15698
16251
  {
15699
16252
  name: "number",
15700
- sdkName: "number"
16253
+ sdkName: "number",
16254
+ type: "integer",
16255
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15701
16256
  }
15702
16257
  ],
15703
16258
  query: [
@@ -15733,7 +16288,9 @@ for more details.`
15733
16288
  pathParams: [
15734
16289
  {
15735
16290
  name: "number",
15736
- sdkName: "number"
16291
+ sdkName: "number",
16292
+ type: "integer",
16293
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15737
16294
  }
15738
16295
  ],
15739
16296
  query: [
@@ -15768,11 +16325,15 @@ for more details.`
15768
16325
  pathParams: [
15769
16326
  {
15770
16327
  name: "number",
15771
- sdkName: "number"
16328
+ sdkName: "number",
16329
+ type: "integer",
16330
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15772
16331
  },
15773
16332
  {
15774
16333
  name: "n",
15775
- sdkName: "n"
16334
+ sdkName: "n",
16335
+ type: "integer",
16336
+ description: "Number of the other ticket in the relation or dependency."
15776
16337
  }
15777
16338
  ],
15778
16339
  query: [
@@ -15796,7 +16357,9 @@ for more details.`
15796
16357
  pathParams: [
15797
16358
  {
15798
16359
  name: "number",
15799
- sdkName: "number"
16360
+ sdkName: "number",
16361
+ type: "integer",
16362
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15800
16363
  }
15801
16364
  ],
15802
16365
  query: [
@@ -15832,7 +16395,9 @@ for more details.`
15832
16395
  pathParams: [
15833
16396
  {
15834
16397
  name: "number",
15835
- sdkName: "number"
16398
+ sdkName: "number",
16399
+ type: "integer",
16400
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15836
16401
  }
15837
16402
  ],
15838
16403
  query: [
@@ -15873,11 +16438,15 @@ for more details.`
15873
16438
  pathParams: [
15874
16439
  {
15875
16440
  name: "number",
15876
- sdkName: "number"
16441
+ sdkName: "number",
16442
+ type: "integer",
16443
+ description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
15877
16444
  },
15878
16445
  {
15879
16446
  name: "child",
15880
- sdkName: "child"
16447
+ sdkName: "child",
16448
+ type: "integer",
16449
+ description: "Number of the sub-ticket to detach."
15881
16450
  }
15882
16451
  ],
15883
16452
  query: [
@@ -15977,7 +16546,8 @@ for more details.`
15977
16546
  pathParams: [
15978
16547
  {
15979
16548
  name: "authorization_id",
15980
- sdkName: "authorization_id"
16549
+ sdkName: "authorization_id",
16550
+ description: "ID of the authorization in your account, returned when authorization is created."
15981
16551
  }
15982
16552
  ],
15983
16553
  query: []
@@ -15994,7 +16564,8 @@ for more details.`
15994
16564
  pathParams: [
15995
16565
  {
15996
16566
  name: "token",
15997
- sdkName: "token"
16567
+ sdkName: "token",
16568
+ description: "One-time token from connect_url."
15998
16569
  }
15999
16570
  ],
16000
16571
  query: []
@@ -16011,7 +16582,8 @@ for more details.`
16011
16582
  pathParams: [
16012
16583
  {
16013
16584
  name: "token",
16014
- sdkName: "token"
16585
+ sdkName: "token",
16586
+ description: "One-time token from connect_url."
16015
16587
  }
16016
16588
  ],
16017
16589
  query: []
@@ -16028,7 +16600,8 @@ for more details.`
16028
16600
  pathParams: [
16029
16601
  {
16030
16602
  name: "token",
16031
- sdkName: "token"
16603
+ sdkName: "token",
16604
+ description: "One-time token from connect_url."
16032
16605
  }
16033
16606
  ],
16034
16607
  query: []
@@ -16165,7 +16738,8 @@ for more details.`
16165
16738
  pathParams: [
16166
16739
  {
16167
16740
  name: "vault_id",
16168
- sdkName: "vault_id"
16741
+ sdkName: "vault_id",
16742
+ description: "ID of the vault in your account, returned when the vault is created."
16169
16743
  }
16170
16744
  ],
16171
16745
  query: []
@@ -16182,7 +16756,8 @@ for more details.`
16182
16756
  pathParams: [
16183
16757
  {
16184
16758
  name: "vault_id",
16185
- sdkName: "vault_id"
16759
+ sdkName: "vault_id",
16760
+ description: "ID of the vault in your account, returned when the vault is created."
16186
16761
  }
16187
16762
  ],
16188
16763
  query: []
@@ -16199,7 +16774,8 @@ for more details.`
16199
16774
  pathParams: [
16200
16775
  {
16201
16776
  name: "vault_id",
16202
- sdkName: "vault_id"
16777
+ sdkName: "vault_id",
16778
+ description: "ID of the vault in your account, returned when the vault is created."
16203
16779
  }
16204
16780
  ],
16205
16781
  query: [],
@@ -16233,7 +16809,8 @@ for more details.`
16233
16809
  pathParams: [
16234
16810
  {
16235
16811
  name: "vault_id",
16236
- sdkName: "vault_id"
16812
+ sdkName: "vault_id",
16813
+ description: "ID of the vault in your account, returned when the vault is created."
16237
16814
  }
16238
16815
  ],
16239
16816
  query: []
@@ -16250,7 +16827,8 @@ for more details.`
16250
16827
  pathParams: [
16251
16828
  {
16252
16829
  name: "vault_id",
16253
- sdkName: "vault_id"
16830
+ sdkName: "vault_id",
16831
+ description: "ID of the vault in your account, returned when the vault is created."
16254
16832
  }
16255
16833
  ],
16256
16834
  query: [
@@ -16286,7 +16864,8 @@ for more details.`
16286
16864
  pathParams: [
16287
16865
  {
16288
16866
  name: "vault_id",
16289
- sdkName: "vault_id"
16867
+ sdkName: "vault_id",
16868
+ description: "ID of the vault in your account, returned when the vault is created."
16290
16869
  }
16291
16870
  ],
16292
16871
  query: [
@@ -16322,7 +16901,8 @@ for more details.`
16322
16901
  pathParams: [
16323
16902
  {
16324
16903
  name: "vault_id",
16325
- sdkName: "vault_id"
16904
+ sdkName: "vault_id",
16905
+ description: "ID of the vault in your account, returned when the vault is created."
16326
16906
  }
16327
16907
  ],
16328
16908
  query: [],
@@ -16396,11 +16976,13 @@ for more details.`
16396
16976
  pathParams: [
16397
16977
  {
16398
16978
  name: "vault_id",
16399
- sdkName: "vault_id"
16979
+ sdkName: "vault_id",
16980
+ description: "ID of the vault in your account, returned when the vault is created."
16400
16981
  },
16401
16982
  {
16402
16983
  name: "secret",
16403
- sdkName: "secret"
16984
+ sdkName: "secret",
16985
+ description: "Secret name, or its vsec_ ID."
16404
16986
  }
16405
16987
  ],
16406
16988
  query: []
@@ -16417,11 +16999,13 @@ for more details.`
16417
16999
  pathParams: [
16418
17000
  {
16419
17001
  name: "vault_id",
16420
- sdkName: "vault_id"
17002
+ sdkName: "vault_id",
17003
+ description: "ID of the vault in your account, returned when the vault is created."
16421
17004
  },
16422
17005
  {
16423
17006
  name: "secret",
16424
- sdkName: "secret"
17007
+ sdkName: "secret",
17008
+ description: "Secret name, or its vsec_ ID."
16425
17009
  }
16426
17010
  ],
16427
17011
  query: []
@@ -16438,11 +17022,13 @@ for more details.`
16438
17022
  pathParams: [
16439
17023
  {
16440
17024
  name: "vault_id",
16441
- sdkName: "vault_id"
17025
+ sdkName: "vault_id",
17026
+ description: "ID of the vault in your account, returned when the vault is created."
16442
17027
  },
16443
17028
  {
16444
17029
  name: "secret",
16445
- sdkName: "secret"
17030
+ sdkName: "secret",
17031
+ description: "Secret name, or its vsec_ ID."
16446
17032
  }
16447
17033
  ],
16448
17034
  query: [],
@@ -16489,11 +17075,13 @@ for more details.`
16489
17075
  pathParams: [
16490
17076
  {
16491
17077
  name: "vault_id",
16492
- sdkName: "vault_id"
17078
+ sdkName: "vault_id",
17079
+ description: "ID of the vault in your account, returned when the vault is created."
16493
17080
  },
16494
17081
  {
16495
17082
  name: "secret",
16496
- sdkName: "secret"
17083
+ sdkName: "secret",
17084
+ description: "Secret name, or its vsec_ ID."
16497
17085
  }
16498
17086
  ],
16499
17087
  query: []
@@ -16510,11 +17098,13 @@ for more details.`
16510
17098
  pathParams: [
16511
17099
  {
16512
17100
  name: "vault_id",
16513
- sdkName: "vault_id"
17101
+ sdkName: "vault_id",
17102
+ description: "ID of the vault in your account, returned when the vault is created."
16514
17103
  },
16515
17104
  {
16516
17105
  name: "secret",
16517
- sdkName: "secret"
17106
+ sdkName: "secret",
17107
+ description: "Secret name, or its vsec_ ID."
16518
17108
  }
16519
17109
  ],
16520
17110
  query: [],
@@ -16545,11 +17135,13 @@ for more details.`
16545
17135
  pathParams: [
16546
17136
  {
16547
17137
  name: "vault_id",
16548
- sdkName: "vault_id"
17138
+ sdkName: "vault_id",
17139
+ description: "ID of the vault in your account, returned when the vault is created."
16549
17140
  },
16550
17141
  {
16551
17142
  name: "secret",
16552
- sdkName: "secret"
17143
+ sdkName: "secret",
17144
+ description: "Secret name, or its vsec_ ID."
16553
17145
  }
16554
17146
  ],
16555
17147
  query: []
@@ -16566,7 +17158,8 @@ for more details.`
16566
17158
  pathParams: [
16567
17159
  {
16568
17160
  name: "vault_id",
16569
- sdkName: "vault_id"
17161
+ sdkName: "vault_id",
17162
+ description: "ID of the vault in your account, returned when the vault is created."
16570
17163
  }
16571
17164
  ],
16572
17165
  query: [],
@@ -17817,6 +18410,57 @@ var unblockEndUser = (options) => (options.client ?? client).post({
17817
18410
  url: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock",
17818
18411
  ...options
17819
18412
  });
18413
+ var createCustomerGrantCode = (options) => (options.client ?? client).post({
18414
+ security: [{
18415
+ key: "BearerAuth",
18416
+ scheme: "bearer",
18417
+ type: "http"
18418
+ }, {
18419
+ key: "ApiKeyAuth",
18420
+ name: "X-API-Key",
18421
+ type: "apiKey"
18422
+ }],
18423
+ url: "/agent/v1/agents/{agent_id}/customers/auth/grant_codes",
18424
+ ...options,
18425
+ headers: {
18426
+ "Content-Type": "application/json",
18427
+ ...options.headers
18428
+ }
18429
+ });
18430
+ var createCustomerAccessToken = (options) => (options.client ?? client).post({
18431
+ url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens",
18432
+ ...options,
18433
+ headers: {
18434
+ "Content-Type": "application/json",
18435
+ ...options.headers
18436
+ }
18437
+ });
18438
+ var renewCustomerAccessToken = (options) => (options.client ?? client).post({
18439
+ security: [{
18440
+ key: "BearerAuth",
18441
+ scheme: "bearer",
18442
+ type: "http"
18443
+ }, {
18444
+ key: "ApiKeyAuth",
18445
+ name: "X-API-Key",
18446
+ type: "apiKey"
18447
+ }],
18448
+ url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew",
18449
+ ...options
18450
+ });
18451
+ var deleteCurrentCustomerAccessToken = (options) => (options.client ?? client).delete({
18452
+ security: [{
18453
+ key: "BearerAuth",
18454
+ scheme: "bearer",
18455
+ type: "http"
18456
+ }, {
18457
+ key: "ApiKeyAuth",
18458
+ name: "X-API-Key",
18459
+ type: "apiKey"
18460
+ }],
18461
+ url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current",
18462
+ ...options
18463
+ });
17820
18464
  var exchangeEmbedCode = (options) => (options.client ?? client).post({
17821
18465
  url: "/agent/v1/embed/exchange",
17822
18466
  ...options,
@@ -23533,6 +24177,20 @@ function createAgent(transport) {
23533
24177
  agents: {
23534
24178
  archive: bind(transport, agentsArchive),
23535
24179
  create: bind(transport, agentsCreate),
24180
+ customers: {
24181
+ auth: {
24182
+ accessTokens: {
24183
+ create: bind(transport, createCustomerAccessToken),
24184
+ deleteCurrent: bind(transport, deleteCurrentCustomerAccessToken),
24185
+ renew: {
24186
+ create: bind(transport, renewCustomerAccessToken)
24187
+ }
24188
+ },
24189
+ grantCodes: {
24190
+ create: bind(transport, createCustomerGrantCode)
24191
+ }
24192
+ }
24193
+ },
23536
24194
  endUsers: {
23537
24195
  block: {
23538
24196
  create: bind(transport, blockEndUser)
@@ -24970,7 +25628,7 @@ function operationOptions(op) {
24970
25628
  if (p === target)
24971
25629
  continue;
24972
25630
  const before = op.path.slice(0, op.path.indexOf(`{${p.name}}`)).split("/").filter(Boolean).at(-1);
24973
- specs.push({ name: before.startsWith("{") ? kebab(p.sdkName) : singular(kebab(before)), type: "string", required: true, location: "path", sdkName: p.sdkName });
25631
+ specs.push({ name: before.startsWith("{") ? kebab(p.sdkName) : singular(kebab(before)), type: p.type ?? "string", required: true, location: "path", sdkName: p.sdkName, ...p.description ? { description: p.description } : {} });
24974
25632
  }
24975
25633
  for (const location of ["query", "body"]) {
24976
25634
  const fields = location === "query" ? op.query : op.body?.fields ?? [];
@@ -25068,7 +25726,7 @@ function convert(value, spec) {
25068
25726
  } else if (spec.type === "number" || spec.type === "integer") {
25069
25727
  const n = typeof value === "string" && value.trim() ? Number(value) : NaN;
25070
25728
  if (!Number.isFinite(n) || spec.type === "integer" && !Number.isSafeInteger(n))
25071
- throw new UsageError(`--${spec.name} must be ${spec.type}`);
25729
+ throw new UsageError(`--${spec.name} must be ${spec.type}`, spec.location === "path" ? spec.description : undefined);
25072
25730
  result = n;
25073
25731
  } else if (typeof value !== "string")
25074
25732
  throw new UsageError(`--${spec.name} requires a value`);
@@ -25116,8 +25774,13 @@ function bindArgs(parsed, op, data) {
25116
25774
  if (target) {
25117
25775
  if (parsed.positional[0] === undefined)
25118
25776
  missing.push(`<${target.sdkName}> (target ID)`);
25119
- else
25120
- opts.path = { [target.sdkName]: parsed.positional[0] };
25777
+ else {
25778
+ const raw = parsed.positional[0];
25779
+ if (target.type && !(target.type === "integer" ? Number.isSafeInteger(Number(raw)) : Number.isFinite(Number(raw))) || target.type && !raw.trim()) {
25780
+ throw new UsageError(`<${target.sdkName}> must be ${target.type}`, target.description);
25781
+ }
25782
+ opts.path = { [target.sdkName]: target.type ? Number(raw) : raw };
25783
+ }
25121
25784
  }
25122
25785
  if (data !== undefined)
25123
25786
  opts.body = data;
@@ -25194,9 +25857,10 @@ function help(commands, prefix, command) {
25194
25857
  `praxis ${command.words.join(" ")}${target ? ` <${target.sdkName}>` : ""} [options]`,
25195
25858
  `SDK: ${command.op.resource}.${command.alias ?? command.op.method}`,
25196
25859
  `${command.op.http} ${command.op.path}`,
25197
- ...target ? [`Position: <${target.sdkName}> (required target ID)`] : [],
25860
+ ...target ? [`Position: <${target.sdkName}>${target.type ? ` <${target.type}>` : ""} (required target ID)`] : [],
25198
25861
  "",
25199
25862
  "Options:",
25863
+ ...target?.description ? [` <${target.sdkName}> — ${target.description.replace(/\s+/g, " ")}`] : [],
25200
25864
  ...[...operationOptions(command.op), ...command.op.body ? [dataOption] : [], ...globalOptions].map((s) => ` ${describeOption(s)}`),
25201
25865
  ...command.op.body?.fields.filter((f) => f.type === "object" || f.type === "array" && !["string", "number", "integer", "boolean"].includes(f.itemType ?? "")).map((f) => ` --data: ${f.name} (${f.type}${f.required ? ", required" : ""})`) ?? [],
25202
25866
  " -h is an alias of --help",
@@ -26377,7 +27041,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
26377
27041
  }
26378
27042
 
26379
27043
  // src/main.ts
26380
- var version = "0.1.0-dev.ff6425a";
27044
+ var version = "0.1.1-dev.69cffcf";
26381
27045
  var commands = commandTree(operations);
26382
27046
  var manual = [["login"], ["logout"], ["whoami"], ["org", "list"], ["org", "switch"], ["api"], ["skill"]];
26383
27047
  function route(argv) {