@deepraxis/cli 0.1.0-dev.ff6425a → 0.1.1-dev.54635ff
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.
- package/COMMANDS.md +17 -5
- package/dist/praxis.js +1524 -510
- 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:
|
|
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: "
|
|
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: "
|
|
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:
|
|
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
|
|
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
|
|
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.
|
|
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.
|
|
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: "
|
|
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:
|
|
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:
|
|
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
|
|
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
|
|
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",
|
|
@@ -438,6 +451,26 @@ current version; omit to apply the update unconditionally.`
|
|
|
438
451
|
]
|
|
439
452
|
}
|
|
440
453
|
},
|
|
454
|
+
{
|
|
455
|
+
resource: "agent.agents",
|
|
456
|
+
method: "retrieveAppearance",
|
|
457
|
+
summary: "Get agent appearance",
|
|
458
|
+
description: `Read the saved chat appearance of a service agent.
|
|
459
|
+
|
|
460
|
+
Agent Kit calls this from the page with a customer access token of this agent; your API key and console members can read it too. A token of another agent returns 404. The body is the same as the embed appearance read; a missing appearance returns the agent's own name and avatar only. Responses are private and cacheable for 60 seconds.`,
|
|
461
|
+
http: "GET",
|
|
462
|
+
path: "/agent/v1/agents/{agent_id}/appearance",
|
|
463
|
+
streaming: "no",
|
|
464
|
+
pagination: false,
|
|
465
|
+
pathParams: [
|
|
466
|
+
{
|
|
467
|
+
name: "agent_id",
|
|
468
|
+
sdkName: "agent_id",
|
|
469
|
+
description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for."
|
|
470
|
+
}
|
|
471
|
+
],
|
|
472
|
+
query: []
|
|
473
|
+
},
|
|
441
474
|
{
|
|
442
475
|
resource: "agent.agents",
|
|
443
476
|
method: "archive",
|
|
@@ -450,7 +483,376 @@ current version; omit to apply the update unconditionally.`
|
|
|
450
483
|
pathParams: [
|
|
451
484
|
{
|
|
452
485
|
name: "agent_id",
|
|
453
|
-
sdkName: "agent_id"
|
|
486
|
+
sdkName: "agent_id",
|
|
487
|
+
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."
|
|
488
|
+
}
|
|
489
|
+
],
|
|
490
|
+
query: []
|
|
491
|
+
},
|
|
492
|
+
{
|
|
493
|
+
resource: "agent.agents.customers",
|
|
494
|
+
method: "list",
|
|
495
|
+
summary: "List customers",
|
|
496
|
+
description: `List the customers of a service agent, identified and anonymous, most recently seen first.
|
|
497
|
+
|
|
498
|
+
Call this from your backend with your API key, or from the console. Customers follow Shopify Admin customers (list, retrieve, block, sign-out and data deletion of the people who use your storefront), so that experience applies. The list includes customers who signed in but have not started a session yet, and customers recorded under your own ids by embed tokens before customer sign-in existed; an id first seen that way is identified unless it starts with anon_. Unlike Shopify, a customer can be anonymous: a visitor admitted with the publishable key gets an anon_ id, and when it later signs in with anonymous_access_token it is merged: merged_into names the identified customer, and its sessions count toward that customer. Filter with q (a case-sensitive customer id prefix), type (identified or anonymous) and blocked (true or false). limit is 1 to 100, default 20; reuse next_page with the same filters and limit. A customer access token gets 404. Example: GET /agent/v1/agents/agent_example/customers?type=identified&blocked=false&limit=50.`,
|
|
499
|
+
http: "GET",
|
|
500
|
+
path: "/agent/v1/agents/{agent_id}/customers",
|
|
501
|
+
streaming: "no",
|
|
502
|
+
pagination: false,
|
|
503
|
+
pathParams: [
|
|
504
|
+
{
|
|
505
|
+
name: "agent_id",
|
|
506
|
+
sdkName: "agent_id",
|
|
507
|
+
description: "Active service agent id from agent creation or listing."
|
|
508
|
+
}
|
|
509
|
+
],
|
|
510
|
+
query: [
|
|
511
|
+
{
|
|
512
|
+
name: "limit",
|
|
513
|
+
type: "integer",
|
|
514
|
+
required: false,
|
|
515
|
+
description: "Maximum customers per page, 1 to 100; defaults to 20."
|
|
516
|
+
},
|
|
517
|
+
{
|
|
518
|
+
name: "page",
|
|
519
|
+
type: "string",
|
|
520
|
+
required: false,
|
|
521
|
+
description: "next_page from the previous response with the same q, type, blocked and limit."
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
name: "q",
|
|
525
|
+
type: "string",
|
|
526
|
+
required: false,
|
|
527
|
+
description: "Case-sensitive literal prefix of the customer id; omit for all customers."
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
name: "type",
|
|
531
|
+
type: "string",
|
|
532
|
+
enum: [
|
|
533
|
+
"identified",
|
|
534
|
+
"anonymous"
|
|
535
|
+
],
|
|
536
|
+
required: false,
|
|
537
|
+
description: "Only identified or only anonymous customers; omit for both."
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
name: "blocked",
|
|
541
|
+
type: "boolean",
|
|
542
|
+
required: false,
|
|
543
|
+
description: "true for blocked customers only, false for customers who are not blocked; omit for both."
|
|
544
|
+
}
|
|
545
|
+
]
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
resource: "agent.agents.customers.auth.accessTokens",
|
|
549
|
+
method: "create",
|
|
550
|
+
summary: "Create customer access token",
|
|
551
|
+
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.
|
|
552
|
+
|
|
553
|
+
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_…"}.`,
|
|
554
|
+
http: "POST",
|
|
555
|
+
path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens",
|
|
556
|
+
streaming: "no",
|
|
557
|
+
pagination: false,
|
|
558
|
+
pathParams: [
|
|
559
|
+
{
|
|
560
|
+
name: "agent_id",
|
|
561
|
+
sdkName: "agent_id",
|
|
562
|
+
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
|
|
563
|
+
}
|
|
564
|
+
],
|
|
565
|
+
query: [],
|
|
566
|
+
body: {
|
|
567
|
+
required: true,
|
|
568
|
+
fields: []
|
|
569
|
+
}
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
resource: "agent.agents.customers.auth.accessTokens",
|
|
573
|
+
method: "deleteCurrent",
|
|
574
|
+
summary: "Log out customer",
|
|
575
|
+
description: `Log the customer out by revoking the sign-in of the presented access token and every token issued in it.
|
|
576
|
+
|
|
577
|
+
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.`,
|
|
578
|
+
http: "DELETE",
|
|
579
|
+
path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current",
|
|
580
|
+
streaming: "no",
|
|
581
|
+
pagination: false,
|
|
582
|
+
pathParams: [
|
|
583
|
+
{
|
|
584
|
+
name: "agent_id",
|
|
585
|
+
sdkName: "agent_id",
|
|
586
|
+
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
|
|
587
|
+
}
|
|
588
|
+
],
|
|
589
|
+
query: []
|
|
590
|
+
},
|
|
591
|
+
{
|
|
592
|
+
resource: "agent.agents.customers.auth.accessTokens.renew",
|
|
593
|
+
method: "create",
|
|
594
|
+
summary: "Renew customer access token",
|
|
595
|
+
description: `Get a fresh customer access token in the same sign-in, authenticated with the current one.
|
|
596
|
+
|
|
597
|
+
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.`,
|
|
598
|
+
http: "POST",
|
|
599
|
+
path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew",
|
|
600
|
+
streaming: "no",
|
|
601
|
+
pagination: false,
|
|
602
|
+
pathParams: [
|
|
603
|
+
{
|
|
604
|
+
name: "agent_id",
|
|
605
|
+
sdkName: "agent_id",
|
|
606
|
+
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
|
|
607
|
+
}
|
|
608
|
+
],
|
|
609
|
+
query: []
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
resource: "agent.agents.customers.auth.grantCodes",
|
|
613
|
+
method: "create",
|
|
614
|
+
summary: "Create customer grant code",
|
|
615
|
+
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.
|
|
616
|
+
|
|
617
|
+
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"}.`,
|
|
618
|
+
http: "POST",
|
|
619
|
+
path: "/agent/v1/agents/{agent_id}/customers/auth/grant_codes",
|
|
620
|
+
streaming: "no",
|
|
621
|
+
pagination: false,
|
|
622
|
+
pathParams: [
|
|
623
|
+
{
|
|
624
|
+
name: "agent_id",
|
|
625
|
+
sdkName: "agent_id",
|
|
626
|
+
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
|
|
627
|
+
}
|
|
628
|
+
],
|
|
629
|
+
query: [],
|
|
630
|
+
body: {
|
|
631
|
+
required: true,
|
|
632
|
+
fields: [
|
|
633
|
+
{
|
|
634
|
+
name: "customer_id",
|
|
635
|
+
type: "string",
|
|
636
|
+
required: true,
|
|
637
|
+
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.'
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
name: "version",
|
|
641
|
+
type: "integer",
|
|
642
|
+
required: false,
|
|
643
|
+
description: "Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued."
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
name: "budget",
|
|
647
|
+
type: "object",
|
|
648
|
+
required: false,
|
|
649
|
+
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."
|
|
650
|
+
},
|
|
651
|
+
{
|
|
652
|
+
name: "system_message",
|
|
653
|
+
type: "array",
|
|
654
|
+
itemType: "object",
|
|
655
|
+
required: false,
|
|
656
|
+
description: "Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total."
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
name: "agent_override",
|
|
660
|
+
type: "object",
|
|
661
|
+
required: false,
|
|
662
|
+
description: "Optional system prompt override, accepted only when the embed policy allows agent overrides."
|
|
663
|
+
},
|
|
664
|
+
{
|
|
665
|
+
name: "metadata",
|
|
666
|
+
type: "object",
|
|
667
|
+
required: false,
|
|
668
|
+
description: "Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved."
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
name: "origin",
|
|
672
|
+
type: "string",
|
|
673
|
+
required: false,
|
|
674
|
+
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."
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
name: "expires_in",
|
|
678
|
+
type: "integer",
|
|
679
|
+
required: false,
|
|
680
|
+
description: "Seconds the code stays redeemable, from 60 to 86400. Defaults to 900."
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
name: "max_session_seconds",
|
|
684
|
+
type: "integer",
|
|
685
|
+
required: false,
|
|
686
|
+
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."
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
name: "anonymous_access_token",
|
|
690
|
+
type: "string",
|
|
691
|
+
required: false,
|
|
692
|
+
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."
|
|
693
|
+
},
|
|
694
|
+
{
|
|
695
|
+
name: "hosted",
|
|
696
|
+
type: "boolean",
|
|
697
|
+
required: false,
|
|
698
|
+
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."
|
|
699
|
+
}
|
|
700
|
+
]
|
|
701
|
+
}
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
resource: "agent.agents.customers",
|
|
705
|
+
method: "delete",
|
|
706
|
+
summary: "Delete customer data",
|
|
707
|
+
description: `Delete a customer's data from one service agent after explicit confirmation.
|
|
708
|
+
|
|
709
|
+
Develop only. Set confirm to the exact customer id; a missing or different confirm returns 400 naming the value to send. Returns 202 with a pending task id; poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the customer is blocked before a seven-day recovery snapshot is verified; sessions including child sessions, conversation data, grants and feedback are then removed. A block that existed before stays; a temporary block is removed on success. File attachments are retained. Example: DELETE /agent/v1/agents/agent_example/customers/cus_8f2a91?confirm=cus_8f2a91.`,
|
|
710
|
+
http: "DELETE",
|
|
711
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}",
|
|
712
|
+
streaming: "no",
|
|
713
|
+
pagination: false,
|
|
714
|
+
pathParams: [
|
|
715
|
+
{
|
|
716
|
+
name: "agent_id",
|
|
717
|
+
sdkName: "agent_id",
|
|
718
|
+
description: "Active service agent id from agent creation or listing."
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
name: "customer_id",
|
|
722
|
+
sdkName: "customer_id",
|
|
723
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
724
|
+
}
|
|
725
|
+
],
|
|
726
|
+
query: [
|
|
727
|
+
{
|
|
728
|
+
name: "confirm",
|
|
729
|
+
type: "string",
|
|
730
|
+
required: true,
|
|
731
|
+
description: "Must equal the customer_id path parameter exactly, confirming the destructive deletion."
|
|
732
|
+
}
|
|
733
|
+
]
|
|
734
|
+
},
|
|
735
|
+
{
|
|
736
|
+
resource: "agent.agents.customers",
|
|
737
|
+
method: "retrieve",
|
|
738
|
+
summary: "Get customer",
|
|
739
|
+
description: `Retrieve one customer of a service agent with its twenty most recently updated sessions.
|
|
740
|
+
|
|
741
|
+
Use the customer id from the list or your own customer_id. An unknown customer returns 404 CUSTOMER_NOT_FOUND, and so does a customer access token. Unlike Shopify, an identified customer's session_count, cost and recent_sessions include the sessions of anonymous customers merged into it; the merged anonymous customer still shows its own sessions and its merged_into.`,
|
|
742
|
+
http: "GET",
|
|
743
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}",
|
|
744
|
+
streaming: "no",
|
|
745
|
+
pagination: false,
|
|
746
|
+
pathParams: [
|
|
747
|
+
{
|
|
748
|
+
name: "agent_id",
|
|
749
|
+
sdkName: "agent_id",
|
|
750
|
+
description: "Active service agent id from agent creation or listing."
|
|
751
|
+
},
|
|
752
|
+
{
|
|
753
|
+
name: "customer_id",
|
|
754
|
+
sdkName: "customer_id",
|
|
755
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
756
|
+
}
|
|
757
|
+
],
|
|
758
|
+
query: []
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
resource: "agent.agents.customers.block",
|
|
762
|
+
method: "create",
|
|
763
|
+
summary: "Block customer",
|
|
764
|
+
description: `Block a customer and end every sign-in it has on this agent.
|
|
765
|
+
|
|
766
|
+
Blocks the customer, then ends every live sign-in the way logout does: each access token is revoked and its open event streams close. From then on grant_codes, access_tokens, renew and new sessions for this customer return CUSTOMER_BLOCKED until you unblock it. Idempotent: a repeat keeps the first block time and revokes whatever is still live. If credential revocation fails the request returns 502 and the customer stays blocked; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.`,
|
|
767
|
+
http: "POST",
|
|
768
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/block",
|
|
769
|
+
streaming: "no",
|
|
770
|
+
pagination: false,
|
|
771
|
+
pathParams: [
|
|
772
|
+
{
|
|
773
|
+
name: "agent_id",
|
|
774
|
+
sdkName: "agent_id",
|
|
775
|
+
description: "Active service agent id from agent creation or listing."
|
|
776
|
+
},
|
|
777
|
+
{
|
|
778
|
+
name: "customer_id",
|
|
779
|
+
sdkName: "customer_id",
|
|
780
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
781
|
+
}
|
|
782
|
+
],
|
|
783
|
+
query: []
|
|
784
|
+
},
|
|
785
|
+
{
|
|
786
|
+
resource: "agent.agents.customers",
|
|
787
|
+
method: "retrieveDeletion",
|
|
788
|
+
summary: "Get customer deletion",
|
|
789
|
+
description: `Poll the latest deletion task of a customer, including after its data has been removed.
|
|
790
|
+
|
|
791
|
+
Use the same agent_id and customer id as the confirmed DELETE. Status is pending, snapshotting, deleting, done or failed. Counts are empty until a verified snapshot exists. snapshot_key is an operator recovery reference retained for seven days, not a download URL. A customer access token and a missing task return 404.`,
|
|
792
|
+
http: "GET",
|
|
793
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion",
|
|
794
|
+
streaming: "no",
|
|
795
|
+
pagination: false,
|
|
796
|
+
pathParams: [
|
|
797
|
+
{
|
|
798
|
+
name: "agent_id",
|
|
799
|
+
sdkName: "agent_id",
|
|
800
|
+
description: "Active service agent id from agent creation or listing."
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
name: "customer_id",
|
|
804
|
+
sdkName: "customer_id",
|
|
805
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
806
|
+
}
|
|
807
|
+
],
|
|
808
|
+
query: []
|
|
809
|
+
},
|
|
810
|
+
{
|
|
811
|
+
resource: "agent.agents.customers.revokeTokens",
|
|
812
|
+
method: "create",
|
|
813
|
+
summary: "Revoke customer tokens",
|
|
814
|
+
description: `Sign a customer out everywhere without blocking it.
|
|
815
|
+
|
|
816
|
+
Ends every live sign-in of the customer, revoking each access token and closing its open event streams; the customer can sign in again right away. Returns the number of access tokens this request revoked; a repeat returns 0. Credential revocation failure returns 502; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.`,
|
|
817
|
+
http: "POST",
|
|
818
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens",
|
|
819
|
+
streaming: "no",
|
|
820
|
+
pagination: false,
|
|
821
|
+
pathParams: [
|
|
822
|
+
{
|
|
823
|
+
name: "agent_id",
|
|
824
|
+
sdkName: "agent_id",
|
|
825
|
+
description: "Active service agent id from agent creation or listing."
|
|
826
|
+
},
|
|
827
|
+
{
|
|
828
|
+
name: "customer_id",
|
|
829
|
+
sdkName: "customer_id",
|
|
830
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
831
|
+
}
|
|
832
|
+
],
|
|
833
|
+
query: []
|
|
834
|
+
},
|
|
835
|
+
{
|
|
836
|
+
resource: "agent.agents.customers.unblock",
|
|
837
|
+
method: "create",
|
|
838
|
+
summary: "Unblock customer",
|
|
839
|
+
description: `Allow a blocked customer to sign in and start sessions again.
|
|
840
|
+
|
|
841
|
+
Idempotent. Access tokens revoked while the customer was blocked stay revoked; sign the customer in again with a new grant code. An unknown customer returns 404 CUSTOMER_NOT_FOUND.`,
|
|
842
|
+
http: "POST",
|
|
843
|
+
path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock",
|
|
844
|
+
streaming: "no",
|
|
845
|
+
pagination: false,
|
|
846
|
+
pathParams: [
|
|
847
|
+
{
|
|
848
|
+
name: "agent_id",
|
|
849
|
+
sdkName: "agent_id",
|
|
850
|
+
description: "Active service agent id from agent creation or listing."
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
name: "customer_id",
|
|
854
|
+
sdkName: "customer_id",
|
|
855
|
+
description: "Customer id from customer listing, or your own customer_id."
|
|
454
856
|
}
|
|
455
857
|
],
|
|
456
858
|
query: []
|
|
@@ -469,7 +871,8 @@ Ordered by last_active_at and external_user_id descending. q is a case-sensitive
|
|
|
469
871
|
pathParams: [
|
|
470
872
|
{
|
|
471
873
|
name: "agent_id",
|
|
472
|
-
sdkName: "agent_id"
|
|
874
|
+
sdkName: "agent_id",
|
|
875
|
+
description: "Active service agent identifier from agent creation or listing."
|
|
473
876
|
}
|
|
474
877
|
],
|
|
475
878
|
query: [
|
|
@@ -507,11 +910,13 @@ Develop only. Set confirm to the exact external_user_id; missing or mismatched c
|
|
|
507
910
|
pathParams: [
|
|
508
911
|
{
|
|
509
912
|
name: "agent_id",
|
|
510
|
-
sdkName: "agent_id"
|
|
913
|
+
sdkName: "agent_id",
|
|
914
|
+
description: "Active service agent identifier from agent creation or listing."
|
|
511
915
|
},
|
|
512
916
|
{
|
|
513
917
|
name: "external_user_id",
|
|
514
|
-
sdkName: "external_user_id"
|
|
918
|
+
sdkName: "external_user_id",
|
|
919
|
+
description: "Host user identifier supplied at issuance or from end-user listing."
|
|
515
920
|
}
|
|
516
921
|
],
|
|
517
922
|
query: [
|
|
@@ -537,11 +942,13 @@ Use external_user_id from listing or your host application. Users without sessio
|
|
|
537
942
|
pathParams: [
|
|
538
943
|
{
|
|
539
944
|
name: "agent_id",
|
|
540
|
-
sdkName: "agent_id"
|
|
945
|
+
sdkName: "agent_id",
|
|
946
|
+
description: "Active service agent identifier from agent creation or listing."
|
|
541
947
|
},
|
|
542
948
|
{
|
|
543
949
|
name: "external_user_id",
|
|
544
|
-
sdkName: "external_user_id"
|
|
950
|
+
sdkName: "external_user_id",
|
|
951
|
+
description: "Host user identifier supplied at issuance or from end-user listing."
|
|
545
952
|
}
|
|
546
953
|
],
|
|
547
954
|
query: []
|
|
@@ -560,11 +967,13 @@ May block a user before any history exists; timestamps are then null and counts
|
|
|
560
967
|
pathParams: [
|
|
561
968
|
{
|
|
562
969
|
name: "agent_id",
|
|
563
|
-
sdkName: "agent_id"
|
|
970
|
+
sdkName: "agent_id",
|
|
971
|
+
description: "Active service agent identifier from agent creation or listing."
|
|
564
972
|
},
|
|
565
973
|
{
|
|
566
974
|
name: "external_user_id",
|
|
567
|
-
sdkName: "external_user_id"
|
|
975
|
+
sdkName: "external_user_id",
|
|
976
|
+
description: "Host user identifier supplied at issuance or from end-user listing."
|
|
568
977
|
}
|
|
569
978
|
],
|
|
570
979
|
query: []
|
|
@@ -583,11 +992,13 @@ Use the same agent_id and external_user_id as the confirmed DELETE. Status is pe
|
|
|
583
992
|
pathParams: [
|
|
584
993
|
{
|
|
585
994
|
name: "agent_id",
|
|
586
|
-
sdkName: "agent_id"
|
|
995
|
+
sdkName: "agent_id",
|
|
996
|
+
description: "Active service agent identifier from agent creation or listing."
|
|
587
997
|
},
|
|
588
998
|
{
|
|
589
999
|
name: "external_user_id",
|
|
590
|
-
sdkName: "external_user_id"
|
|
1000
|
+
sdkName: "external_user_id",
|
|
1001
|
+
description: "Host user identifier supplied at issuance or from end-user listing."
|
|
591
1002
|
}
|
|
592
1003
|
],
|
|
593
1004
|
query: []
|
|
@@ -606,11 +1017,13 @@ Revokes credentials before marking grants revoked. Upstream failure returns 502
|
|
|
606
1017
|
pathParams: [
|
|
607
1018
|
{
|
|
608
1019
|
name: "agent_id",
|
|
609
|
-
sdkName: "agent_id"
|
|
1020
|
+
sdkName: "agent_id",
|
|
1021
|
+
description: "Active service agent identifier from agent creation or listing."
|
|
610
1022
|
},
|
|
611
1023
|
{
|
|
612
1024
|
name: "external_user_id",
|
|
613
|
-
sdkName: "external_user_id"
|
|
1025
|
+
sdkName: "external_user_id",
|
|
1026
|
+
description: "Host user identifier supplied at issuance or from end-user listing."
|
|
614
1027
|
}
|
|
615
1028
|
],
|
|
616
1029
|
query: []
|
|
@@ -629,11 +1042,13 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
|
|
|
629
1042
|
pathParams: [
|
|
630
1043
|
{
|
|
631
1044
|
name: "agent_id",
|
|
632
|
-
sdkName: "agent_id"
|
|
1045
|
+
sdkName: "agent_id",
|
|
1046
|
+
description: "Active service agent identifier from agent creation or listing."
|
|
633
1047
|
},
|
|
634
1048
|
{
|
|
635
1049
|
name: "external_user_id",
|
|
636
|
-
sdkName: "external_user_id"
|
|
1050
|
+
sdkName: "external_user_id",
|
|
1051
|
+
description: "Host user identifier supplied at issuance or from end-user listing."
|
|
637
1052
|
}
|
|
638
1053
|
],
|
|
639
1054
|
query: []
|
|
@@ -650,7 +1065,8 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
|
|
|
650
1065
|
pathParams: [
|
|
651
1066
|
{
|
|
652
1067
|
name: "agent_id",
|
|
653
|
-
sdkName: "agent_id"
|
|
1068
|
+
sdkName: "agent_id",
|
|
1069
|
+
description: "Agent id from creation or listing."
|
|
654
1070
|
}
|
|
655
1071
|
],
|
|
656
1072
|
query: []
|
|
@@ -659,7 +1075,7 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
|
|
|
659
1075
|
resource: "agent.agents.versions",
|
|
660
1076
|
method: "list",
|
|
661
1077
|
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.",
|
|
1078
|
+
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
1079
|
http: "GET",
|
|
664
1080
|
path: "/agent/v1/agents/{agent_id}/versions",
|
|
665
1081
|
streaming: "no",
|
|
@@ -667,7 +1083,8 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
|
|
|
667
1083
|
pathParams: [
|
|
668
1084
|
{
|
|
669
1085
|
name: "agent_id",
|
|
670
|
-
sdkName: "agent_id"
|
|
1086
|
+
sdkName: "agent_id",
|
|
1087
|
+
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
1088
|
}
|
|
672
1089
|
],
|
|
673
1090
|
query: [
|
|
@@ -697,11 +1114,14 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
|
|
|
697
1114
|
pathParams: [
|
|
698
1115
|
{
|
|
699
1116
|
name: "agent_id",
|
|
700
|
-
sdkName: "agent_id"
|
|
1117
|
+
sdkName: "agent_id",
|
|
1118
|
+
description: "Agent identifier from agents.create or agents.list."
|
|
701
1119
|
},
|
|
702
1120
|
{
|
|
703
1121
|
name: "version",
|
|
704
|
-
sdkName: "version"
|
|
1122
|
+
sdkName: "version",
|
|
1123
|
+
type: "integer",
|
|
1124
|
+
description: "Existing version number from agents.versions.list to use for new sessions and tokens."
|
|
705
1125
|
}
|
|
706
1126
|
],
|
|
707
1127
|
query: []
|
|
@@ -709,8 +1129,8 @@ Removes the user from the blocklist; previously revoked tokens stay revoked. Ide
|
|
|
709
1129
|
{
|
|
710
1130
|
resource: "agent.computers",
|
|
711
1131
|
method: "list",
|
|
712
|
-
summary: "
|
|
713
|
-
description: `
|
|
1132
|
+
summary: "List Computers",
|
|
1133
|
+
description: `List the computers of your organization, archived ones included.
|
|
714
1134
|
|
|
715
1135
|
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
1136
|
http: "GET",
|
|
@@ -736,8 +1156,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
736
1156
|
{
|
|
737
1157
|
resource: "agent.computers",
|
|
738
1158
|
method: "create",
|
|
739
|
-
summary: "
|
|
740
|
-
description: `
|
|
1159
|
+
summary: "Create Computer",
|
|
1160
|
+
description: `Create a durable computer: a named machine whose files outlive sessions, for personal agents.
|
|
741
1161
|
|
|
742
1162
|
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
1163
|
http: "POST",
|
|
@@ -778,7 +1198,8 @@ Own-face superset: Managed Agents has no persistent Computer deletion lifecycle.
|
|
|
778
1198
|
pathParams: [
|
|
779
1199
|
{
|
|
780
1200
|
name: "computer_id",
|
|
781
|
-
sdkName: "computer_id"
|
|
1201
|
+
sdkName: "computer_id",
|
|
1202
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
782
1203
|
}
|
|
783
1204
|
],
|
|
784
1205
|
query: []
|
|
@@ -786,8 +1207,8 @@ Own-face superset: Managed Agents has no persistent Computer deletion lifecycle.
|
|
|
786
1207
|
{
|
|
787
1208
|
resource: "agent.computers",
|
|
788
1209
|
method: "retrieve",
|
|
789
|
-
summary: "
|
|
790
|
-
description: `
|
|
1210
|
+
summary: "Get Computer",
|
|
1211
|
+
description: `Read one computer's status, storage use and sandbox id.
|
|
791
1212
|
|
|
792
1213
|
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
1214
|
http: "GET",
|
|
@@ -797,7 +1218,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
797
1218
|
pathParams: [
|
|
798
1219
|
{
|
|
799
1220
|
name: "computer_id",
|
|
800
|
-
sdkName: "computer_id"
|
|
1221
|
+
sdkName: "computer_id",
|
|
1222
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
801
1223
|
}
|
|
802
1224
|
],
|
|
803
1225
|
query: []
|
|
@@ -805,8 +1227,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
805
1227
|
{
|
|
806
1228
|
resource: "agent.computers",
|
|
807
1229
|
method: "update",
|
|
808
|
-
summary: "
|
|
809
|
-
description: `
|
|
1230
|
+
summary: "Update Computer",
|
|
1231
|
+
description: `Rename a computer.
|
|
810
1232
|
|
|
811
1233
|
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
1234
|
http: "POST",
|
|
@@ -816,7 +1238,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
816
1238
|
pathParams: [
|
|
817
1239
|
{
|
|
818
1240
|
name: "computer_id",
|
|
819
|
-
sdkName: "computer_id"
|
|
1241
|
+
sdkName: "computer_id",
|
|
1242
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
820
1243
|
}
|
|
821
1244
|
],
|
|
822
1245
|
query: [],
|
|
@@ -835,8 +1258,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
835
1258
|
{
|
|
836
1259
|
resource: "agent.computers",
|
|
837
1260
|
method: "archive",
|
|
838
|
-
summary: "
|
|
839
|
-
description: `
|
|
1261
|
+
summary: "Archive Computer",
|
|
1262
|
+
description: `Archive a computer: its files stay readable but new sessions cannot use it.
|
|
840
1263
|
|
|
841
1264
|
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
1265
|
http: "POST",
|
|
@@ -846,7 +1269,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
846
1269
|
pathParams: [
|
|
847
1270
|
{
|
|
848
1271
|
name: "computer_id",
|
|
849
|
-
sdkName: "computer_id"
|
|
1272
|
+
sdkName: "computer_id",
|
|
1273
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
850
1274
|
}
|
|
851
1275
|
],
|
|
852
1276
|
query: []
|
|
@@ -865,7 +1289,8 @@ Own-face superset: Managed Agents has no persistent Computer attachment director
|
|
|
865
1289
|
pathParams: [
|
|
866
1290
|
{
|
|
867
1291
|
name: "computer_id",
|
|
868
|
-
sdkName: "computer_id"
|
|
1292
|
+
sdkName: "computer_id",
|
|
1293
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
869
1294
|
}
|
|
870
1295
|
],
|
|
871
1296
|
query: [
|
|
@@ -897,7 +1322,8 @@ Connect to a computer with a caller-held lease. Omit the body or send {} to requ
|
|
|
897
1322
|
pathParams: [
|
|
898
1323
|
{
|
|
899
1324
|
name: "computer_id",
|
|
900
|
-
sdkName: "computer_id"
|
|
1325
|
+
sdkName: "computer_id",
|
|
1326
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
901
1327
|
}
|
|
902
1328
|
],
|
|
903
1329
|
query: [],
|
|
@@ -920,8 +1346,8 @@ Connect to a computer with a caller-held lease. Omit the body or send {} to requ
|
|
|
920
1346
|
{
|
|
921
1347
|
resource: "agent.computers.files",
|
|
922
1348
|
method: "list",
|
|
923
|
-
summary: "
|
|
924
|
-
description: `
|
|
1349
|
+
summary: "List Computer Files",
|
|
1350
|
+
description: `List the entries of one directory on a computer.
|
|
925
1351
|
|
|
926
1352
|
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
1353
|
http: "GET",
|
|
@@ -931,7 +1357,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
931
1357
|
pathParams: [
|
|
932
1358
|
{
|
|
933
1359
|
name: "computer_id",
|
|
934
|
-
sdkName: "computer_id"
|
|
1360
|
+
sdkName: "computer_id",
|
|
1361
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
935
1362
|
}
|
|
936
1363
|
],
|
|
937
1364
|
query: [
|
|
@@ -946,8 +1373,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
946
1373
|
{
|
|
947
1374
|
resource: "agent.computers.files",
|
|
948
1375
|
method: "retrieveContent",
|
|
949
|
-
summary: "
|
|
950
|
-
description: `
|
|
1376
|
+
summary: "Get Computer File Content",
|
|
1377
|
+
description: `Download the bytes of one file on a computer, up to 16 MiB, with single-range support.
|
|
951
1378
|
|
|
952
1379
|
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
1380
|
http: "GET",
|
|
@@ -957,7 +1384,8 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
957
1384
|
pathParams: [
|
|
958
1385
|
{
|
|
959
1386
|
name: "computer_id",
|
|
960
|
-
sdkName: "computer_id"
|
|
1387
|
+
sdkName: "computer_id",
|
|
1388
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
961
1389
|
}
|
|
962
1390
|
],
|
|
963
1391
|
query: [
|
|
@@ -983,11 +1411,13 @@ Own-face extension. Idempotent: an unknown or already released lease succeeds as
|
|
|
983
1411
|
pathParams: [
|
|
984
1412
|
{
|
|
985
1413
|
name: "computer_id",
|
|
986
|
-
sdkName: "computer_id"
|
|
1414
|
+
sdkName: "computer_id",
|
|
1415
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
987
1416
|
},
|
|
988
1417
|
{
|
|
989
1418
|
name: "lease_id",
|
|
990
|
-
sdkName: "lease_id"
|
|
1419
|
+
sdkName: "lease_id",
|
|
1420
|
+
description: "lease_id from the connect response."
|
|
991
1421
|
}
|
|
992
1422
|
],
|
|
993
1423
|
query: []
|
|
@@ -1006,11 +1436,13 @@ Own-face extension. A lease that is no longer valid (released, expired, or the c
|
|
|
1006
1436
|
pathParams: [
|
|
1007
1437
|
{
|
|
1008
1438
|
name: "computer_id",
|
|
1009
|
-
sdkName: "computer_id"
|
|
1439
|
+
sdkName: "computer_id",
|
|
1440
|
+
description: "Computer id (cmp_...), as returned by computers.create or computers.list."
|
|
1010
1441
|
},
|
|
1011
1442
|
{
|
|
1012
1443
|
name: "lease_id",
|
|
1013
|
-
sdkName: "lease_id"
|
|
1444
|
+
sdkName: "lease_id",
|
|
1445
|
+
description: "lease_id from the connect response."
|
|
1014
1446
|
}
|
|
1015
1447
|
],
|
|
1016
1448
|
query: []
|
|
@@ -1102,7 +1534,8 @@ Own-face extension. A lease that is no longer valid (released, expired, or the c
|
|
|
1102
1534
|
pathParams: [
|
|
1103
1535
|
{
|
|
1104
1536
|
name: "deployment_run_id",
|
|
1105
|
-
sdkName: "deployment_run_id"
|
|
1537
|
+
sdkName: "deployment_run_id",
|
|
1538
|
+
description: "Deployment run id (drun_...), returned by deployments.run or deployment_runs.list."
|
|
1106
1539
|
}
|
|
1107
1540
|
],
|
|
1108
1541
|
query: []
|
|
@@ -1273,7 +1706,8 @@ created from this deployment. Maximum 50.`
|
|
|
1273
1706
|
pathParams: [
|
|
1274
1707
|
{
|
|
1275
1708
|
name: "deployment_id",
|
|
1276
|
-
sdkName: "deployment_id"
|
|
1709
|
+
sdkName: "deployment_id",
|
|
1710
|
+
description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
|
|
1277
1711
|
}
|
|
1278
1712
|
],
|
|
1279
1713
|
query: []
|
|
@@ -1290,7 +1724,8 @@ created from this deployment. Maximum 50.`
|
|
|
1290
1724
|
pathParams: [
|
|
1291
1725
|
{
|
|
1292
1726
|
name: "deployment_id",
|
|
1293
|
-
sdkName: "deployment_id"
|
|
1727
|
+
sdkName: "deployment_id",
|
|
1728
|
+
description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
|
|
1294
1729
|
}
|
|
1295
1730
|
],
|
|
1296
1731
|
query: [],
|
|
@@ -1388,7 +1823,8 @@ null to clear. Maximum 50.`
|
|
|
1388
1823
|
pathParams: [
|
|
1389
1824
|
{
|
|
1390
1825
|
name: "deployment_id",
|
|
1391
|
-
sdkName: "deployment_id"
|
|
1826
|
+
sdkName: "deployment_id",
|
|
1827
|
+
description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
|
|
1392
1828
|
}
|
|
1393
1829
|
],
|
|
1394
1830
|
query: []
|
|
@@ -1405,7 +1841,8 @@ null to clear. Maximum 50.`
|
|
|
1405
1841
|
pathParams: [
|
|
1406
1842
|
{
|
|
1407
1843
|
name: "deployment_id",
|
|
1408
|
-
sdkName: "deployment_id"
|
|
1844
|
+
sdkName: "deployment_id",
|
|
1845
|
+
description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
|
|
1409
1846
|
}
|
|
1410
1847
|
],
|
|
1411
1848
|
query: []
|
|
@@ -1422,7 +1859,8 @@ null to clear. Maximum 50.`
|
|
|
1422
1859
|
pathParams: [
|
|
1423
1860
|
{
|
|
1424
1861
|
name: "deployment_id",
|
|
1425
|
-
sdkName: "deployment_id"
|
|
1862
|
+
sdkName: "deployment_id",
|
|
1863
|
+
description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
|
|
1426
1864
|
}
|
|
1427
1865
|
],
|
|
1428
1866
|
query: []
|
|
@@ -1439,7 +1877,8 @@ null to clear. Maximum 50.`
|
|
|
1439
1877
|
pathParams: [
|
|
1440
1878
|
{
|
|
1441
1879
|
name: "deployment_id",
|
|
1442
|
-
sdkName: "deployment_id"
|
|
1880
|
+
sdkName: "deployment_id",
|
|
1881
|
+
description: "Deployment id (depl_...), returned by deployments.create or deployments.list."
|
|
1443
1882
|
}
|
|
1444
1883
|
],
|
|
1445
1884
|
query: []
|
|
@@ -1646,7 +2085,8 @@ Use an id from issuance or listing. Revokes the credential before setting revoke
|
|
|
1646
2085
|
pathParams: [
|
|
1647
2086
|
{
|
|
1648
2087
|
name: "id",
|
|
1649
|
-
sdkName: "id"
|
|
2088
|
+
sdkName: "id",
|
|
2089
|
+
description: "Grant id returned by issuance or listing."
|
|
1650
2090
|
}
|
|
1651
2091
|
],
|
|
1652
2092
|
query: []
|
|
@@ -1690,7 +2130,7 @@ Use an id from issuance or listing. Revokes the credential before setting revoke
|
|
|
1690
2130
|
resource: "agent.environments",
|
|
1691
2131
|
method: "create",
|
|
1692
2132
|
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.",
|
|
2133
|
+
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
2134
|
http: "POST",
|
|
1695
2135
|
path: "/agent/v1/environments",
|
|
1696
2136
|
streaming: "no",
|
|
@@ -1723,19 +2163,6 @@ Use an id from issuance or listing. Revokes the credential before setting revoke
|
|
|
1723
2163
|
type: "object",
|
|
1724
2164
|
required: false,
|
|
1725
2165
|
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
2166
|
}
|
|
1740
2167
|
]
|
|
1741
2168
|
}
|
|
@@ -1752,7 +2179,8 @@ rejected. If not specified, defaults based on organization type.`
|
|
|
1752
2179
|
pathParams: [
|
|
1753
2180
|
{
|
|
1754
2181
|
name: "environment_id",
|
|
1755
|
-
sdkName: "environment_id"
|
|
2182
|
+
sdkName: "environment_id",
|
|
2183
|
+
description: "Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed."
|
|
1756
2184
|
}
|
|
1757
2185
|
],
|
|
1758
2186
|
query: []
|
|
@@ -1761,7 +2189,7 @@ rejected. If not specified, defaults based on organization type.`
|
|
|
1761
2189
|
resource: "agent.environments",
|
|
1762
2190
|
method: "update",
|
|
1763
2191
|
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.",
|
|
2192
|
+
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
2193
|
http: "POST",
|
|
1766
2194
|
path: "/agent/v1/environments/{environment_id}",
|
|
1767
2195
|
streaming: "no",
|
|
@@ -1769,7 +2197,8 @@ rejected. If not specified, defaults based on organization type.`
|
|
|
1769
2197
|
pathParams: [
|
|
1770
2198
|
{
|
|
1771
2199
|
name: "environment_id",
|
|
1772
|
-
sdkName: "environment_id"
|
|
2200
|
+
sdkName: "environment_id",
|
|
2201
|
+
description: "Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed."
|
|
1773
2202
|
}
|
|
1774
2203
|
],
|
|
1775
2204
|
query: [],
|
|
@@ -1800,18 +2229,6 @@ clears to null; an empty string is stored as an empty string.`
|
|
|
1800
2229
|
type: "string",
|
|
1801
2230
|
required: false,
|
|
1802
2231
|
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
2232
|
}
|
|
1816
2233
|
]
|
|
1817
2234
|
}
|
|
@@ -1820,7 +2237,7 @@ owning account only.`
|
|
|
1820
2237
|
resource: "agent.environments",
|
|
1821
2238
|
method: "archive",
|
|
1822
2239
|
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.",
|
|
2240
|
+
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
2241
|
http: "POST",
|
|
1825
2242
|
path: "/agent/v1/environments/{environment_id}/archive",
|
|
1826
2243
|
streaming: "no",
|
|
@@ -1828,7 +2245,8 @@ owning account only.`
|
|
|
1828
2245
|
pathParams: [
|
|
1829
2246
|
{
|
|
1830
2247
|
name: "environment_id",
|
|
1831
|
-
sdkName: "environment_id"
|
|
2248
|
+
sdkName: "environment_id",
|
|
2249
|
+
description: "Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed."
|
|
1832
2250
|
}
|
|
1833
2251
|
],
|
|
1834
2252
|
query: []
|
|
@@ -1837,7 +2255,7 @@ owning account only.`
|
|
|
1837
2255
|
resource: "agent.sessions",
|
|
1838
2256
|
method: "list",
|
|
1839
2257
|
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
|
|
2258
|
+
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
2259
|
http: "GET",
|
|
1842
2260
|
path: "/agent/v1/sessions",
|
|
1843
2261
|
streaming: "no",
|
|
@@ -1866,7 +2284,7 @@ owning account only.`
|
|
|
1866
2284
|
name: "created_at[gte]",
|
|
1867
2285
|
type: "string",
|
|
1868
2286
|
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
|
|
2287
|
+
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
2288
|
},
|
|
1871
2289
|
{
|
|
1872
2290
|
name: "created_at[lt]",
|
|
@@ -1878,7 +2296,7 @@ owning account only.`
|
|
|
1878
2296
|
name: "created_at[lte]",
|
|
1879
2297
|
type: "string",
|
|
1880
2298
|
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
|
|
2299
|
+
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
2300
|
},
|
|
1883
2301
|
{
|
|
1884
2302
|
name: "deployment_id",
|
|
@@ -1894,7 +2312,7 @@ owning account only.`
|
|
|
1894
2312
|
true
|
|
1895
2313
|
],
|
|
1896
2314
|
required: false,
|
|
1897
|
-
description: "
|
|
2315
|
+
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
2316
|
},
|
|
1899
2317
|
{
|
|
1900
2318
|
name: "memory_store_id",
|
|
@@ -1962,7 +2380,7 @@ owning account only.`
|
|
|
1962
2380
|
resource: "agent.sessions",
|
|
1963
2381
|
method: "create",
|
|
1964
2382
|
summary: "Create session",
|
|
1965
|
-
description: `Create a session: one conversation with an agent. Pass agent as an agent id
|
|
2383
|
+
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
2384
|
http: "POST",
|
|
1967
2385
|
path: "/agent/v1/sessions",
|
|
1968
2386
|
streaming: "no",
|
|
@@ -1976,19 +2394,19 @@ owning account only.`
|
|
|
1976
2394
|
name: "agent",
|
|
1977
2395
|
type: "object",
|
|
1978
2396
|
required: true,
|
|
1979
|
-
description:
|
|
2397
|
+
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
2398
|
},
|
|
1981
2399
|
{
|
|
1982
2400
|
name: "environment_id",
|
|
1983
2401
|
type: "string",
|
|
1984
2402
|
required: false,
|
|
1985
|
-
description: "Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission
|
|
2403
|
+
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
2404
|
},
|
|
1987
2405
|
{
|
|
1988
2406
|
name: "budget",
|
|
1989
2407
|
type: "object",
|
|
1990
2408
|
required: false,
|
|
1991
|
-
description:
|
|
2409
|
+
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
2410
|
},
|
|
1993
2411
|
{
|
|
1994
2412
|
name: "initial_events",
|
|
@@ -2074,7 +2492,8 @@ offsets ("+08:00") and unknown names return 400. Never stored in
|
|
|
2074
2492
|
pathParams: [
|
|
2075
2493
|
{
|
|
2076
2494
|
name: "session_id",
|
|
2077
|
-
sdkName: "session_id"
|
|
2495
|
+
sdkName: "session_id",
|
|
2496
|
+
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
2497
|
}
|
|
2079
2498
|
],
|
|
2080
2499
|
query: []
|
|
@@ -2091,7 +2510,8 @@ offsets ("+08:00") and unknown names return 400. Never stored in
|
|
|
2091
2510
|
pathParams: [
|
|
2092
2511
|
{
|
|
2093
2512
|
name: "session_id",
|
|
2094
|
-
sdkName: "session_id"
|
|
2513
|
+
sdkName: "session_id",
|
|
2514
|
+
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
2515
|
}
|
|
2096
2516
|
],
|
|
2097
2517
|
query: []
|
|
@@ -2108,19 +2528,14 @@ offsets ("+08:00") and unknown names return 400. Never stored in
|
|
|
2108
2528
|
pathParams: [
|
|
2109
2529
|
{
|
|
2110
2530
|
name: "session_id",
|
|
2111
|
-
sdkName: "session_id"
|
|
2531
|
+
sdkName: "session_id",
|
|
2532
|
+
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
2533
|
}
|
|
2113
2534
|
],
|
|
2114
2535
|
query: [],
|
|
2115
2536
|
body: {
|
|
2116
2537
|
required: true,
|
|
2117
2538
|
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
2539
|
{
|
|
2125
2540
|
name: "budget",
|
|
2126
2541
|
type: "object",
|
|
@@ -2174,7 +2589,8 @@ delete it. Omit the field to preserve.`
|
|
|
2174
2589
|
pathParams: [
|
|
2175
2590
|
{
|
|
2176
2591
|
name: "session_id",
|
|
2177
|
-
sdkName: "session_id"
|
|
2592
|
+
sdkName: "session_id",
|
|
2593
|
+
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
2594
|
}
|
|
2179
2595
|
],
|
|
2180
2596
|
query: []
|
|
@@ -2193,7 +2609,8 @@ Own-face extension. Returns { data: BackgroundTask[] }. Each task has id, kind,
|
|
|
2193
2609
|
pathParams: [
|
|
2194
2610
|
{
|
|
2195
2611
|
name: "session_id",
|
|
2196
|
-
sdkName: "session_id"
|
|
2612
|
+
sdkName: "session_id",
|
|
2613
|
+
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
2614
|
}
|
|
2198
2615
|
],
|
|
2199
2616
|
query: []
|
|
@@ -2212,11 +2629,13 @@ Own-face extension. offset defaults to 0; max_bytes defaults to 65536 and must b
|
|
|
2212
2629
|
pathParams: [
|
|
2213
2630
|
{
|
|
2214
2631
|
name: "session_id",
|
|
2215
|
-
sdkName: "session_id"
|
|
2632
|
+
sdkName: "session_id",
|
|
2633
|
+
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
2634
|
},
|
|
2217
2635
|
{
|
|
2218
2636
|
name: "task_id",
|
|
2219
|
-
sdkName: "task_id"
|
|
2637
|
+
sdkName: "task_id",
|
|
2638
|
+
description: "Background task id (task_...), as listed by sessions.background_tasks.list."
|
|
2220
2639
|
}
|
|
2221
2640
|
],
|
|
2222
2641
|
query: [
|
|
@@ -2248,11 +2667,13 @@ Own-face extension. No request body is required. Uses the same stop implementati
|
|
|
2248
2667
|
pathParams: [
|
|
2249
2668
|
{
|
|
2250
2669
|
name: "session_id",
|
|
2251
|
-
sdkName: "session_id"
|
|
2670
|
+
sdkName: "session_id",
|
|
2671
|
+
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
2672
|
},
|
|
2253
2673
|
{
|
|
2254
2674
|
name: "task_id",
|
|
2255
|
-
sdkName: "task_id"
|
|
2675
|
+
sdkName: "task_id",
|
|
2676
|
+
description: "Background task id (task_...), as listed by sessions.background_tasks.list."
|
|
2256
2677
|
}
|
|
2257
2678
|
],
|
|
2258
2679
|
query: []
|
|
@@ -2271,7 +2692,8 @@ Available only on /agent/v1. The body may be omitted or {}. Optional instruction
|
|
|
2271
2692
|
pathParams: [
|
|
2272
2693
|
{
|
|
2273
2694
|
name: "session_id",
|
|
2274
|
-
sdkName: "session_id"
|
|
2695
|
+
sdkName: "session_id",
|
|
2696
|
+
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
2697
|
}
|
|
2276
2698
|
],
|
|
2277
2699
|
query: [],
|
|
@@ -2301,11 +2723,13 @@ Available only on /agent/v1. Returns { type: session_compaction, id, status, rea
|
|
|
2301
2723
|
pathParams: [
|
|
2302
2724
|
{
|
|
2303
2725
|
name: "session_id",
|
|
2304
|
-
sdkName: "session_id"
|
|
2726
|
+
sdkName: "session_id",
|
|
2727
|
+
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
2728
|
},
|
|
2306
2729
|
{
|
|
2307
2730
|
name: "operation_id",
|
|
2308
|
-
sdkName: "operation_id"
|
|
2731
|
+
sdkName: "operation_id",
|
|
2732
|
+
description: "Compaction operation id returned by sessions.compact in the id field of the session_compaction object."
|
|
2309
2733
|
}
|
|
2310
2734
|
],
|
|
2311
2735
|
query: []
|
|
@@ -2324,7 +2748,8 @@ Available only on /agent/v1. Returns { data: [...] }. Each entry contains type,
|
|
|
2324
2748
|
pathParams: [
|
|
2325
2749
|
{
|
|
2326
2750
|
name: "session_id",
|
|
2327
|
-
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."
|
|
2328
2753
|
}
|
|
2329
2754
|
],
|
|
2330
2755
|
query: []
|
|
@@ -2343,7 +2768,8 @@ Praxis extension available only on /agent/v1, following Claude Agent SDK getCont
|
|
|
2343
2768
|
pathParams: [
|
|
2344
2769
|
{
|
|
2345
2770
|
name: "session_id",
|
|
2346
|
-
sdkName: "session_id"
|
|
2771
|
+
sdkName: "session_id",
|
|
2772
|
+
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
2773
|
}
|
|
2348
2774
|
],
|
|
2349
2775
|
query: []
|
|
@@ -2360,7 +2786,8 @@ Praxis extension available only on /agent/v1, following Claude Agent SDK getCont
|
|
|
2360
2786
|
pathParams: [
|
|
2361
2787
|
{
|
|
2362
2788
|
name: "session_id",
|
|
2363
|
-
sdkName: "session_id"
|
|
2789
|
+
sdkName: "session_id",
|
|
2790
|
+
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
2791
|
}
|
|
2365
2792
|
],
|
|
2366
2793
|
query: [
|
|
@@ -2431,7 +2858,8 @@ Praxis extension available only on /agent/v1, following Claude Agent SDK getCont
|
|
|
2431
2858
|
pathParams: [
|
|
2432
2859
|
{
|
|
2433
2860
|
name: "session_id",
|
|
2434
|
-
sdkName: "session_id"
|
|
2861
|
+
sdkName: "session_id",
|
|
2862
|
+
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
2863
|
}
|
|
2436
2864
|
],
|
|
2437
2865
|
query: [],
|
|
@@ -2460,7 +2888,8 @@ Praxis extension available only on /agent/v1, following Claude Agent SDK getCont
|
|
|
2460
2888
|
pathParams: [
|
|
2461
2889
|
{
|
|
2462
2890
|
name: "session_id",
|
|
2463
|
-
sdkName: "session_id"
|
|
2891
|
+
sdkName: "session_id",
|
|
2892
|
+
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
2893
|
}
|
|
2465
2894
|
],
|
|
2466
2895
|
query: [
|
|
@@ -2491,7 +2920,8 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
|
|
|
2491
2920
|
pathParams: [
|
|
2492
2921
|
{
|
|
2493
2922
|
name: "session_id",
|
|
2494
|
-
sdkName: "session_id"
|
|
2923
|
+
sdkName: "session_id",
|
|
2924
|
+
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
2925
|
}
|
|
2496
2926
|
],
|
|
2497
2927
|
query: [],
|
|
@@ -2519,7 +2949,8 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
|
|
|
2519
2949
|
pathParams: [
|
|
2520
2950
|
{
|
|
2521
2951
|
name: "session_id",
|
|
2522
|
-
sdkName: "session_id"
|
|
2952
|
+
sdkName: "session_id",
|
|
2953
|
+
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
2954
|
}
|
|
2524
2955
|
],
|
|
2525
2956
|
query: [
|
|
@@ -2549,7 +2980,8 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
|
|
|
2549
2980
|
pathParams: [
|
|
2550
2981
|
{
|
|
2551
2982
|
name: "session_id",
|
|
2552
|
-
sdkName: "session_id"
|
|
2983
|
+
sdkName: "session_id",
|
|
2984
|
+
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
2985
|
}
|
|
2554
2986
|
],
|
|
2555
2987
|
query: [
|
|
@@ -2593,11 +3025,13 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
|
|
|
2593
3025
|
pathParams: [
|
|
2594
3026
|
{
|
|
2595
3027
|
name: "session_id",
|
|
2596
|
-
sdkName: "session_id"
|
|
3028
|
+
sdkName: "session_id",
|
|
3029
|
+
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
3030
|
},
|
|
2598
3031
|
{
|
|
2599
3032
|
name: "resource_id",
|
|
2600
|
-
sdkName: "resource_id"
|
|
3033
|
+
sdkName: "resource_id",
|
|
3034
|
+
description: "Id of a resource attached to the session, as returned by sessions.resources.add or sessions.resources.list."
|
|
2601
3035
|
}
|
|
2602
3036
|
],
|
|
2603
3037
|
query: [
|
|
@@ -2622,11 +3056,13 @@ Available only on /agent/v1. Use the message_id field from own-face events, not
|
|
|
2622
3056
|
pathParams: [
|
|
2623
3057
|
{
|
|
2624
3058
|
name: "session_id",
|
|
2625
|
-
sdkName: "session_id"
|
|
3059
|
+
sdkName: "session_id",
|
|
3060
|
+
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
3061
|
},
|
|
2627
3062
|
{
|
|
2628
3063
|
name: "resource_id",
|
|
2629
|
-
sdkName: "resource_id"
|
|
3064
|
+
sdkName: "resource_id",
|
|
3065
|
+
description: "Id of a resource attached to the session, as returned by sessions.resources.add or sessions.resources.list."
|
|
2630
3066
|
}
|
|
2631
3067
|
],
|
|
2632
3068
|
query: [
|
|
@@ -2653,11 +3089,13 @@ Own-face extension. Use the session id from session creation or listing and the
|
|
|
2653
3089
|
pathParams: [
|
|
2654
3090
|
{
|
|
2655
3091
|
name: "session_id",
|
|
2656
|
-
sdkName: "session_id"
|
|
3092
|
+
sdkName: "session_id",
|
|
3093
|
+
description: "Session id from session creation or listing."
|
|
2657
3094
|
},
|
|
2658
3095
|
{
|
|
2659
3096
|
name: "run_id",
|
|
2660
|
-
sdkName: "run_id"
|
|
3097
|
+
sdkName: "run_id",
|
|
3098
|
+
description: "Existing run_id from this session's events."
|
|
2661
3099
|
}
|
|
2662
3100
|
],
|
|
2663
3101
|
query: []
|
|
@@ -2676,11 +3114,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
|
|
|
2676
3114
|
pathParams: [
|
|
2677
3115
|
{
|
|
2678
3116
|
name: "session_id",
|
|
2679
|
-
sdkName: "session_id"
|
|
3117
|
+
sdkName: "session_id",
|
|
3118
|
+
description: "Session id from session creation or listing."
|
|
2680
3119
|
},
|
|
2681
3120
|
{
|
|
2682
3121
|
name: "run_id",
|
|
2683
|
-
sdkName: "run_id"
|
|
3122
|
+
sdkName: "run_id",
|
|
3123
|
+
description: "Existing run_id from this session's events."
|
|
2684
3124
|
}
|
|
2685
3125
|
],
|
|
2686
3126
|
query: [],
|
|
@@ -2718,7 +3158,8 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
|
|
|
2718
3158
|
pathParams: [
|
|
2719
3159
|
{
|
|
2720
3160
|
name: "session_id",
|
|
2721
|
-
sdkName: "session_id"
|
|
3161
|
+
sdkName: "session_id",
|
|
3162
|
+
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
3163
|
}
|
|
2723
3164
|
],
|
|
2724
3165
|
query: [
|
|
@@ -2748,11 +3189,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
|
|
|
2748
3189
|
pathParams: [
|
|
2749
3190
|
{
|
|
2750
3191
|
name: "session_id",
|
|
2751
|
-
sdkName: "session_id"
|
|
3192
|
+
sdkName: "session_id",
|
|
3193
|
+
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
3194
|
},
|
|
2753
3195
|
{
|
|
2754
3196
|
name: "thread_id",
|
|
2755
|
-
sdkName: "thread_id"
|
|
3197
|
+
sdkName: "thread_id",
|
|
3198
|
+
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
3199
|
}
|
|
2757
3200
|
],
|
|
2758
3201
|
query: [
|
|
@@ -2777,11 +3220,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
|
|
|
2777
3220
|
pathParams: [
|
|
2778
3221
|
{
|
|
2779
3222
|
name: "session_id",
|
|
2780
|
-
sdkName: "session_id"
|
|
3223
|
+
sdkName: "session_id",
|
|
3224
|
+
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
3225
|
},
|
|
2782
3226
|
{
|
|
2783
3227
|
name: "thread_id",
|
|
2784
|
-
sdkName: "thread_id"
|
|
3228
|
+
sdkName: "thread_id",
|
|
3229
|
+
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
3230
|
}
|
|
2786
3231
|
],
|
|
2787
3232
|
query: [
|
|
@@ -2806,11 +3251,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
|
|
|
2806
3251
|
pathParams: [
|
|
2807
3252
|
{
|
|
2808
3253
|
name: "session_id",
|
|
2809
|
-
sdkName: "session_id"
|
|
3254
|
+
sdkName: "session_id",
|
|
3255
|
+
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
3256
|
},
|
|
2811
3257
|
{
|
|
2812
3258
|
name: "thread_id",
|
|
2813
|
-
sdkName: "thread_id"
|
|
3259
|
+
sdkName: "thread_id",
|
|
3260
|
+
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
3261
|
}
|
|
2815
3262
|
],
|
|
2816
3263
|
query: [
|
|
@@ -2847,11 +3294,13 @@ Own-face extension. Use a readable session and a run_id from its events. Each su
|
|
|
2847
3294
|
pathParams: [
|
|
2848
3295
|
{
|
|
2849
3296
|
name: "session_id",
|
|
2850
|
-
sdkName: "session_id"
|
|
3297
|
+
sdkName: "session_id",
|
|
3298
|
+
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
3299
|
},
|
|
2852
3300
|
{
|
|
2853
3301
|
name: "thread_id",
|
|
2854
|
-
sdkName: "thread_id"
|
|
3302
|
+
sdkName: "thread_id",
|
|
3303
|
+
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
3304
|
}
|
|
2856
3305
|
],
|
|
2857
3306
|
query: [
|
|
@@ -2915,7 +3364,7 @@ If provided, only skills from the specified source will be returned:
|
|
|
2915
3364
|
resource: "agent.skills",
|
|
2916
3365
|
method: "create",
|
|
2917
3366
|
summary: "Create skill",
|
|
2918
|
-
description:
|
|
3367
|
+
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
3368
|
http: "POST",
|
|
2920
3369
|
path: "/agent/v1/skills",
|
|
2921
3370
|
streaming: "no",
|
|
@@ -2949,7 +3398,7 @@ file at the root of that directory.`
|
|
|
2949
3398
|
resource: "agent.skills",
|
|
2950
3399
|
method: "delete",
|
|
2951
3400
|
summary: "Delete skill",
|
|
2952
|
-
description: "Delete a skill
|
|
3401
|
+
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
3402
|
http: "DELETE",
|
|
2954
3403
|
path: "/agent/v1/skills/{skill_id}",
|
|
2955
3404
|
streaming: "no",
|
|
@@ -2957,7 +3406,8 @@ file at the root of that directory.`
|
|
|
2957
3406
|
pathParams: [
|
|
2958
3407
|
{
|
|
2959
3408
|
name: "skill_id",
|
|
2960
|
-
sdkName: "skill_id"
|
|
3409
|
+
sdkName: "skill_id",
|
|
3410
|
+
description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
|
|
2961
3411
|
}
|
|
2962
3412
|
],
|
|
2963
3413
|
query: []
|
|
@@ -2974,7 +3424,8 @@ file at the root of that directory.`
|
|
|
2974
3424
|
pathParams: [
|
|
2975
3425
|
{
|
|
2976
3426
|
name: "skill_id",
|
|
2977
|
-
sdkName: "skill_id"
|
|
3427
|
+
sdkName: "skill_id",
|
|
3428
|
+
description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
|
|
2978
3429
|
}
|
|
2979
3430
|
],
|
|
2980
3431
|
query: []
|
|
@@ -2991,7 +3442,8 @@ file at the root of that directory.`
|
|
|
2991
3442
|
pathParams: [
|
|
2992
3443
|
{
|
|
2993
3444
|
name: "skill_id",
|
|
2994
|
-
sdkName: "skill_id"
|
|
3445
|
+
sdkName: "skill_id",
|
|
3446
|
+
description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
|
|
2995
3447
|
}
|
|
2996
3448
|
],
|
|
2997
3449
|
query: [
|
|
@@ -3022,7 +3474,8 @@ file at the root of that directory.`
|
|
|
3022
3474
|
pathParams: [
|
|
3023
3475
|
{
|
|
3024
3476
|
name: "skill_id",
|
|
3025
|
-
sdkName: "skill_id"
|
|
3477
|
+
sdkName: "skill_id",
|
|
3478
|
+
description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
|
|
3026
3479
|
}
|
|
3027
3480
|
],
|
|
3028
3481
|
query: [],
|
|
@@ -3046,7 +3499,7 @@ file at the root of that directory.`
|
|
|
3046
3499
|
resource: "agent.skills.versions",
|
|
3047
3500
|
method: "delete",
|
|
3048
3501
|
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
|
|
3502
|
+
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
3503
|
http: "DELETE",
|
|
3051
3504
|
path: "/agent/v1/skills/{skill_id}/versions/{version}",
|
|
3052
3505
|
streaming: "no",
|
|
@@ -3054,11 +3507,13 @@ file at the root of that directory.`
|
|
|
3054
3507
|
pathParams: [
|
|
3055
3508
|
{
|
|
3056
3509
|
name: "skill_id",
|
|
3057
|
-
sdkName: "skill_id"
|
|
3510
|
+
sdkName: "skill_id",
|
|
3511
|
+
description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
|
|
3058
3512
|
},
|
|
3059
3513
|
{
|
|
3060
3514
|
name: "version",
|
|
3061
|
-
sdkName: "version"
|
|
3515
|
+
sdkName: "version",
|
|
3516
|
+
description: "Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload."
|
|
3062
3517
|
}
|
|
3063
3518
|
],
|
|
3064
3519
|
query: []
|
|
@@ -3075,11 +3530,13 @@ file at the root of that directory.`
|
|
|
3075
3530
|
pathParams: [
|
|
3076
3531
|
{
|
|
3077
3532
|
name: "skill_id",
|
|
3078
|
-
sdkName: "skill_id"
|
|
3533
|
+
sdkName: "skill_id",
|
|
3534
|
+
description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
|
|
3079
3535
|
},
|
|
3080
3536
|
{
|
|
3081
3537
|
name: "version",
|
|
3082
|
-
sdkName: "version"
|
|
3538
|
+
sdkName: "version",
|
|
3539
|
+
description: "Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload."
|
|
3083
3540
|
}
|
|
3084
3541
|
],
|
|
3085
3542
|
query: []
|
|
@@ -3096,11 +3553,13 @@ file at the root of that directory.`
|
|
|
3096
3553
|
pathParams: [
|
|
3097
3554
|
{
|
|
3098
3555
|
name: "skill_id",
|
|
3099
|
-
sdkName: "skill_id"
|
|
3556
|
+
sdkName: "skill_id",
|
|
3557
|
+
description: "Skill id (skill_...), as returned by skills.create or skills.list. A skill of another organization returns 404."
|
|
3100
3558
|
},
|
|
3101
3559
|
{
|
|
3102
3560
|
name: "version",
|
|
3103
|
-
sdkName: "version"
|
|
3561
|
+
sdkName: "version",
|
|
3562
|
+
description: "Skill version id, as returned by skills.versions.create or skills.versions.list; an opaque string that increases with each upload."
|
|
3104
3563
|
}
|
|
3105
3564
|
],
|
|
3106
3565
|
query: []
|
|
@@ -3272,7 +3731,8 @@ file at the root of that directory.`
|
|
|
3272
3731
|
pathParams: [
|
|
3273
3732
|
{
|
|
3274
3733
|
name: "worker_id",
|
|
3275
|
-
sdkName: "worker_id"
|
|
3734
|
+
sdkName: "worker_id",
|
|
3735
|
+
description: "Worker ID (wkr_…)."
|
|
3276
3736
|
}
|
|
3277
3737
|
],
|
|
3278
3738
|
query: []
|
|
@@ -3289,7 +3749,8 @@ file at the root of that directory.`
|
|
|
3289
3749
|
pathParams: [
|
|
3290
3750
|
{
|
|
3291
3751
|
name: "worker_id",
|
|
3292
|
-
sdkName: "worker_id"
|
|
3752
|
+
sdkName: "worker_id",
|
|
3753
|
+
description: "Worker ID (wkr_…)."
|
|
3293
3754
|
}
|
|
3294
3755
|
],
|
|
3295
3756
|
query: [
|
|
@@ -3313,7 +3774,8 @@ file at the root of that directory.`
|
|
|
3313
3774
|
pathParams: [
|
|
3314
3775
|
{
|
|
3315
3776
|
name: "worker_id",
|
|
3316
|
-
sdkName: "worker_id"
|
|
3777
|
+
sdkName: "worker_id",
|
|
3778
|
+
description: "Worker ID (wkr_…)."
|
|
3317
3779
|
}
|
|
3318
3780
|
],
|
|
3319
3781
|
query: [],
|
|
@@ -3366,7 +3828,8 @@ file at the root of that directory.`
|
|
|
3366
3828
|
pathParams: [
|
|
3367
3829
|
{
|
|
3368
3830
|
name: "worker_id",
|
|
3369
|
-
sdkName: "worker_id"
|
|
3831
|
+
sdkName: "worker_id",
|
|
3832
|
+
description: "Worker ID (wkr_…)."
|
|
3370
3833
|
}
|
|
3371
3834
|
],
|
|
3372
3835
|
query: [],
|
|
@@ -3394,7 +3857,8 @@ file at the root of that directory.`
|
|
|
3394
3857
|
pathParams: [
|
|
3395
3858
|
{
|
|
3396
3859
|
name: "worker_id",
|
|
3397
|
-
sdkName: "worker_id"
|
|
3860
|
+
sdkName: "worker_id",
|
|
3861
|
+
description: "Worker ID (wkr_…)."
|
|
3398
3862
|
}
|
|
3399
3863
|
],
|
|
3400
3864
|
query: []
|
|
@@ -3411,7 +3875,8 @@ file at the root of that directory.`
|
|
|
3411
3875
|
pathParams: [
|
|
3412
3876
|
{
|
|
3413
3877
|
name: "worker_id",
|
|
3414
|
-
sdkName: "worker_id"
|
|
3878
|
+
sdkName: "worker_id",
|
|
3879
|
+
description: "Worker ID (wkr_…)."
|
|
3415
3880
|
}
|
|
3416
3881
|
],
|
|
3417
3882
|
query: [
|
|
@@ -3441,7 +3906,8 @@ file at the root of that directory.`
|
|
|
3441
3906
|
pathParams: [
|
|
3442
3907
|
{
|
|
3443
3908
|
name: "worker_id",
|
|
3444
|
-
sdkName: "worker_id"
|
|
3909
|
+
sdkName: "worker_id",
|
|
3910
|
+
description: "Worker ID (wkr_…)."
|
|
3445
3911
|
}
|
|
3446
3912
|
],
|
|
3447
3913
|
query: [],
|
|
@@ -3491,11 +3957,13 @@ file at the root of that directory.`
|
|
|
3491
3957
|
pathParams: [
|
|
3492
3958
|
{
|
|
3493
3959
|
name: "worker_id",
|
|
3494
|
-
sdkName: "worker_id"
|
|
3960
|
+
sdkName: "worker_id",
|
|
3961
|
+
description: "Worker ID (wkr_…)."
|
|
3495
3962
|
},
|
|
3496
3963
|
{
|
|
3497
3964
|
name: "deployment_id",
|
|
3498
|
-
sdkName: "deployment_id"
|
|
3965
|
+
sdkName: "deployment_id",
|
|
3966
|
+
description: "ID from the id of CreateDeployment or ListDeployments, prefixed dep_."
|
|
3499
3967
|
}
|
|
3500
3968
|
],
|
|
3501
3969
|
query: []
|
|
@@ -3512,7 +3980,8 @@ file at the root of that directory.`
|
|
|
3512
3980
|
pathParams: [
|
|
3513
3981
|
{
|
|
3514
3982
|
name: "worker_id",
|
|
3515
|
-
sdkName: "worker_id"
|
|
3983
|
+
sdkName: "worker_id",
|
|
3984
|
+
description: "Worker ID (wkr_…)."
|
|
3516
3985
|
}
|
|
3517
3986
|
],
|
|
3518
3987
|
query: [
|
|
@@ -3542,7 +4011,8 @@ file at the root of that directory.`
|
|
|
3542
4011
|
pathParams: [
|
|
3543
4012
|
{
|
|
3544
4013
|
name: "worker_id",
|
|
3545
|
-
sdkName: "worker_id"
|
|
4014
|
+
sdkName: "worker_id",
|
|
4015
|
+
description: "Worker ID (wkr_…)."
|
|
3546
4016
|
}
|
|
3547
4017
|
],
|
|
3548
4018
|
query: []
|
|
@@ -3559,7 +4029,8 @@ file at the root of that directory.`
|
|
|
3559
4029
|
pathParams: [
|
|
3560
4030
|
{
|
|
3561
4031
|
name: "worker_id",
|
|
3562
|
-
sdkName: "worker_id"
|
|
4032
|
+
sdkName: "worker_id",
|
|
4033
|
+
description: "Worker ID (wkr_…)."
|
|
3563
4034
|
}
|
|
3564
4035
|
],
|
|
3565
4036
|
query: [],
|
|
@@ -3597,11 +4068,13 @@ file at the root of that directory.`
|
|
|
3597
4068
|
pathParams: [
|
|
3598
4069
|
{
|
|
3599
4070
|
name: "worker_id",
|
|
3600
|
-
sdkName: "worker_id"
|
|
4071
|
+
sdkName: "worker_id",
|
|
4072
|
+
description: "Worker ID (wkr_…)."
|
|
3601
4073
|
},
|
|
3602
4074
|
{
|
|
3603
4075
|
name: "grant_id",
|
|
3604
|
-
sdkName: "grant_id"
|
|
4076
|
+
sdkName: "grant_id",
|
|
4077
|
+
description: "Grant ID (grt_…)."
|
|
3605
4078
|
}
|
|
3606
4079
|
],
|
|
3607
4080
|
query: []
|
|
@@ -3618,7 +4091,8 @@ file at the root of that directory.`
|
|
|
3618
4091
|
pathParams: [
|
|
3619
4092
|
{
|
|
3620
4093
|
name: "worker_id",
|
|
3621
|
-
sdkName: "worker_id"
|
|
4094
|
+
sdkName: "worker_id",
|
|
4095
|
+
description: "Worker ID (wkr_…)."
|
|
3622
4096
|
}
|
|
3623
4097
|
],
|
|
3624
4098
|
query: []
|
|
@@ -3635,7 +4109,8 @@ file at the root of that directory.`
|
|
|
3635
4109
|
pathParams: [
|
|
3636
4110
|
{
|
|
3637
4111
|
name: "worker_id",
|
|
3638
|
-
sdkName: "worker_id"
|
|
4112
|
+
sdkName: "worker_id",
|
|
4113
|
+
description: "Worker ID (wkr_…)."
|
|
3639
4114
|
}
|
|
3640
4115
|
],
|
|
3641
4116
|
query: []
|
|
@@ -3652,11 +4127,13 @@ file at the root of that directory.`
|
|
|
3652
4127
|
pathParams: [
|
|
3653
4128
|
{
|
|
3654
4129
|
name: "worker_id",
|
|
3655
|
-
sdkName: "worker_id"
|
|
4130
|
+
sdkName: "worker_id",
|
|
4131
|
+
description: "Worker ID (wkr_…)."
|
|
3656
4132
|
},
|
|
3657
4133
|
{
|
|
3658
4134
|
name: "name",
|
|
3659
|
-
sdkName: "name"
|
|
4135
|
+
sdkName: "name",
|
|
4136
|
+
description: "Secret name as seen in the Worker's env: 1–64 letters, digits or underscores, not starting with a digit."
|
|
3660
4137
|
}
|
|
3661
4138
|
],
|
|
3662
4139
|
query: []
|
|
@@ -3673,11 +4150,13 @@ file at the root of that directory.`
|
|
|
3673
4150
|
pathParams: [
|
|
3674
4151
|
{
|
|
3675
4152
|
name: "worker_id",
|
|
3676
|
-
sdkName: "worker_id"
|
|
4153
|
+
sdkName: "worker_id",
|
|
4154
|
+
description: "Worker ID (wkr_…)."
|
|
3677
4155
|
},
|
|
3678
4156
|
{
|
|
3679
4157
|
name: "name",
|
|
3680
|
-
sdkName: "name"
|
|
4158
|
+
sdkName: "name",
|
|
4159
|
+
description: "Secret name as seen in the Worker's env: 1–64 letters, digits or underscores, not starting with a digit."
|
|
3681
4160
|
}
|
|
3682
4161
|
],
|
|
3683
4162
|
query: [],
|
|
@@ -3705,7 +4184,8 @@ file at the root of that directory.`
|
|
|
3705
4184
|
pathParams: [
|
|
3706
4185
|
{
|
|
3707
4186
|
name: "worker_id",
|
|
3708
|
-
sdkName: "worker_id"
|
|
4187
|
+
sdkName: "worker_id",
|
|
4188
|
+
description: "Worker ID (wkr_…)."
|
|
3709
4189
|
}
|
|
3710
4190
|
],
|
|
3711
4191
|
query: [
|
|
@@ -3735,7 +4215,8 @@ file at the root of that directory.`
|
|
|
3735
4215
|
pathParams: [
|
|
3736
4216
|
{
|
|
3737
4217
|
name: "worker_id",
|
|
3738
|
-
sdkName: "worker_id"
|
|
4218
|
+
sdkName: "worker_id",
|
|
4219
|
+
description: "Worker ID (wkr_…)."
|
|
3739
4220
|
}
|
|
3740
4221
|
],
|
|
3741
4222
|
query: [],
|
|
@@ -3814,11 +4295,13 @@ file at the root of that directory.`
|
|
|
3814
4295
|
pathParams: [
|
|
3815
4296
|
{
|
|
3816
4297
|
name: "worker_id",
|
|
3817
|
-
sdkName: "worker_id"
|
|
4298
|
+
sdkName: "worker_id",
|
|
4299
|
+
description: "Worker ID (wkr_…)."
|
|
3818
4300
|
},
|
|
3819
4301
|
{
|
|
3820
4302
|
name: "version_id",
|
|
3821
|
-
sdkName: "version_id"
|
|
4303
|
+
sdkName: "version_id",
|
|
4304
|
+
description: "Version ID (ver_…)."
|
|
3822
4305
|
}
|
|
3823
4306
|
],
|
|
3824
4307
|
query: []
|
|
@@ -3835,11 +4318,13 @@ file at the root of that directory.`
|
|
|
3835
4318
|
pathParams: [
|
|
3836
4319
|
{
|
|
3837
4320
|
name: "worker_id",
|
|
3838
|
-
sdkName: "worker_id"
|
|
4321
|
+
sdkName: "worker_id",
|
|
4322
|
+
description: "Worker ID (wkr_…)."
|
|
3839
4323
|
},
|
|
3840
4324
|
{
|
|
3841
4325
|
name: "version_id",
|
|
3842
|
-
sdkName: "version_id"
|
|
4326
|
+
sdkName: "version_id",
|
|
4327
|
+
description: "Version ID from versions.list or the active deployment."
|
|
3843
4328
|
}
|
|
3844
4329
|
],
|
|
3845
4330
|
query: []
|
|
@@ -4025,11 +4510,13 @@ file at the root of that directory.`
|
|
|
4025
4510
|
pathParams: [
|
|
4026
4511
|
{
|
|
4027
4512
|
name: "ns",
|
|
4028
|
-
sdkName: "ns"
|
|
4513
|
+
sdkName: "ns",
|
|
4514
|
+
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
4515
|
},
|
|
4030
4516
|
{
|
|
4031
4517
|
name: "name",
|
|
4032
|
-
sdkName: "name"
|
|
4518
|
+
sdkName: "name",
|
|
4519
|
+
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
4520
|
}
|
|
4034
4521
|
],
|
|
4035
4522
|
query: []
|
|
@@ -4046,11 +4533,13 @@ file at the root of that directory.`
|
|
|
4046
4533
|
pathParams: [
|
|
4047
4534
|
{
|
|
4048
4535
|
name: "ns",
|
|
4049
|
-
sdkName: "ns"
|
|
4536
|
+
sdkName: "ns",
|
|
4537
|
+
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
4538
|
},
|
|
4051
4539
|
{
|
|
4052
4540
|
name: "name",
|
|
4053
|
-
sdkName: "name"
|
|
4541
|
+
sdkName: "name",
|
|
4542
|
+
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
4543
|
}
|
|
4055
4544
|
],
|
|
4056
4545
|
query: [
|
|
@@ -4134,11 +4623,13 @@ file at the root of that directory.`
|
|
|
4134
4623
|
pathParams: [
|
|
4135
4624
|
{
|
|
4136
4625
|
name: "ns",
|
|
4137
|
-
sdkName: "ns"
|
|
4626
|
+
sdkName: "ns",
|
|
4627
|
+
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
4628
|
},
|
|
4139
4629
|
{
|
|
4140
4630
|
name: "name",
|
|
4141
|
-
sdkName: "name"
|
|
4631
|
+
sdkName: "name",
|
|
4632
|
+
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
4633
|
}
|
|
4143
4634
|
],
|
|
4144
4635
|
query: [],
|
|
@@ -4159,11 +4650,13 @@ file at the root of that directory.`
|
|
|
4159
4650
|
pathParams: [
|
|
4160
4651
|
{
|
|
4161
4652
|
name: "ns",
|
|
4162
|
-
sdkName: "ns"
|
|
4653
|
+
sdkName: "ns",
|
|
4654
|
+
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
4655
|
},
|
|
4164
4656
|
{
|
|
4165
4657
|
name: "name",
|
|
4166
|
-
sdkName: "name"
|
|
4658
|
+
sdkName: "name",
|
|
4659
|
+
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
4660
|
}
|
|
4168
4661
|
],
|
|
4169
4662
|
query: [
|
|
@@ -4193,11 +4686,13 @@ file at the root of that directory.`
|
|
|
4193
4686
|
pathParams: [
|
|
4194
4687
|
{
|
|
4195
4688
|
name: "ns",
|
|
4196
|
-
sdkName: "ns"
|
|
4689
|
+
sdkName: "ns",
|
|
4690
|
+
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
4691
|
},
|
|
4198
4692
|
{
|
|
4199
4693
|
name: "name",
|
|
4200
|
-
sdkName: "name"
|
|
4694
|
+
sdkName: "name",
|
|
4695
|
+
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
4696
|
}
|
|
4202
4697
|
],
|
|
4203
4698
|
query: [
|
|
@@ -4268,11 +4763,13 @@ file at the root of that directory.`
|
|
|
4268
4763
|
pathParams: [
|
|
4269
4764
|
{
|
|
4270
4765
|
name: "ns",
|
|
4271
|
-
sdkName: "ns"
|
|
4766
|
+
sdkName: "ns",
|
|
4767
|
+
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
4768
|
},
|
|
4273
4769
|
{
|
|
4274
4770
|
name: "name",
|
|
4275
|
-
sdkName: "name"
|
|
4771
|
+
sdkName: "name",
|
|
4772
|
+
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
4773
|
}
|
|
4277
4774
|
],
|
|
4278
4775
|
query: [],
|
|
@@ -4293,11 +4790,13 @@ file at the root of that directory.`
|
|
|
4293
4790
|
pathParams: [
|
|
4294
4791
|
{
|
|
4295
4792
|
name: "ns",
|
|
4296
|
-
sdkName: "ns"
|
|
4793
|
+
sdkName: "ns",
|
|
4794
|
+
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
4795
|
},
|
|
4298
4796
|
{
|
|
4299
4797
|
name: "name",
|
|
4300
|
-
sdkName: "name"
|
|
4798
|
+
sdkName: "name",
|
|
4799
|
+
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
4800
|
}
|
|
4302
4801
|
],
|
|
4303
4802
|
query: [
|
|
@@ -4336,15 +4835,18 @@ file at the root of that directory.`
|
|
|
4336
4835
|
pathParams: [
|
|
4337
4836
|
{
|
|
4338
4837
|
name: "ns",
|
|
4339
|
-
sdkName: "ns"
|
|
4838
|
+
sdkName: "ns",
|
|
4839
|
+
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
4840
|
},
|
|
4341
4841
|
{
|
|
4342
4842
|
name: "name",
|
|
4343
|
-
sdkName: "name"
|
|
4843
|
+
sdkName: "name",
|
|
4844
|
+
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
4845
|
},
|
|
4345
4846
|
{
|
|
4346
4847
|
name: "revision",
|
|
4347
|
-
sdkName: "revision"
|
|
4848
|
+
sdkName: "revision",
|
|
4849
|
+
description: "Action revision ID (actr_); the query parameter filters invocation records."
|
|
4348
4850
|
}
|
|
4349
4851
|
],
|
|
4350
4852
|
query: []
|
|
@@ -4361,11 +4863,13 @@ file at the root of that directory.`
|
|
|
4361
4863
|
pathParams: [
|
|
4362
4864
|
{
|
|
4363
4865
|
name: "ns",
|
|
4364
|
-
sdkName: "ns"
|
|
4866
|
+
sdkName: "ns",
|
|
4867
|
+
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
4868
|
},
|
|
4366
4869
|
{
|
|
4367
4870
|
name: "name",
|
|
4368
|
-
sdkName: "name"
|
|
4871
|
+
sdkName: "name",
|
|
4872
|
+
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
4873
|
}
|
|
4370
4874
|
],
|
|
4371
4875
|
query: [],
|
|
@@ -4399,11 +4903,13 @@ file at the root of that directory.`
|
|
|
4399
4903
|
pathParams: [
|
|
4400
4904
|
{
|
|
4401
4905
|
name: "trigger_id",
|
|
4402
|
-
sdkName: "trigger_id"
|
|
4906
|
+
sdkName: "trigger_id",
|
|
4907
|
+
description: "Trigger ID (trg_)."
|
|
4403
4908
|
},
|
|
4404
4909
|
{
|
|
4405
4910
|
name: "token",
|
|
4406
|
-
sdkName: "token"
|
|
4911
|
+
sdkName: "token",
|
|
4912
|
+
description: "Secret URL token returned on creation or rotation; do not disclose it."
|
|
4407
4913
|
}
|
|
4408
4914
|
],
|
|
4409
4915
|
query: [],
|
|
@@ -4616,7 +5122,8 @@ file at the root of that directory.`
|
|
|
4616
5122
|
pathParams: [
|
|
4617
5123
|
{
|
|
4618
5124
|
name: "id",
|
|
4619
|
-
sdkName: "id"
|
|
5125
|
+
sdkName: "id",
|
|
5126
|
+
description: "Run ID (run_)."
|
|
4620
5127
|
}
|
|
4621
5128
|
],
|
|
4622
5129
|
query: [
|
|
@@ -4654,7 +5161,8 @@ file at the root of that directory.`
|
|
|
4654
5161
|
pathParams: [
|
|
4655
5162
|
{
|
|
4656
5163
|
name: "id",
|
|
4657
|
-
sdkName: "id"
|
|
5164
|
+
sdkName: "id",
|
|
5165
|
+
description: "Run ID (run_)."
|
|
4658
5166
|
}
|
|
4659
5167
|
],
|
|
4660
5168
|
query: [
|
|
@@ -4684,7 +5192,8 @@ file at the root of that directory.`
|
|
|
4684
5192
|
pathParams: [
|
|
4685
5193
|
{
|
|
4686
5194
|
name: "id",
|
|
4687
|
-
sdkName: "id"
|
|
5195
|
+
sdkName: "id",
|
|
5196
|
+
description: "Run ID (run_)."
|
|
4688
5197
|
}
|
|
4689
5198
|
],
|
|
4690
5199
|
query: [
|
|
@@ -4714,7 +5223,8 @@ file at the root of that directory.`
|
|
|
4714
5223
|
pathParams: [
|
|
4715
5224
|
{
|
|
4716
5225
|
name: "id",
|
|
4717
|
-
sdkName: "id"
|
|
5226
|
+
sdkName: "id",
|
|
5227
|
+
description: "Run ID (run_)."
|
|
4718
5228
|
}
|
|
4719
5229
|
],
|
|
4720
5230
|
query: [],
|
|
@@ -4742,7 +5252,8 @@ file at the root of that directory.`
|
|
|
4742
5252
|
pathParams: [
|
|
4743
5253
|
{
|
|
4744
5254
|
name: "id",
|
|
4745
|
-
sdkName: "id"
|
|
5255
|
+
sdkName: "id",
|
|
5256
|
+
description: "Run ID (run_)."
|
|
4746
5257
|
}
|
|
4747
5258
|
],
|
|
4748
5259
|
query: [
|
|
@@ -4772,7 +5283,8 @@ file at the root of that directory.`
|
|
|
4772
5283
|
pathParams: [
|
|
4773
5284
|
{
|
|
4774
5285
|
name: "id",
|
|
4775
|
-
sdkName: "id"
|
|
5286
|
+
sdkName: "id",
|
|
5287
|
+
description: "Run ID (run_)."
|
|
4776
5288
|
}
|
|
4777
5289
|
],
|
|
4778
5290
|
query: [
|
|
@@ -4802,7 +5314,8 @@ file at the root of that directory.`
|
|
|
4802
5314
|
pathParams: [
|
|
4803
5315
|
{
|
|
4804
5316
|
name: "id",
|
|
4805
|
-
sdkName: "id"
|
|
5317
|
+
sdkName: "id",
|
|
5318
|
+
description: "Run ID (run_)."
|
|
4806
5319
|
}
|
|
4807
5320
|
],
|
|
4808
5321
|
query: [],
|
|
@@ -4830,7 +5343,8 @@ file at the root of that directory.`
|
|
|
4830
5343
|
pathParams: [
|
|
4831
5344
|
{
|
|
4832
5345
|
name: "id",
|
|
4833
|
-
sdkName: "id"
|
|
5346
|
+
sdkName: "id",
|
|
5347
|
+
description: "Run ID (run_)."
|
|
4834
5348
|
}
|
|
4835
5349
|
],
|
|
4836
5350
|
query: [],
|
|
@@ -4851,7 +5365,8 @@ file at the root of that directory.`
|
|
|
4851
5365
|
pathParams: [
|
|
4852
5366
|
{
|
|
4853
5367
|
name: "id",
|
|
4854
|
-
sdkName: "id"
|
|
5368
|
+
sdkName: "id",
|
|
5369
|
+
description: "Run ID (run_)."
|
|
4855
5370
|
}
|
|
4856
5371
|
],
|
|
4857
5372
|
query: []
|
|
@@ -4868,7 +5383,8 @@ file at the root of that directory.`
|
|
|
4868
5383
|
pathParams: [
|
|
4869
5384
|
{
|
|
4870
5385
|
name: "id",
|
|
4871
|
-
sdkName: "id"
|
|
5386
|
+
sdkName: "id",
|
|
5387
|
+
description: "Run ID (run_)."
|
|
4872
5388
|
}
|
|
4873
5389
|
],
|
|
4874
5390
|
query: [],
|
|
@@ -4889,7 +5405,8 @@ file at the root of that directory.`
|
|
|
4889
5405
|
pathParams: [
|
|
4890
5406
|
{
|
|
4891
5407
|
name: "id",
|
|
4892
|
-
sdkName: "id"
|
|
5408
|
+
sdkName: "id",
|
|
5409
|
+
description: "Run ID (run_)."
|
|
4893
5410
|
}
|
|
4894
5411
|
],
|
|
4895
5412
|
query: [
|
|
@@ -4937,7 +5454,8 @@ file at the root of that directory.`
|
|
|
4937
5454
|
pathParams: [
|
|
4938
5455
|
{
|
|
4939
5456
|
name: "id",
|
|
4940
|
-
sdkName: "id"
|
|
5457
|
+
sdkName: "id",
|
|
5458
|
+
description: "Run ID (run_)."
|
|
4941
5459
|
}
|
|
4942
5460
|
],
|
|
4943
5461
|
query: [
|
|
@@ -4967,11 +5485,13 @@ file at the root of that directory.`
|
|
|
4967
5485
|
pathParams: [
|
|
4968
5486
|
{
|
|
4969
5487
|
name: "id",
|
|
4970
|
-
sdkName: "id"
|
|
5488
|
+
sdkName: "id",
|
|
5489
|
+
description: "Run ID (run_)."
|
|
4971
5490
|
},
|
|
4972
5491
|
{
|
|
4973
5492
|
name: "wait_id",
|
|
4974
|
-
sdkName: "wait_id"
|
|
5493
|
+
sdkName: "wait_id",
|
|
5494
|
+
description: "Wait ID (wait_) belonging to this run."
|
|
4975
5495
|
}
|
|
4976
5496
|
],
|
|
4977
5497
|
query: [],
|
|
@@ -5125,11 +5645,13 @@ file at the root of that directory.`
|
|
|
5125
5645
|
pathParams: [
|
|
5126
5646
|
{
|
|
5127
5647
|
name: "ns",
|
|
5128
|
-
sdkName: "ns"
|
|
5648
|
+
sdkName: "ns",
|
|
5649
|
+
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
5650
|
},
|
|
5130
5651
|
{
|
|
5131
5652
|
name: "name",
|
|
5132
|
-
sdkName: "name"
|
|
5653
|
+
sdkName: "name",
|
|
5654
|
+
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
5655
|
}
|
|
5134
5656
|
],
|
|
5135
5657
|
query: []
|
|
@@ -5146,11 +5668,13 @@ file at the root of that directory.`
|
|
|
5146
5668
|
pathParams: [
|
|
5147
5669
|
{
|
|
5148
5670
|
name: "ns",
|
|
5149
|
-
sdkName: "ns"
|
|
5671
|
+
sdkName: "ns",
|
|
5672
|
+
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
5673
|
},
|
|
5151
5674
|
{
|
|
5152
5675
|
name: "name",
|
|
5153
|
-
sdkName: "name"
|
|
5676
|
+
sdkName: "name",
|
|
5677
|
+
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
5678
|
}
|
|
5155
5679
|
],
|
|
5156
5680
|
query: [],
|
|
@@ -5190,11 +5714,13 @@ file at the root of that directory.`
|
|
|
5190
5714
|
pathParams: [
|
|
5191
5715
|
{
|
|
5192
5716
|
name: "ns",
|
|
5193
|
-
sdkName: "ns"
|
|
5717
|
+
sdkName: "ns",
|
|
5718
|
+
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
5719
|
},
|
|
5195
5720
|
{
|
|
5196
5721
|
name: "name",
|
|
5197
|
-
sdkName: "name"
|
|
5722
|
+
sdkName: "name",
|
|
5723
|
+
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
5724
|
}
|
|
5199
5725
|
],
|
|
5200
5726
|
query: [],
|
|
@@ -5215,11 +5741,13 @@ file at the root of that directory.`
|
|
|
5215
5741
|
pathParams: [
|
|
5216
5742
|
{
|
|
5217
5743
|
name: "ns",
|
|
5218
|
-
sdkName: "ns"
|
|
5744
|
+
sdkName: "ns",
|
|
5745
|
+
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
5746
|
},
|
|
5220
5747
|
{
|
|
5221
5748
|
name: "name",
|
|
5222
|
-
sdkName: "name"
|
|
5749
|
+
sdkName: "name",
|
|
5750
|
+
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
5751
|
}
|
|
5224
5752
|
],
|
|
5225
5753
|
query: []
|
|
@@ -5236,15 +5764,18 @@ file at the root of that directory.`
|
|
|
5236
5764
|
pathParams: [
|
|
5237
5765
|
{
|
|
5238
5766
|
name: "ns",
|
|
5239
|
-
sdkName: "ns"
|
|
5767
|
+
sdkName: "ns",
|
|
5768
|
+
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
5769
|
},
|
|
5241
5770
|
{
|
|
5242
5771
|
name: "name",
|
|
5243
|
-
sdkName: "name"
|
|
5772
|
+
sdkName: "name",
|
|
5773
|
+
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
5774
|
},
|
|
5245
5775
|
{
|
|
5246
5776
|
name: "tag",
|
|
5247
|
-
sdkName: "tag"
|
|
5777
|
+
sdkName: "tag",
|
|
5778
|
+
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
5779
|
}
|
|
5249
5780
|
],
|
|
5250
5781
|
query: []
|
|
@@ -5261,15 +5792,18 @@ file at the root of that directory.`
|
|
|
5261
5792
|
pathParams: [
|
|
5262
5793
|
{
|
|
5263
5794
|
name: "ns",
|
|
5264
|
-
sdkName: "ns"
|
|
5795
|
+
sdkName: "ns",
|
|
5796
|
+
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
5797
|
},
|
|
5266
5798
|
{
|
|
5267
5799
|
name: "name",
|
|
5268
|
-
sdkName: "name"
|
|
5800
|
+
sdkName: "name",
|
|
5801
|
+
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
5802
|
},
|
|
5270
5803
|
{
|
|
5271
5804
|
name: "tag",
|
|
5272
|
-
sdkName: "tag"
|
|
5805
|
+
sdkName: "tag",
|
|
5806
|
+
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
5807
|
}
|
|
5274
5808
|
],
|
|
5275
5809
|
query: [],
|
|
@@ -5297,11 +5831,13 @@ file at the root of that directory.`
|
|
|
5297
5831
|
pathParams: [
|
|
5298
5832
|
{
|
|
5299
5833
|
name: "ns",
|
|
5300
|
-
sdkName: "ns"
|
|
5834
|
+
sdkName: "ns",
|
|
5835
|
+
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
5836
|
},
|
|
5302
5837
|
{
|
|
5303
5838
|
name: "name",
|
|
5304
|
-
sdkName: "name"
|
|
5839
|
+
sdkName: "name",
|
|
5840
|
+
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
5841
|
}
|
|
5306
5842
|
],
|
|
5307
5843
|
query: [],
|
|
@@ -5322,11 +5858,13 @@ file at the root of that directory.`
|
|
|
5322
5858
|
pathParams: [
|
|
5323
5859
|
{
|
|
5324
5860
|
name: "ns",
|
|
5325
|
-
sdkName: "ns"
|
|
5861
|
+
sdkName: "ns",
|
|
5862
|
+
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
5863
|
},
|
|
5327
5864
|
{
|
|
5328
5865
|
name: "name",
|
|
5329
|
-
sdkName: "name"
|
|
5866
|
+
sdkName: "name",
|
|
5867
|
+
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
5868
|
}
|
|
5331
5869
|
],
|
|
5332
5870
|
query: [
|
|
@@ -5368,11 +5906,13 @@ file at the root of that directory.`
|
|
|
5368
5906
|
pathParams: [
|
|
5369
5907
|
{
|
|
5370
5908
|
name: "ns",
|
|
5371
|
-
sdkName: "ns"
|
|
5909
|
+
sdkName: "ns",
|
|
5910
|
+
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
5911
|
},
|
|
5373
5912
|
{
|
|
5374
5913
|
name: "name",
|
|
5375
|
-
sdkName: "name"
|
|
5914
|
+
sdkName: "name",
|
|
5915
|
+
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
5916
|
}
|
|
5377
5917
|
],
|
|
5378
5918
|
query: [],
|
|
@@ -5393,15 +5933,18 @@ file at the root of that directory.`
|
|
|
5393
5933
|
pathParams: [
|
|
5394
5934
|
{
|
|
5395
5935
|
name: "ns",
|
|
5396
|
-
sdkName: "ns"
|
|
5936
|
+
sdkName: "ns",
|
|
5937
|
+
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
5938
|
},
|
|
5398
5939
|
{
|
|
5399
5940
|
name: "name",
|
|
5400
|
-
sdkName: "name"
|
|
5941
|
+
sdkName: "name",
|
|
5942
|
+
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
5943
|
},
|
|
5402
5944
|
{
|
|
5403
5945
|
name: "version",
|
|
5404
|
-
sdkName: "version"
|
|
5946
|
+
sdkName: "version",
|
|
5947
|
+
description: "Exact version or dist-tag; ranges are rejected with 400 and a hint."
|
|
5405
5948
|
}
|
|
5406
5949
|
],
|
|
5407
5950
|
query: []
|
|
@@ -5418,15 +5961,18 @@ file at the root of that directory.`
|
|
|
5418
5961
|
pathParams: [
|
|
5419
5962
|
{
|
|
5420
5963
|
name: "ns",
|
|
5421
|
-
sdkName: "ns"
|
|
5964
|
+
sdkName: "ns",
|
|
5965
|
+
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
5966
|
},
|
|
5423
5967
|
{
|
|
5424
5968
|
name: "name",
|
|
5425
|
-
sdkName: "name"
|
|
5969
|
+
sdkName: "name",
|
|
5970
|
+
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
5971
|
},
|
|
5427
5972
|
{
|
|
5428
5973
|
name: "version",
|
|
5429
|
-
sdkName: "version"
|
|
5974
|
+
sdkName: "version",
|
|
5975
|
+
description: "An exact canonical semantic version, such as 1.2.0 or 1.3.0-beta.1, not a range."
|
|
5430
5976
|
}
|
|
5431
5977
|
],
|
|
5432
5978
|
query: [],
|
|
@@ -5732,7 +6278,8 @@ file at the root of that directory.`
|
|
|
5732
6278
|
pathParams: [
|
|
5733
6279
|
{
|
|
5734
6280
|
name: "id",
|
|
5735
|
-
sdkName: "id"
|
|
6281
|
+
sdkName: "id",
|
|
6282
|
+
description: "Trigger ID (trg_)."
|
|
5736
6283
|
}
|
|
5737
6284
|
],
|
|
5738
6285
|
query: []
|
|
@@ -5749,7 +6296,8 @@ file at the root of that directory.`
|
|
|
5749
6296
|
pathParams: [
|
|
5750
6297
|
{
|
|
5751
6298
|
name: "id",
|
|
5752
|
-
sdkName: "id"
|
|
6299
|
+
sdkName: "id",
|
|
6300
|
+
description: "Trigger ID (trg_)."
|
|
5753
6301
|
}
|
|
5754
6302
|
],
|
|
5755
6303
|
query: []
|
|
@@ -5766,7 +6314,8 @@ file at the root of that directory.`
|
|
|
5766
6314
|
pathParams: [
|
|
5767
6315
|
{
|
|
5768
6316
|
name: "id",
|
|
5769
|
-
sdkName: "id"
|
|
6317
|
+
sdkName: "id",
|
|
6318
|
+
description: "Trigger ID (trg_)."
|
|
5770
6319
|
}
|
|
5771
6320
|
],
|
|
5772
6321
|
query: [],
|
|
@@ -5874,7 +6423,8 @@ file at the root of that directory.`
|
|
|
5874
6423
|
pathParams: [
|
|
5875
6424
|
{
|
|
5876
6425
|
name: "id",
|
|
5877
|
-
sdkName: "id"
|
|
6426
|
+
sdkName: "id",
|
|
6427
|
+
description: "Trigger ID (trg_)."
|
|
5878
6428
|
}
|
|
5879
6429
|
],
|
|
5880
6430
|
query: []
|
|
@@ -5891,7 +6441,8 @@ file at the root of that directory.`
|
|
|
5891
6441
|
pathParams: [
|
|
5892
6442
|
{
|
|
5893
6443
|
name: "id",
|
|
5894
|
-
sdkName: "id"
|
|
6444
|
+
sdkName: "id",
|
|
6445
|
+
description: "Trigger ID (trg_)."
|
|
5895
6446
|
}
|
|
5896
6447
|
],
|
|
5897
6448
|
query: [
|
|
@@ -5942,7 +6493,8 @@ file at the root of that directory.`
|
|
|
5942
6493
|
pathParams: [
|
|
5943
6494
|
{
|
|
5944
6495
|
name: "id",
|
|
5945
|
-
sdkName: "id"
|
|
6496
|
+
sdkName: "id",
|
|
6497
|
+
description: "Trigger ID (trg_)."
|
|
5946
6498
|
}
|
|
5947
6499
|
],
|
|
5948
6500
|
query: []
|
|
@@ -5959,7 +6511,8 @@ file at the root of that directory.`
|
|
|
5959
6511
|
pathParams: [
|
|
5960
6512
|
{
|
|
5961
6513
|
name: "id",
|
|
5962
|
-
sdkName: "id"
|
|
6514
|
+
sdkName: "id",
|
|
6515
|
+
description: "Trigger ID (trg_)."
|
|
5963
6516
|
}
|
|
5964
6517
|
],
|
|
5965
6518
|
query: []
|
|
@@ -5976,7 +6529,8 @@ file at the root of that directory.`
|
|
|
5976
6529
|
pathParams: [
|
|
5977
6530
|
{
|
|
5978
6531
|
name: "id",
|
|
5979
|
-
sdkName: "id"
|
|
6532
|
+
sdkName: "id",
|
|
6533
|
+
description: "Trigger ID (trg_)."
|
|
5980
6534
|
}
|
|
5981
6535
|
],
|
|
5982
6536
|
query: []
|
|
@@ -6147,11 +6701,13 @@ file at the root of that directory.`
|
|
|
6147
6701
|
pathParams: [
|
|
6148
6702
|
{
|
|
6149
6703
|
name: "ns",
|
|
6150
|
-
sdkName: "ns"
|
|
6704
|
+
sdkName: "ns",
|
|
6705
|
+
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
6706
|
},
|
|
6152
6707
|
{
|
|
6153
6708
|
name: "name",
|
|
6154
|
-
sdkName: "name"
|
|
6709
|
+
sdkName: "name",
|
|
6710
|
+
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
6711
|
}
|
|
6156
6712
|
],
|
|
6157
6713
|
query: []
|
|
@@ -6168,11 +6724,13 @@ file at the root of that directory.`
|
|
|
6168
6724
|
pathParams: [
|
|
6169
6725
|
{
|
|
6170
6726
|
name: "ns",
|
|
6171
|
-
sdkName: "ns"
|
|
6727
|
+
sdkName: "ns",
|
|
6728
|
+
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
6729
|
},
|
|
6173
6730
|
{
|
|
6174
6731
|
name: "name",
|
|
6175
|
-
sdkName: "name"
|
|
6732
|
+
sdkName: "name",
|
|
6733
|
+
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
6734
|
}
|
|
6177
6735
|
],
|
|
6178
6736
|
query: [],
|
|
@@ -6212,11 +6770,13 @@ file at the root of that directory.`
|
|
|
6212
6770
|
pathParams: [
|
|
6213
6771
|
{
|
|
6214
6772
|
name: "ns",
|
|
6215
|
-
sdkName: "ns"
|
|
6773
|
+
sdkName: "ns",
|
|
6774
|
+
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
6775
|
},
|
|
6217
6776
|
{
|
|
6218
6777
|
name: "name",
|
|
6219
|
-
sdkName: "name"
|
|
6778
|
+
sdkName: "name",
|
|
6779
|
+
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
6780
|
}
|
|
6221
6781
|
],
|
|
6222
6782
|
query: [],
|
|
@@ -6237,11 +6797,13 @@ file at the root of that directory.`
|
|
|
6237
6797
|
pathParams: [
|
|
6238
6798
|
{
|
|
6239
6799
|
name: "ns",
|
|
6240
|
-
sdkName: "ns"
|
|
6800
|
+
sdkName: "ns",
|
|
6801
|
+
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
6802
|
},
|
|
6242
6803
|
{
|
|
6243
6804
|
name: "name",
|
|
6244
|
-
sdkName: "name"
|
|
6805
|
+
sdkName: "name",
|
|
6806
|
+
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
6807
|
}
|
|
6246
6808
|
],
|
|
6247
6809
|
query: []
|
|
@@ -6258,15 +6820,18 @@ file at the root of that directory.`
|
|
|
6258
6820
|
pathParams: [
|
|
6259
6821
|
{
|
|
6260
6822
|
name: "ns",
|
|
6261
|
-
sdkName: "ns"
|
|
6823
|
+
sdkName: "ns",
|
|
6824
|
+
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
6825
|
},
|
|
6263
6826
|
{
|
|
6264
6827
|
name: "name",
|
|
6265
|
-
sdkName: "name"
|
|
6828
|
+
sdkName: "name",
|
|
6829
|
+
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
6830
|
},
|
|
6267
6831
|
{
|
|
6268
6832
|
name: "tag",
|
|
6269
|
-
sdkName: "tag"
|
|
6833
|
+
sdkName: "tag",
|
|
6834
|
+
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
6835
|
}
|
|
6271
6836
|
],
|
|
6272
6837
|
query: []
|
|
@@ -6283,15 +6848,18 @@ file at the root of that directory.`
|
|
|
6283
6848
|
pathParams: [
|
|
6284
6849
|
{
|
|
6285
6850
|
name: "ns",
|
|
6286
|
-
sdkName: "ns"
|
|
6851
|
+
sdkName: "ns",
|
|
6852
|
+
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
6853
|
},
|
|
6288
6854
|
{
|
|
6289
6855
|
name: "name",
|
|
6290
|
-
sdkName: "name"
|
|
6856
|
+
sdkName: "name",
|
|
6857
|
+
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
6858
|
},
|
|
6292
6859
|
{
|
|
6293
6860
|
name: "tag",
|
|
6294
|
-
sdkName: "tag"
|
|
6861
|
+
sdkName: "tag",
|
|
6862
|
+
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
6863
|
}
|
|
6296
6864
|
],
|
|
6297
6865
|
query: [],
|
|
@@ -6319,11 +6887,13 @@ file at the root of that directory.`
|
|
|
6319
6887
|
pathParams: [
|
|
6320
6888
|
{
|
|
6321
6889
|
name: "ns",
|
|
6322
|
-
sdkName: "ns"
|
|
6890
|
+
sdkName: "ns",
|
|
6891
|
+
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
6892
|
},
|
|
6324
6893
|
{
|
|
6325
6894
|
name: "name",
|
|
6326
|
-
sdkName: "name"
|
|
6895
|
+
sdkName: "name",
|
|
6896
|
+
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
6897
|
}
|
|
6328
6898
|
],
|
|
6329
6899
|
query: [],
|
|
@@ -6344,11 +6914,13 @@ file at the root of that directory.`
|
|
|
6344
6914
|
pathParams: [
|
|
6345
6915
|
{
|
|
6346
6916
|
name: "ns",
|
|
6347
|
-
sdkName: "ns"
|
|
6917
|
+
sdkName: "ns",
|
|
6918
|
+
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
6919
|
},
|
|
6349
6920
|
{
|
|
6350
6921
|
name: "name",
|
|
6351
|
-
sdkName: "name"
|
|
6922
|
+
sdkName: "name",
|
|
6923
|
+
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
6924
|
}
|
|
6353
6925
|
],
|
|
6354
6926
|
query: [
|
|
@@ -6390,11 +6962,13 @@ file at the root of that directory.`
|
|
|
6390
6962
|
pathParams: [
|
|
6391
6963
|
{
|
|
6392
6964
|
name: "ns",
|
|
6393
|
-
sdkName: "ns"
|
|
6965
|
+
sdkName: "ns",
|
|
6966
|
+
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
6967
|
},
|
|
6395
6968
|
{
|
|
6396
6969
|
name: "name",
|
|
6397
|
-
sdkName: "name"
|
|
6970
|
+
sdkName: "name",
|
|
6971
|
+
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
6972
|
}
|
|
6399
6973
|
],
|
|
6400
6974
|
query: [],
|
|
@@ -6415,15 +6989,18 @@ file at the root of that directory.`
|
|
|
6415
6989
|
pathParams: [
|
|
6416
6990
|
{
|
|
6417
6991
|
name: "ns",
|
|
6418
|
-
sdkName: "ns"
|
|
6992
|
+
sdkName: "ns",
|
|
6993
|
+
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
6994
|
},
|
|
6420
6995
|
{
|
|
6421
6996
|
name: "name",
|
|
6422
|
-
sdkName: "name"
|
|
6997
|
+
sdkName: "name",
|
|
6998
|
+
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
6999
|
},
|
|
6424
7000
|
{
|
|
6425
7001
|
name: "version",
|
|
6426
|
-
sdkName: "version"
|
|
7002
|
+
sdkName: "version",
|
|
7003
|
+
description: "Exact version or dist-tag; ranges are rejected with 400 and a hint."
|
|
6427
7004
|
}
|
|
6428
7005
|
],
|
|
6429
7006
|
query: []
|
|
@@ -6440,15 +7017,18 @@ file at the root of that directory.`
|
|
|
6440
7017
|
pathParams: [
|
|
6441
7018
|
{
|
|
6442
7019
|
name: "ns",
|
|
6443
|
-
sdkName: "ns"
|
|
7020
|
+
sdkName: "ns",
|
|
7021
|
+
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
7022
|
},
|
|
6445
7023
|
{
|
|
6446
7024
|
name: "name",
|
|
6447
|
-
sdkName: "name"
|
|
7025
|
+
sdkName: "name",
|
|
7026
|
+
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
7027
|
},
|
|
6449
7028
|
{
|
|
6450
7029
|
name: "version",
|
|
6451
|
-
sdkName: "version"
|
|
7030
|
+
sdkName: "version",
|
|
7031
|
+
description: "An exact canonical semantic version, such as 1.2.0 or 1.3.0-beta.1, not a range."
|
|
6452
7032
|
}
|
|
6453
7033
|
],
|
|
6454
7034
|
query: [],
|
|
@@ -6603,7 +7183,8 @@ file at the root of that directory.`
|
|
|
6603
7183
|
pathParams: [
|
|
6604
7184
|
{
|
|
6605
7185
|
name: "contextId",
|
|
6606
|
-
sdkName: "contextId"
|
|
7186
|
+
sdkName: "contextId",
|
|
7187
|
+
description: "登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。"
|
|
6607
7188
|
}
|
|
6608
7189
|
],
|
|
6609
7190
|
query: []
|
|
@@ -6620,7 +7201,8 @@ file at the root of that directory.`
|
|
|
6620
7201
|
pathParams: [
|
|
6621
7202
|
{
|
|
6622
7203
|
name: "contextId",
|
|
6623
|
-
sdkName: "contextId"
|
|
7204
|
+
sdkName: "contextId",
|
|
7205
|
+
description: "登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。"
|
|
6624
7206
|
}
|
|
6625
7207
|
],
|
|
6626
7208
|
query: []
|
|
@@ -6637,7 +7219,8 @@ file at the root of that directory.`
|
|
|
6637
7219
|
pathParams: [
|
|
6638
7220
|
{
|
|
6639
7221
|
name: "contextId",
|
|
6640
|
-
sdkName: "contextId"
|
|
7222
|
+
sdkName: "contextId",
|
|
7223
|
+
description: "登录态 ID;使用创建或列出登录态返回的 id,以 bsc_ 开头。"
|
|
6641
7224
|
}
|
|
6642
7225
|
],
|
|
6643
7226
|
query: [],
|
|
@@ -6671,11 +7254,13 @@ file at the root of that directory.`
|
|
|
6671
7254
|
pathParams: [
|
|
6672
7255
|
{
|
|
6673
7256
|
name: "sessionId",
|
|
6674
|
-
sdkName: "sessionId"
|
|
7257
|
+
sdkName: "sessionId",
|
|
7258
|
+
description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
|
|
6675
7259
|
},
|
|
6676
7260
|
{
|
|
6677
7261
|
name: "pageId",
|
|
6678
|
-
sdkName: "pageId"
|
|
7262
|
+
sdkName: "pageId",
|
|
7263
|
+
description: "实时观看地址中的标签页 ID;使用 debug 返回链接中的原值,_ 表示会话级画面。"
|
|
6679
7264
|
}
|
|
6680
7265
|
],
|
|
6681
7266
|
query: [
|
|
@@ -6844,7 +7429,8 @@ file at the root of that directory.`
|
|
|
6844
7429
|
pathParams: [
|
|
6845
7430
|
{
|
|
6846
7431
|
name: "sessionId",
|
|
6847
|
-
sdkName: "sessionId"
|
|
7432
|
+
sdkName: "sessionId",
|
|
7433
|
+
description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
|
|
6848
7434
|
}
|
|
6849
7435
|
],
|
|
6850
7436
|
query: [
|
|
@@ -6868,7 +7454,8 @@ file at the root of that directory.`
|
|
|
6868
7454
|
pathParams: [
|
|
6869
7455
|
{
|
|
6870
7456
|
name: "sessionId",
|
|
6871
|
-
sdkName: "sessionId"
|
|
7457
|
+
sdkName: "sessionId",
|
|
7458
|
+
description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
|
|
6872
7459
|
}
|
|
6873
7460
|
],
|
|
6874
7461
|
query: [],
|
|
@@ -6899,7 +7486,8 @@ file at the root of that directory.`
|
|
|
6899
7486
|
pathParams: [
|
|
6900
7487
|
{
|
|
6901
7488
|
name: "sessionId",
|
|
6902
|
-
sdkName: "sessionId"
|
|
7489
|
+
sdkName: "sessionId",
|
|
7490
|
+
description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
|
|
6903
7491
|
}
|
|
6904
7492
|
],
|
|
6905
7493
|
query: []
|
|
@@ -6916,7 +7504,8 @@ file at the root of that directory.`
|
|
|
6916
7504
|
pathParams: [
|
|
6917
7505
|
{
|
|
6918
7506
|
name: "sessionId",
|
|
6919
|
-
sdkName: "sessionId"
|
|
7507
|
+
sdkName: "sessionId",
|
|
7508
|
+
description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
|
|
6920
7509
|
}
|
|
6921
7510
|
],
|
|
6922
7511
|
query: [
|
|
@@ -6952,7 +7541,8 @@ file at the root of that directory.`
|
|
|
6952
7541
|
pathParams: [
|
|
6953
7542
|
{
|
|
6954
7543
|
name: "sessionId",
|
|
6955
|
-
sdkName: "sessionId"
|
|
7544
|
+
sdkName: "sessionId",
|
|
7545
|
+
description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
|
|
6956
7546
|
}
|
|
6957
7547
|
],
|
|
6958
7548
|
query: [],
|
|
@@ -6986,7 +7576,8 @@ file at the root of that directory.`
|
|
|
6986
7576
|
pathParams: [
|
|
6987
7577
|
{
|
|
6988
7578
|
name: "sessionId",
|
|
6989
|
-
sdkName: "sessionId"
|
|
7579
|
+
sdkName: "sessionId",
|
|
7580
|
+
description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
|
|
6990
7581
|
}
|
|
6991
7582
|
],
|
|
6992
7583
|
query: []
|
|
@@ -7003,7 +7594,8 @@ file at the root of that directory.`
|
|
|
7003
7594
|
pathParams: [
|
|
7004
7595
|
{
|
|
7005
7596
|
name: "sessionId",
|
|
7006
|
-
sdkName: "sessionId"
|
|
7597
|
+
sdkName: "sessionId",
|
|
7598
|
+
description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
|
|
7007
7599
|
}
|
|
7008
7600
|
],
|
|
7009
7601
|
query: []
|
|
@@ -7020,7 +7612,8 @@ file at the root of that directory.`
|
|
|
7020
7612
|
pathParams: [
|
|
7021
7613
|
{
|
|
7022
7614
|
name: "sessionId",
|
|
7023
|
-
sdkName: "sessionId"
|
|
7615
|
+
sdkName: "sessionId",
|
|
7616
|
+
description: "浏览器会话 ID;使用创建或列出会话返回的 id,以 bss_ 开头。"
|
|
7024
7617
|
}
|
|
7025
7618
|
],
|
|
7026
7619
|
query: [],
|
|
@@ -7118,7 +7711,8 @@ file at the root of that directory.`
|
|
|
7118
7711
|
pathParams: [
|
|
7119
7712
|
{
|
|
7120
7713
|
name: "database_id",
|
|
7121
|
-
sdkName: "database_id"
|
|
7714
|
+
sdkName: "database_id",
|
|
7715
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7122
7716
|
}
|
|
7123
7717
|
],
|
|
7124
7718
|
query: []
|
|
@@ -7135,7 +7729,8 @@ file at the root of that directory.`
|
|
|
7135
7729
|
pathParams: [
|
|
7136
7730
|
{
|
|
7137
7731
|
name: "database_id",
|
|
7138
|
-
sdkName: "database_id"
|
|
7732
|
+
sdkName: "database_id",
|
|
7733
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7139
7734
|
}
|
|
7140
7735
|
],
|
|
7141
7736
|
query: []
|
|
@@ -7152,7 +7747,8 @@ file at the root of that directory.`
|
|
|
7152
7747
|
pathParams: [
|
|
7153
7748
|
{
|
|
7154
7749
|
name: "database_id",
|
|
7155
|
-
sdkName: "database_id"
|
|
7750
|
+
sdkName: "database_id",
|
|
7751
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7156
7752
|
}
|
|
7157
7753
|
],
|
|
7158
7754
|
query: [],
|
|
@@ -7186,7 +7782,8 @@ file at the root of that directory.`
|
|
|
7186
7782
|
pathParams: [
|
|
7187
7783
|
{
|
|
7188
7784
|
name: "database_id",
|
|
7189
|
-
sdkName: "database_id"
|
|
7785
|
+
sdkName: "database_id",
|
|
7786
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7190
7787
|
}
|
|
7191
7788
|
],
|
|
7192
7789
|
query: [
|
|
@@ -7232,7 +7829,8 @@ file at the root of that directory.`
|
|
|
7232
7829
|
pathParams: [
|
|
7233
7830
|
{
|
|
7234
7831
|
name: "database_id",
|
|
7235
|
-
sdkName: "database_id"
|
|
7832
|
+
sdkName: "database_id",
|
|
7833
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7236
7834
|
}
|
|
7237
7835
|
],
|
|
7238
7836
|
query: []
|
|
@@ -7249,11 +7847,13 @@ file at the root of that directory.`
|
|
|
7249
7847
|
pathParams: [
|
|
7250
7848
|
{
|
|
7251
7849
|
name: "database_id",
|
|
7252
|
-
sdkName: "database_id"
|
|
7850
|
+
sdkName: "database_id",
|
|
7851
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7253
7852
|
},
|
|
7254
7853
|
{
|
|
7255
7854
|
name: "table",
|
|
7256
|
-
sdkName: "table"
|
|
7855
|
+
sdkName: "table",
|
|
7856
|
+
description: "table ID or name."
|
|
7257
7857
|
}
|
|
7258
7858
|
],
|
|
7259
7859
|
query: [
|
|
@@ -7337,11 +7937,13 @@ file at the root of that directory.`
|
|
|
7337
7937
|
pathParams: [
|
|
7338
7938
|
{
|
|
7339
7939
|
name: "database_id",
|
|
7340
|
-
sdkName: "database_id"
|
|
7940
|
+
sdkName: "database_id",
|
|
7941
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7341
7942
|
},
|
|
7342
7943
|
{
|
|
7343
7944
|
name: "table",
|
|
7344
|
-
sdkName: "table"
|
|
7945
|
+
sdkName: "table",
|
|
7946
|
+
description: "table ID or name."
|
|
7345
7947
|
}
|
|
7346
7948
|
],
|
|
7347
7949
|
query: [
|
|
@@ -7425,11 +8027,13 @@ file at the root of that directory.`
|
|
|
7425
8027
|
pathParams: [
|
|
7426
8028
|
{
|
|
7427
8029
|
name: "database_id",
|
|
7428
|
-
sdkName: "database_id"
|
|
8030
|
+
sdkName: "database_id",
|
|
8031
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7429
8032
|
},
|
|
7430
8033
|
{
|
|
7431
8034
|
name: "table",
|
|
7432
|
-
sdkName: "table"
|
|
8035
|
+
sdkName: "table",
|
|
8036
|
+
description: "table ID or name."
|
|
7433
8037
|
}
|
|
7434
8038
|
],
|
|
7435
8039
|
query: [
|
|
@@ -7513,11 +8117,13 @@ file at the root of that directory.`
|
|
|
7513
8117
|
pathParams: [
|
|
7514
8118
|
{
|
|
7515
8119
|
name: "database_id",
|
|
7516
|
-
sdkName: "database_id"
|
|
8120
|
+
sdkName: "database_id",
|
|
8121
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7517
8122
|
},
|
|
7518
8123
|
{
|
|
7519
8124
|
name: "table",
|
|
7520
|
-
sdkName: "table"
|
|
8125
|
+
sdkName: "table",
|
|
8126
|
+
description: "table ID or name."
|
|
7521
8127
|
}
|
|
7522
8128
|
],
|
|
7523
8129
|
query: [
|
|
@@ -7607,11 +8213,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7607
8213
|
pathParams: [
|
|
7608
8214
|
{
|
|
7609
8215
|
name: "database_id",
|
|
7610
|
-
sdkName: "database_id"
|
|
8216
|
+
sdkName: "database_id",
|
|
8217
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7611
8218
|
},
|
|
7612
8219
|
{
|
|
7613
8220
|
name: "table",
|
|
7614
|
-
sdkName: "table"
|
|
8221
|
+
sdkName: "table",
|
|
8222
|
+
description: "table ID or name."
|
|
7615
8223
|
}
|
|
7616
8224
|
],
|
|
7617
8225
|
query: [
|
|
@@ -7699,7 +8307,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7699
8307
|
pathParams: [
|
|
7700
8308
|
{
|
|
7701
8309
|
name: "database_id",
|
|
7702
|
-
sdkName: "database_id"
|
|
8310
|
+
sdkName: "database_id",
|
|
8311
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7703
8312
|
}
|
|
7704
8313
|
],
|
|
7705
8314
|
query: []
|
|
@@ -7716,7 +8325,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7716
8325
|
pathParams: [
|
|
7717
8326
|
{
|
|
7718
8327
|
name: "database_id",
|
|
7719
|
-
sdkName: "database_id"
|
|
8328
|
+
sdkName: "database_id",
|
|
8329
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7720
8330
|
}
|
|
7721
8331
|
],
|
|
7722
8332
|
query: []
|
|
@@ -7733,7 +8343,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7733
8343
|
pathParams: [
|
|
7734
8344
|
{
|
|
7735
8345
|
name: "database_id",
|
|
7736
|
-
sdkName: "database_id"
|
|
8346
|
+
sdkName: "database_id",
|
|
8347
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7737
8348
|
}
|
|
7738
8349
|
],
|
|
7739
8350
|
query: [],
|
|
@@ -7774,11 +8385,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7774
8385
|
pathParams: [
|
|
7775
8386
|
{
|
|
7776
8387
|
name: "database_id",
|
|
7777
|
-
sdkName: "database_id"
|
|
8388
|
+
sdkName: "database_id",
|
|
8389
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7778
8390
|
},
|
|
7779
8391
|
{
|
|
7780
8392
|
name: "table",
|
|
7781
|
-
sdkName: "table"
|
|
8393
|
+
sdkName: "table",
|
|
8394
|
+
description: "table ID or name."
|
|
7782
8395
|
}
|
|
7783
8396
|
],
|
|
7784
8397
|
query: []
|
|
@@ -7795,11 +8408,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7795
8408
|
pathParams: [
|
|
7796
8409
|
{
|
|
7797
8410
|
name: "database_id",
|
|
7798
|
-
sdkName: "database_id"
|
|
8411
|
+
sdkName: "database_id",
|
|
8412
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7799
8413
|
},
|
|
7800
8414
|
{
|
|
7801
8415
|
name: "table",
|
|
7802
|
-
sdkName: "table"
|
|
8416
|
+
sdkName: "table",
|
|
8417
|
+
description: "table ID or name."
|
|
7803
8418
|
}
|
|
7804
8419
|
],
|
|
7805
8420
|
query: []
|
|
@@ -7816,11 +8431,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7816
8431
|
pathParams: [
|
|
7817
8432
|
{
|
|
7818
8433
|
name: "database_id",
|
|
7819
|
-
sdkName: "database_id"
|
|
8434
|
+
sdkName: "database_id",
|
|
8435
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7820
8436
|
},
|
|
7821
8437
|
{
|
|
7822
8438
|
name: "table",
|
|
7823
|
-
sdkName: "table"
|
|
8439
|
+
sdkName: "table",
|
|
8440
|
+
description: "table ID or name."
|
|
7824
8441
|
}
|
|
7825
8442
|
],
|
|
7826
8443
|
query: [],
|
|
@@ -7854,11 +8471,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7854
8471
|
pathParams: [
|
|
7855
8472
|
{
|
|
7856
8473
|
name: "database_id",
|
|
7857
|
-
sdkName: "database_id"
|
|
8474
|
+
sdkName: "database_id",
|
|
8475
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7858
8476
|
},
|
|
7859
8477
|
{
|
|
7860
8478
|
name: "table",
|
|
7861
|
-
sdkName: "table"
|
|
8479
|
+
sdkName: "table",
|
|
8480
|
+
description: "table ID or name."
|
|
7862
8481
|
}
|
|
7863
8482
|
],
|
|
7864
8483
|
query: [],
|
|
@@ -7879,15 +8498,18 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7879
8498
|
pathParams: [
|
|
7880
8499
|
{
|
|
7881
8500
|
name: "database_id",
|
|
7882
|
-
sdkName: "database_id"
|
|
8501
|
+
sdkName: "database_id",
|
|
8502
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7883
8503
|
},
|
|
7884
8504
|
{
|
|
7885
8505
|
name: "table",
|
|
7886
|
-
sdkName: "table"
|
|
8506
|
+
sdkName: "table",
|
|
8507
|
+
description: "table ID or name."
|
|
7887
8508
|
},
|
|
7888
8509
|
{
|
|
7889
8510
|
name: "field",
|
|
7890
|
-
sdkName: "field"
|
|
8511
|
+
sdkName: "field",
|
|
8512
|
+
description: "field ID or name."
|
|
7891
8513
|
}
|
|
7892
8514
|
],
|
|
7893
8515
|
query: []
|
|
@@ -7904,15 +8526,18 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
7904
8526
|
pathParams: [
|
|
7905
8527
|
{
|
|
7906
8528
|
name: "database_id",
|
|
7907
|
-
sdkName: "database_id"
|
|
8529
|
+
sdkName: "database_id",
|
|
8530
|
+
description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
|
|
7908
8531
|
},
|
|
7909
8532
|
{
|
|
7910
8533
|
name: "table",
|
|
7911
|
-
sdkName: "table"
|
|
8534
|
+
sdkName: "table",
|
|
8535
|
+
description: "table ID or name."
|
|
7912
8536
|
},
|
|
7913
8537
|
{
|
|
7914
8538
|
name: "field",
|
|
7915
|
-
sdkName: "field"
|
|
8539
|
+
sdkName: "field",
|
|
8540
|
+
description: "field ID or name."
|
|
7916
8541
|
}
|
|
7917
8542
|
],
|
|
7918
8543
|
query: [],
|
|
@@ -8071,7 +8696,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8071
8696
|
pathParams: [
|
|
8072
8697
|
{
|
|
8073
8698
|
name: "file_id",
|
|
8074
|
-
sdkName: "file_id"
|
|
8699
|
+
sdkName: "file_id",
|
|
8700
|
+
description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-."
|
|
8075
8701
|
}
|
|
8076
8702
|
],
|
|
8077
8703
|
query: []
|
|
@@ -8088,7 +8714,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8088
8714
|
pathParams: [
|
|
8089
8715
|
{
|
|
8090
8716
|
name: "file_id",
|
|
8091
|
-
sdkName: "file_id"
|
|
8717
|
+
sdkName: "file_id",
|
|
8718
|
+
description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-."
|
|
8092
8719
|
}
|
|
8093
8720
|
],
|
|
8094
8721
|
query: []
|
|
@@ -8105,7 +8732,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8105
8732
|
pathParams: [
|
|
8106
8733
|
{
|
|
8107
8734
|
name: "file_id",
|
|
8108
|
-
sdkName: "file_id"
|
|
8735
|
+
sdkName: "file_id",
|
|
8736
|
+
description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-."
|
|
8109
8737
|
}
|
|
8110
8738
|
],
|
|
8111
8739
|
query: []
|
|
@@ -8180,7 +8808,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8180
8808
|
pathParams: [
|
|
8181
8809
|
{
|
|
8182
8810
|
name: "upload_id",
|
|
8183
|
-
sdkName: "upload_id"
|
|
8811
|
+
sdkName: "upload_id",
|
|
8812
|
+
description: "Upload identifier returned by create; belongs to your organization."
|
|
8184
8813
|
}
|
|
8185
8814
|
],
|
|
8186
8815
|
query: []
|
|
@@ -8197,7 +8826,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8197
8826
|
pathParams: [
|
|
8198
8827
|
{
|
|
8199
8828
|
name: "upload_id",
|
|
8200
|
-
sdkName: "upload_id"
|
|
8829
|
+
sdkName: "upload_id",
|
|
8830
|
+
description: "Upload identifier returned by create; belongs to your organization."
|
|
8201
8831
|
}
|
|
8202
8832
|
],
|
|
8203
8833
|
query: [],
|
|
@@ -8233,7 +8863,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8233
8863
|
pathParams: [
|
|
8234
8864
|
{
|
|
8235
8865
|
name: "upload_id",
|
|
8236
|
-
sdkName: "upload_id"
|
|
8866
|
+
sdkName: "upload_id",
|
|
8867
|
+
description: "Upload identifier returned by create; belongs to your organization."
|
|
8237
8868
|
}
|
|
8238
8869
|
],
|
|
8239
8870
|
query: [
|
|
@@ -8379,7 +9010,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8379
9010
|
pathParams: [
|
|
8380
9011
|
{
|
|
8381
9012
|
name: "vector_store_id",
|
|
8382
|
-
sdkName: "vector_store_id"
|
|
9013
|
+
sdkName: "vector_store_id",
|
|
9014
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8383
9015
|
}
|
|
8384
9016
|
],
|
|
8385
9017
|
query: []
|
|
@@ -8396,7 +9028,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8396
9028
|
pathParams: [
|
|
8397
9029
|
{
|
|
8398
9030
|
name: "vector_store_id",
|
|
8399
|
-
sdkName: "vector_store_id"
|
|
9031
|
+
sdkName: "vector_store_id",
|
|
9032
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8400
9033
|
}
|
|
8401
9034
|
],
|
|
8402
9035
|
query: [
|
|
@@ -8434,7 +9067,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8434
9067
|
pathParams: [
|
|
8435
9068
|
{
|
|
8436
9069
|
name: "vector_store_id",
|
|
8437
|
-
sdkName: "vector_store_id"
|
|
9070
|
+
sdkName: "vector_store_id",
|
|
9071
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8438
9072
|
}
|
|
8439
9073
|
],
|
|
8440
9074
|
query: [],
|
|
@@ -8480,7 +9114,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8480
9114
|
pathParams: [
|
|
8481
9115
|
{
|
|
8482
9116
|
name: "vector_store_id",
|
|
8483
|
-
sdkName: "vector_store_id"
|
|
9117
|
+
sdkName: "vector_store_id",
|
|
9118
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8484
9119
|
}
|
|
8485
9120
|
],
|
|
8486
9121
|
query: [
|
|
@@ -8510,7 +9145,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8510
9145
|
pathParams: [
|
|
8511
9146
|
{
|
|
8512
9147
|
name: "vector_store_id",
|
|
8513
|
-
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."
|
|
8514
9150
|
}
|
|
8515
9151
|
],
|
|
8516
9152
|
query: [],
|
|
@@ -8531,11 +9167,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8531
9167
|
pathParams: [
|
|
8532
9168
|
{
|
|
8533
9169
|
name: "vector_store_id",
|
|
8534
|
-
sdkName: "vector_store_id"
|
|
9170
|
+
sdkName: "vector_store_id",
|
|
9171
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8535
9172
|
},
|
|
8536
9173
|
{
|
|
8537
9174
|
name: "batch_id",
|
|
8538
|
-
sdkName: "batch_id"
|
|
9175
|
+
sdkName: "batch_id",
|
|
9176
|
+
description: "File-batch ID returned by batch creation in this knowledge base."
|
|
8539
9177
|
}
|
|
8540
9178
|
],
|
|
8541
9179
|
query: []
|
|
@@ -8552,11 +9190,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8552
9190
|
pathParams: [
|
|
8553
9191
|
{
|
|
8554
9192
|
name: "vector_store_id",
|
|
8555
|
-
sdkName: "vector_store_id"
|
|
9193
|
+
sdkName: "vector_store_id",
|
|
9194
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8556
9195
|
},
|
|
8557
9196
|
{
|
|
8558
9197
|
name: "batch_id",
|
|
8559
|
-
sdkName: "batch_id"
|
|
9198
|
+
sdkName: "batch_id",
|
|
9199
|
+
description: "File-batch ID returned by batch creation in this knowledge base."
|
|
8560
9200
|
}
|
|
8561
9201
|
],
|
|
8562
9202
|
query: []
|
|
@@ -8573,11 +9213,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8573
9213
|
pathParams: [
|
|
8574
9214
|
{
|
|
8575
9215
|
name: "vector_store_id",
|
|
8576
|
-
sdkName: "vector_store_id"
|
|
9216
|
+
sdkName: "vector_store_id",
|
|
9217
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8577
9218
|
},
|
|
8578
9219
|
{
|
|
8579
9220
|
name: "batch_id",
|
|
8580
|
-
sdkName: "batch_id"
|
|
9221
|
+
sdkName: "batch_id",
|
|
9222
|
+
description: "File-batch ID returned by batch creation in this knowledge base."
|
|
8581
9223
|
}
|
|
8582
9224
|
],
|
|
8583
9225
|
query: [
|
|
@@ -8635,7 +9277,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8635
9277
|
pathParams: [
|
|
8636
9278
|
{
|
|
8637
9279
|
name: "vector_store_id",
|
|
8638
|
-
sdkName: "vector_store_id"
|
|
9280
|
+
sdkName: "vector_store_id",
|
|
9281
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8639
9282
|
}
|
|
8640
9283
|
],
|
|
8641
9284
|
query: [
|
|
@@ -8693,7 +9336,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8693
9336
|
pathParams: [
|
|
8694
9337
|
{
|
|
8695
9338
|
name: "vector_store_id",
|
|
8696
|
-
sdkName: "vector_store_id"
|
|
9339
|
+
sdkName: "vector_store_id",
|
|
9340
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8697
9341
|
}
|
|
8698
9342
|
],
|
|
8699
9343
|
query: [],
|
|
@@ -8733,11 +9377,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8733
9377
|
pathParams: [
|
|
8734
9378
|
{
|
|
8735
9379
|
name: "vector_store_id",
|
|
8736
|
-
sdkName: "vector_store_id"
|
|
9380
|
+
sdkName: "vector_store_id",
|
|
9381
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8737
9382
|
},
|
|
8738
9383
|
{
|
|
8739
9384
|
name: "file_id",
|
|
8740
|
-
sdkName: "file_id"
|
|
9385
|
+
sdkName: "file_id",
|
|
9386
|
+
description: "Source File ID of an attachment, returned by file attachment or listing."
|
|
8741
9387
|
}
|
|
8742
9388
|
],
|
|
8743
9389
|
query: []
|
|
@@ -8754,11 +9400,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8754
9400
|
pathParams: [
|
|
8755
9401
|
{
|
|
8756
9402
|
name: "vector_store_id",
|
|
8757
|
-
sdkName: "vector_store_id"
|
|
9403
|
+
sdkName: "vector_store_id",
|
|
9404
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8758
9405
|
},
|
|
8759
9406
|
{
|
|
8760
9407
|
name: "file_id",
|
|
8761
|
-
sdkName: "file_id"
|
|
9408
|
+
sdkName: "file_id",
|
|
9409
|
+
description: "Source File ID of an attachment, returned by file attachment or listing."
|
|
8762
9410
|
}
|
|
8763
9411
|
],
|
|
8764
9412
|
query: []
|
|
@@ -8775,11 +9423,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8775
9423
|
pathParams: [
|
|
8776
9424
|
{
|
|
8777
9425
|
name: "vector_store_id",
|
|
8778
|
-
sdkName: "vector_store_id"
|
|
9426
|
+
sdkName: "vector_store_id",
|
|
9427
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8779
9428
|
},
|
|
8780
9429
|
{
|
|
8781
9430
|
name: "file_id",
|
|
8782
|
-
sdkName: "file_id"
|
|
9431
|
+
sdkName: "file_id",
|
|
9432
|
+
description: "Source File ID of an attachment, returned by file attachment or listing."
|
|
8783
9433
|
}
|
|
8784
9434
|
],
|
|
8785
9435
|
query: [],
|
|
@@ -8807,11 +9457,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8807
9457
|
pathParams: [
|
|
8808
9458
|
{
|
|
8809
9459
|
name: "vector_store_id",
|
|
8810
|
-
sdkName: "vector_store_id"
|
|
9460
|
+
sdkName: "vector_store_id",
|
|
9461
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8811
9462
|
},
|
|
8812
9463
|
{
|
|
8813
9464
|
name: "file_id",
|
|
8814
|
-
sdkName: "file_id"
|
|
9465
|
+
sdkName: "file_id",
|
|
9466
|
+
description: "Source File ID of an attachment, returned by file attachment or listing."
|
|
8815
9467
|
}
|
|
8816
9468
|
],
|
|
8817
9469
|
query: []
|
|
@@ -8828,11 +9480,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8828
9480
|
pathParams: [
|
|
8829
9481
|
{
|
|
8830
9482
|
name: "vector_store_id",
|
|
8831
|
-
sdkName: "vector_store_id"
|
|
9483
|
+
sdkName: "vector_store_id",
|
|
9484
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8832
9485
|
},
|
|
8833
9486
|
{
|
|
8834
9487
|
name: "file_id",
|
|
8835
|
-
sdkName: "file_id"
|
|
9488
|
+
sdkName: "file_id",
|
|
9489
|
+
description: "Source File ID of an attachment, returned by file attachment or listing."
|
|
8836
9490
|
}
|
|
8837
9491
|
],
|
|
8838
9492
|
query: []
|
|
@@ -8849,11 +9503,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8849
9503
|
pathParams: [
|
|
8850
9504
|
{
|
|
8851
9505
|
name: "vector_store_id",
|
|
8852
|
-
sdkName: "vector_store_id"
|
|
9506
|
+
sdkName: "vector_store_id",
|
|
9507
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8853
9508
|
},
|
|
8854
9509
|
{
|
|
8855
9510
|
name: "file_id",
|
|
8856
|
-
sdkName: "file_id"
|
|
9511
|
+
sdkName: "file_id",
|
|
9512
|
+
description: "Source File ID of an attachment, returned by file attachment or listing."
|
|
8857
9513
|
}
|
|
8858
9514
|
],
|
|
8859
9515
|
query: [
|
|
@@ -8899,7 +9555,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8899
9555
|
pathParams: [
|
|
8900
9556
|
{
|
|
8901
9557
|
name: "vector_store_id",
|
|
8902
|
-
sdkName: "vector_store_id"
|
|
9558
|
+
sdkName: "vector_store_id",
|
|
9559
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8903
9560
|
}
|
|
8904
9561
|
],
|
|
8905
9562
|
query: []
|
|
@@ -8916,7 +9573,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8916
9573
|
pathParams: [
|
|
8917
9574
|
{
|
|
8918
9575
|
name: "vector_store_id",
|
|
8919
|
-
sdkName: "vector_store_id"
|
|
9576
|
+
sdkName: "vector_store_id",
|
|
9577
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8920
9578
|
}
|
|
8921
9579
|
],
|
|
8922
9580
|
query: []
|
|
@@ -8933,7 +9591,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8933
9591
|
pathParams: [
|
|
8934
9592
|
{
|
|
8935
9593
|
name: "vector_store_id",
|
|
8936
|
-
sdkName: "vector_store_id"
|
|
9594
|
+
sdkName: "vector_store_id",
|
|
9595
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
8937
9596
|
}
|
|
8938
9597
|
],
|
|
8939
9598
|
query: [],
|
|
@@ -8997,11 +9656,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
8997
9656
|
pathParams: [
|
|
8998
9657
|
{
|
|
8999
9658
|
name: "vector_store_id",
|
|
9000
|
-
sdkName: "vector_store_id"
|
|
9659
|
+
sdkName: "vector_store_id",
|
|
9660
|
+
description: "Knowledge-base ID returned by create or list; use the ID rather than its display name."
|
|
9001
9661
|
},
|
|
9002
9662
|
{
|
|
9003
9663
|
name: "chunk_id",
|
|
9004
|
-
sdkName: "chunk_id"
|
|
9664
|
+
sdkName: "chunk_id",
|
|
9665
|
+
description: "Chunk ID returned by segment listing or native search content."
|
|
9005
9666
|
}
|
|
9006
9667
|
],
|
|
9007
9668
|
query: []
|
|
@@ -9100,7 +9761,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9100
9761
|
pathParams: [
|
|
9101
9762
|
{
|
|
9102
9763
|
name: "library_id",
|
|
9103
|
-
sdkName: "library_id"
|
|
9764
|
+
sdkName: "library_id",
|
|
9765
|
+
description: "Library ID returned by creation."
|
|
9104
9766
|
}
|
|
9105
9767
|
],
|
|
9106
9768
|
query: []
|
|
@@ -9117,7 +9779,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9117
9779
|
pathParams: [
|
|
9118
9780
|
{
|
|
9119
9781
|
name: "library_id",
|
|
9120
|
-
sdkName: "library_id"
|
|
9782
|
+
sdkName: "library_id",
|
|
9783
|
+
description: "Library ID returned by creation."
|
|
9121
9784
|
}
|
|
9122
9785
|
],
|
|
9123
9786
|
query: []
|
|
@@ -9134,7 +9797,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9134
9797
|
pathParams: [
|
|
9135
9798
|
{
|
|
9136
9799
|
name: "library_id",
|
|
9137
|
-
sdkName: "library_id"
|
|
9800
|
+
sdkName: "library_id",
|
|
9801
|
+
description: "Library ID returned by creation."
|
|
9138
9802
|
}
|
|
9139
9803
|
],
|
|
9140
9804
|
query: [],
|
|
@@ -9180,7 +9844,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9180
9844
|
pathParams: [
|
|
9181
9845
|
{
|
|
9182
9846
|
name: "library_id",
|
|
9183
|
-
sdkName: "library_id"
|
|
9847
|
+
sdkName: "library_id",
|
|
9848
|
+
description: "Library ID returned by creation."
|
|
9184
9849
|
}
|
|
9185
9850
|
],
|
|
9186
9851
|
query: [
|
|
@@ -9228,7 +9893,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9228
9893
|
pathParams: [
|
|
9229
9894
|
{
|
|
9230
9895
|
name: "library_id",
|
|
9231
|
-
sdkName: "library_id"
|
|
9896
|
+
sdkName: "library_id",
|
|
9897
|
+
description: "Library ID returned by creation."
|
|
9232
9898
|
}
|
|
9233
9899
|
],
|
|
9234
9900
|
query: [],
|
|
@@ -9340,7 +10006,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9340
10006
|
pathParams: [
|
|
9341
10007
|
{
|
|
9342
10008
|
name: "library_id",
|
|
9343
|
-
sdkName: "library_id"
|
|
10009
|
+
sdkName: "library_id",
|
|
10010
|
+
description: "Library ID returned by creation."
|
|
9344
10011
|
}
|
|
9345
10012
|
],
|
|
9346
10013
|
query: [],
|
|
@@ -9451,11 +10118,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9451
10118
|
pathParams: [
|
|
9452
10119
|
{
|
|
9453
10120
|
name: "library_id",
|
|
9454
|
-
sdkName: "library_id"
|
|
10121
|
+
sdkName: "library_id",
|
|
10122
|
+
description: "Library ID returned by creation."
|
|
9455
10123
|
},
|
|
9456
10124
|
{
|
|
9457
10125
|
name: "asset_id",
|
|
9458
|
-
sdkName: "asset_id"
|
|
10126
|
+
sdkName: "asset_id",
|
|
10127
|
+
description: "32-character asset ID."
|
|
9459
10128
|
}
|
|
9460
10129
|
],
|
|
9461
10130
|
query: []
|
|
@@ -9472,11 +10141,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9472
10141
|
pathParams: [
|
|
9473
10142
|
{
|
|
9474
10143
|
name: "library_id",
|
|
9475
|
-
sdkName: "library_id"
|
|
10144
|
+
sdkName: "library_id",
|
|
10145
|
+
description: "Library ID returned by creation."
|
|
9476
10146
|
},
|
|
9477
10147
|
{
|
|
9478
10148
|
name: "asset_id",
|
|
9479
|
-
sdkName: "asset_id"
|
|
10149
|
+
sdkName: "asset_id",
|
|
10150
|
+
description: "32-character asset ID."
|
|
9480
10151
|
}
|
|
9481
10152
|
],
|
|
9482
10153
|
query: []
|
|
@@ -9493,11 +10164,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9493
10164
|
pathParams: [
|
|
9494
10165
|
{
|
|
9495
10166
|
name: "library_id",
|
|
9496
|
-
sdkName: "library_id"
|
|
10167
|
+
sdkName: "library_id",
|
|
10168
|
+
description: "Library ID returned by creation."
|
|
9497
10169
|
},
|
|
9498
10170
|
{
|
|
9499
10171
|
name: "asset_id",
|
|
9500
|
-
sdkName: "asset_id"
|
|
10172
|
+
sdkName: "asset_id",
|
|
10173
|
+
description: "32-character asset ID."
|
|
9501
10174
|
}
|
|
9502
10175
|
],
|
|
9503
10176
|
query: [],
|
|
@@ -9544,11 +10217,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9544
10217
|
pathParams: [
|
|
9545
10218
|
{
|
|
9546
10219
|
name: "library_id",
|
|
9547
|
-
sdkName: "library_id"
|
|
10220
|
+
sdkName: "library_id",
|
|
10221
|
+
description: "Library ID returned by creation."
|
|
9548
10222
|
},
|
|
9549
10223
|
{
|
|
9550
10224
|
name: "asset_id",
|
|
9551
|
-
sdkName: "asset_id"
|
|
10225
|
+
sdkName: "asset_id",
|
|
10226
|
+
description: "32-character asset ID."
|
|
9552
10227
|
}
|
|
9553
10228
|
],
|
|
9554
10229
|
query: [],
|
|
@@ -9583,11 +10258,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9583
10258
|
pathParams: [
|
|
9584
10259
|
{
|
|
9585
10260
|
name: "library_id",
|
|
9586
|
-
sdkName: "library_id"
|
|
10261
|
+
sdkName: "library_id",
|
|
10262
|
+
description: "Library ID returned by creation."
|
|
9587
10263
|
},
|
|
9588
10264
|
{
|
|
9589
10265
|
name: "asset_id",
|
|
9590
|
-
sdkName: "asset_id"
|
|
10266
|
+
sdkName: "asset_id",
|
|
10267
|
+
description: "32-character asset ID."
|
|
9591
10268
|
}
|
|
9592
10269
|
],
|
|
9593
10270
|
query: [
|
|
@@ -9636,7 +10313,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9636
10313
|
pathParams: [
|
|
9637
10314
|
{
|
|
9638
10315
|
name: "library_id",
|
|
9639
|
-
sdkName: "library_id"
|
|
10316
|
+
sdkName: "library_id",
|
|
10317
|
+
description: "Library ID returned by creation."
|
|
9640
10318
|
}
|
|
9641
10319
|
],
|
|
9642
10320
|
query: [],
|
|
@@ -9664,7 +10342,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9664
10342
|
pathParams: [
|
|
9665
10343
|
{
|
|
9666
10344
|
name: "library_id",
|
|
9667
|
-
sdkName: "library_id"
|
|
10345
|
+
sdkName: "library_id",
|
|
10346
|
+
description: "Library ID returned by creation."
|
|
9668
10347
|
}
|
|
9669
10348
|
],
|
|
9670
10349
|
query: [],
|
|
@@ -9692,11 +10371,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9692
10371
|
pathParams: [
|
|
9693
10372
|
{
|
|
9694
10373
|
name: "library_id",
|
|
9695
|
-
sdkName: "library_id"
|
|
10374
|
+
sdkName: "library_id",
|
|
10375
|
+
description: "Library ID returned by creation."
|
|
9696
10376
|
},
|
|
9697
10377
|
{
|
|
9698
10378
|
name: "job_id",
|
|
9699
|
-
sdkName: "job_id"
|
|
10379
|
+
sdkName: "job_id",
|
|
10380
|
+
description: "Batch identifier returned by createBatch or batchAssets; resolved within this library."
|
|
9700
10381
|
}
|
|
9701
10382
|
],
|
|
9702
10383
|
query: []
|
|
@@ -9713,7 +10394,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9713
10394
|
pathParams: [
|
|
9714
10395
|
{
|
|
9715
10396
|
name: "library_id",
|
|
9716
|
-
sdkName: "library_id"
|
|
10397
|
+
sdkName: "library_id",
|
|
10398
|
+
description: "Library ID returned by creation."
|
|
9717
10399
|
}
|
|
9718
10400
|
],
|
|
9719
10401
|
query: [
|
|
@@ -9759,7 +10441,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9759
10441
|
pathParams: [
|
|
9760
10442
|
{
|
|
9761
10443
|
name: "library_id",
|
|
9762
|
-
sdkName: "library_id"
|
|
10444
|
+
sdkName: "library_id",
|
|
10445
|
+
description: "Library ID returned by creation."
|
|
9763
10446
|
}
|
|
9764
10447
|
],
|
|
9765
10448
|
query: [
|
|
@@ -9783,11 +10466,13 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9783
10466
|
pathParams: [
|
|
9784
10467
|
{
|
|
9785
10468
|
name: "library_id",
|
|
9786
|
-
sdkName: "library_id"
|
|
10469
|
+
sdkName: "library_id",
|
|
10470
|
+
description: "Library ID returned by creation."
|
|
9787
10471
|
},
|
|
9788
10472
|
{
|
|
9789
10473
|
name: "job_id",
|
|
9790
|
-
sdkName: "job_id"
|
|
10474
|
+
sdkName: "job_id",
|
|
10475
|
+
description: "Batch identifier returned by createBatch or batchAssets; resolved within this library."
|
|
9791
10476
|
}
|
|
9792
10477
|
],
|
|
9793
10478
|
query: []
|
|
@@ -9804,7 +10489,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9804
10489
|
pathParams: [
|
|
9805
10490
|
{
|
|
9806
10491
|
name: "library_id",
|
|
9807
|
-
sdkName: "library_id"
|
|
10492
|
+
sdkName: "library_id",
|
|
10493
|
+
description: "Library ID returned by creation."
|
|
9808
10494
|
}
|
|
9809
10495
|
],
|
|
9810
10496
|
query: []
|
|
@@ -9821,7 +10507,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9821
10507
|
pathParams: [
|
|
9822
10508
|
{
|
|
9823
10509
|
name: "library_id",
|
|
9824
|
-
sdkName: "library_id"
|
|
10510
|
+
sdkName: "library_id",
|
|
10511
|
+
description: "Library ID returned by creation."
|
|
9825
10512
|
}
|
|
9826
10513
|
],
|
|
9827
10514
|
query: []
|
|
@@ -9838,7 +10525,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9838
10525
|
pathParams: [
|
|
9839
10526
|
{
|
|
9840
10527
|
name: "library_id",
|
|
9841
|
-
sdkName: "library_id"
|
|
10528
|
+
sdkName: "library_id",
|
|
10529
|
+
description: "Library ID returned by creation."
|
|
9842
10530
|
}
|
|
9843
10531
|
],
|
|
9844
10532
|
query: [],
|
|
@@ -9888,7 +10576,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9888
10576
|
pathParams: [
|
|
9889
10577
|
{
|
|
9890
10578
|
name: "library_id",
|
|
9891
|
-
sdkName: "library_id"
|
|
10579
|
+
sdkName: "library_id",
|
|
10580
|
+
description: "Library ID returned by creation."
|
|
9892
10581
|
}
|
|
9893
10582
|
],
|
|
9894
10583
|
query: [],
|
|
@@ -9959,7 +10648,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
9959
10648
|
pathParams: [
|
|
9960
10649
|
{
|
|
9961
10650
|
name: "library_id",
|
|
9962
|
-
sdkName: "library_id"
|
|
10651
|
+
sdkName: "library_id",
|
|
10652
|
+
description: "Library ID returned by creation."
|
|
9963
10653
|
}
|
|
9964
10654
|
],
|
|
9965
10655
|
query: [],
|
|
@@ -10009,7 +10699,8 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
10009
10699
|
pathParams: [
|
|
10010
10700
|
{
|
|
10011
10701
|
name: "library_id",
|
|
10012
|
-
sdkName: "library_id"
|
|
10702
|
+
sdkName: "library_id",
|
|
10703
|
+
description: "Library ID returned by creation."
|
|
10013
10704
|
}
|
|
10014
10705
|
],
|
|
10015
10706
|
query: [],
|
|
@@ -10102,7 +10793,8 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
10102
10793
|
pathParams: [
|
|
10103
10794
|
{
|
|
10104
10795
|
name: "name",
|
|
10105
|
-
sdkName: "name"
|
|
10796
|
+
sdkName: "name",
|
|
10797
|
+
description: "Exact method name from the search results, for example `praxis.database.databases.tables.create`."
|
|
10106
10798
|
}
|
|
10107
10799
|
],
|
|
10108
10800
|
query: []
|
|
@@ -10759,7 +11451,8 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
10759
11451
|
pathParams: [
|
|
10760
11452
|
{
|
|
10761
11453
|
name: "conversation_id",
|
|
10762
|
-
sdkName: "conversation_id"
|
|
11454
|
+
sdkName: "conversation_id",
|
|
11455
|
+
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
11456
|
}
|
|
10764
11457
|
],
|
|
10765
11458
|
query: []
|
|
@@ -10776,7 +11469,8 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
10776
11469
|
pathParams: [
|
|
10777
11470
|
{
|
|
10778
11471
|
name: "conversation_id",
|
|
10779
|
-
sdkName: "conversation_id"
|
|
11472
|
+
sdkName: "conversation_id",
|
|
11473
|
+
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
11474
|
}
|
|
10781
11475
|
],
|
|
10782
11476
|
query: []
|
|
@@ -10793,7 +11487,8 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
10793
11487
|
pathParams: [
|
|
10794
11488
|
{
|
|
10795
11489
|
name: "conversation_id",
|
|
10796
|
-
sdkName: "conversation_id"
|
|
11490
|
+
sdkName: "conversation_id",
|
|
11491
|
+
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
11492
|
}
|
|
10798
11493
|
],
|
|
10799
11494
|
query: [],
|
|
@@ -10821,7 +11516,8 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
10821
11516
|
pathParams: [
|
|
10822
11517
|
{
|
|
10823
11518
|
name: "conversation_id",
|
|
10824
|
-
sdkName: "conversation_id"
|
|
11519
|
+
sdkName: "conversation_id",
|
|
11520
|
+
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
11521
|
}
|
|
10826
11522
|
],
|
|
10827
11523
|
query: []
|
|
@@ -10838,7 +11534,8 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
10838
11534
|
pathParams: [
|
|
10839
11535
|
{
|
|
10840
11536
|
name: "conversation_id",
|
|
10841
|
-
sdkName: "conversation_id"
|
|
11537
|
+
sdkName: "conversation_id",
|
|
11538
|
+
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
11539
|
}
|
|
10843
11540
|
],
|
|
10844
11541
|
query: [],
|
|
@@ -10867,11 +11564,13 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
10867
11564
|
pathParams: [
|
|
10868
11565
|
{
|
|
10869
11566
|
name: "conversation_id",
|
|
10870
|
-
sdkName: "conversation_id"
|
|
11567
|
+
sdkName: "conversation_id",
|
|
11568
|
+
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
11569
|
},
|
|
10872
11570
|
{
|
|
10873
11571
|
name: "item_id",
|
|
10874
|
-
sdkName: "item_id"
|
|
11572
|
+
sdkName: "item_id",
|
|
11573
|
+
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
11574
|
}
|
|
10876
11575
|
],
|
|
10877
11576
|
query: []
|
|
@@ -10888,11 +11587,13 @@ services (model, agent, automation…); call the operation you need and read its
|
|
|
10888
11587
|
pathParams: [
|
|
10889
11588
|
{
|
|
10890
11589
|
name: "conversation_id",
|
|
10891
|
-
sdkName: "conversation_id"
|
|
11590
|
+
sdkName: "conversation_id",
|
|
11591
|
+
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
11592
|
},
|
|
10893
11593
|
{
|
|
10894
11594
|
name: "item_id",
|
|
10895
|
-
sdkName: "item_id"
|
|
11595
|
+
sdkName: "item_id",
|
|
11596
|
+
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
11597
|
}
|
|
10897
11598
|
],
|
|
10898
11599
|
query: []
|
|
@@ -11658,7 +12359,8 @@ for more details.`
|
|
|
11658
12359
|
pathParams: [
|
|
11659
12360
|
{
|
|
11660
12361
|
name: "model",
|
|
11661
|
-
sdkName: "model"
|
|
12362
|
+
sdkName: "model",
|
|
12363
|
+
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
12364
|
}
|
|
11663
12365
|
],
|
|
11664
12366
|
query: []
|
|
@@ -12117,7 +12819,8 @@ for more details.`
|
|
|
12117
12819
|
pathParams: [
|
|
12118
12820
|
{
|
|
12119
12821
|
name: "response_id",
|
|
12120
|
-
sdkName: "response_id"
|
|
12822
|
+
sdkName: "response_id",
|
|
12823
|
+
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
12824
|
}
|
|
12122
12825
|
],
|
|
12123
12826
|
query: []
|
|
@@ -12134,7 +12837,8 @@ for more details.`
|
|
|
12134
12837
|
pathParams: [
|
|
12135
12838
|
{
|
|
12136
12839
|
name: "response_id",
|
|
12137
|
-
sdkName: "response_id"
|
|
12840
|
+
sdkName: "response_id",
|
|
12841
|
+
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
12842
|
}
|
|
12139
12843
|
],
|
|
12140
12844
|
query: []
|
|
@@ -12151,7 +12855,8 @@ for more details.`
|
|
|
12151
12855
|
pathParams: [
|
|
12152
12856
|
{
|
|
12153
12857
|
name: "response_id",
|
|
12154
|
-
sdkName: "response_id"
|
|
12858
|
+
sdkName: "response_id",
|
|
12859
|
+
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
12860
|
}
|
|
12156
12861
|
],
|
|
12157
12862
|
query: []
|
|
@@ -12168,7 +12873,8 @@ for more details.`
|
|
|
12168
12873
|
pathParams: [
|
|
12169
12874
|
{
|
|
12170
12875
|
name: "response_id",
|
|
12171
|
-
sdkName: "response_id"
|
|
12876
|
+
sdkName: "response_id",
|
|
12877
|
+
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
12878
|
}
|
|
12173
12879
|
],
|
|
12174
12880
|
query: []
|
|
@@ -12324,7 +13030,8 @@ for more details.`
|
|
|
12324
13030
|
pathParams: [
|
|
12325
13031
|
{
|
|
12326
13032
|
name: "video_id",
|
|
12327
|
-
sdkName: "video_id"
|
|
13033
|
+
sdkName: "video_id",
|
|
13034
|
+
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
13035
|
}
|
|
12329
13036
|
],
|
|
12330
13037
|
query: []
|
|
@@ -12341,7 +13048,8 @@ for more details.`
|
|
|
12341
13048
|
pathParams: [
|
|
12342
13049
|
{
|
|
12343
13050
|
name: "video_id",
|
|
12344
|
-
sdkName: "video_id"
|
|
13051
|
+
sdkName: "video_id",
|
|
13052
|
+
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
13053
|
}
|
|
12346
13054
|
],
|
|
12347
13055
|
query: []
|
|
@@ -12358,7 +13066,8 @@ for more details.`
|
|
|
12358
13066
|
pathParams: [
|
|
12359
13067
|
{
|
|
12360
13068
|
name: "video_id",
|
|
12361
|
-
sdkName: "video_id"
|
|
13069
|
+
sdkName: "video_id",
|
|
13070
|
+
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
13071
|
}
|
|
12363
13072
|
],
|
|
12364
13073
|
query: [
|
|
@@ -12393,7 +13102,8 @@ for more details.`
|
|
|
12393
13102
|
pathParams: [
|
|
12394
13103
|
{
|
|
12395
13104
|
name: "video_id",
|
|
12396
|
-
sdkName: "video_id"
|
|
13105
|
+
sdkName: "video_id",
|
|
13106
|
+
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
13107
|
}
|
|
12398
13108
|
],
|
|
12399
13109
|
query: []
|
|
@@ -12538,7 +13248,8 @@ for more details.`
|
|
|
12538
13248
|
pathParams: [
|
|
12539
13249
|
{
|
|
12540
13250
|
name: "id",
|
|
12541
|
-
sdkName: "id"
|
|
13251
|
+
sdkName: "id",
|
|
13252
|
+
description: "The event id from the events list."
|
|
12542
13253
|
}
|
|
12543
13254
|
],
|
|
12544
13255
|
query: []
|
|
@@ -12692,7 +13403,8 @@ for more details.`
|
|
|
12692
13403
|
pathParams: [
|
|
12693
13404
|
{
|
|
12694
13405
|
name: "id",
|
|
12695
|
-
sdkName: "id"
|
|
13406
|
+
sdkName: "id",
|
|
13407
|
+
description: "Feedback identifier, prefixed with fb_."
|
|
12696
13408
|
}
|
|
12697
13409
|
],
|
|
12698
13410
|
query: []
|
|
@@ -12709,7 +13421,8 @@ for more details.`
|
|
|
12709
13421
|
pathParams: [
|
|
12710
13422
|
{
|
|
12711
13423
|
name: "id",
|
|
12712
|
-
sdkName: "id"
|
|
13424
|
+
sdkName: "id",
|
|
13425
|
+
description: "Feedback identifier, prefixed with fb_."
|
|
12713
13426
|
}
|
|
12714
13427
|
],
|
|
12715
13428
|
query: [
|
|
@@ -12739,7 +13452,8 @@ for more details.`
|
|
|
12739
13452
|
pathParams: [
|
|
12740
13453
|
{
|
|
12741
13454
|
name: "id",
|
|
12742
|
-
sdkName: "id"
|
|
13455
|
+
sdkName: "id",
|
|
13456
|
+
description: "Feedback identifier, prefixed with fb_."
|
|
12743
13457
|
}
|
|
12744
13458
|
],
|
|
12745
13459
|
query: [],
|
|
@@ -12997,7 +13711,8 @@ for more details.`
|
|
|
12997
13711
|
pathParams: [
|
|
12998
13712
|
{
|
|
12999
13713
|
name: "sandboxID",
|
|
13000
|
-
sdkName: "sandboxID"
|
|
13714
|
+
sdkName: "sandboxID",
|
|
13715
|
+
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
13716
|
}
|
|
13002
13717
|
],
|
|
13003
13718
|
query: []
|
|
@@ -13014,7 +13729,8 @@ for more details.`
|
|
|
13014
13729
|
pathParams: [
|
|
13015
13730
|
{
|
|
13016
13731
|
name: "sandboxID",
|
|
13017
|
-
sdkName: "sandboxID"
|
|
13732
|
+
sdkName: "sandboxID",
|
|
13733
|
+
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
13734
|
}
|
|
13019
13735
|
],
|
|
13020
13736
|
query: []
|
|
@@ -13031,7 +13747,8 @@ for more details.`
|
|
|
13031
13747
|
pathParams: [
|
|
13032
13748
|
{
|
|
13033
13749
|
name: "sandboxID",
|
|
13034
|
-
sdkName: "sandboxID"
|
|
13750
|
+
sdkName: "sandboxID",
|
|
13751
|
+
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
13752
|
}
|
|
13036
13753
|
],
|
|
13037
13754
|
query: [],
|
|
@@ -13059,7 +13776,8 @@ for more details.`
|
|
|
13059
13776
|
pathParams: [
|
|
13060
13777
|
{
|
|
13061
13778
|
name: "sandboxID",
|
|
13062
|
-
sdkName: "sandboxID"
|
|
13779
|
+
sdkName: "sandboxID",
|
|
13780
|
+
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
13781
|
}
|
|
13064
13782
|
],
|
|
13065
13783
|
query: [],
|
|
@@ -13093,7 +13811,8 @@ for more details.`
|
|
|
13093
13811
|
pathParams: [
|
|
13094
13812
|
{
|
|
13095
13813
|
name: "sandboxID",
|
|
13096
|
-
sdkName: "sandboxID"
|
|
13814
|
+
sdkName: "sandboxID",
|
|
13815
|
+
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
13816
|
}
|
|
13098
13817
|
],
|
|
13099
13818
|
query: [],
|
|
@@ -13126,7 +13845,8 @@ for more details.`
|
|
|
13126
13845
|
pathParams: [
|
|
13127
13846
|
{
|
|
13128
13847
|
name: "sandboxID",
|
|
13129
|
-
sdkName: "sandboxID"
|
|
13848
|
+
sdkName: "sandboxID",
|
|
13849
|
+
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
13850
|
}
|
|
13131
13851
|
],
|
|
13132
13852
|
query: [],
|
|
@@ -13160,7 +13880,8 @@ for more details.`
|
|
|
13160
13880
|
pathParams: [
|
|
13161
13881
|
{
|
|
13162
13882
|
name: "sandboxID",
|
|
13163
|
-
sdkName: "sandboxID"
|
|
13883
|
+
sdkName: "sandboxID",
|
|
13884
|
+
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
13885
|
}
|
|
13165
13886
|
],
|
|
13166
13887
|
query: [
|
|
@@ -13218,7 +13939,8 @@ for more details.`
|
|
|
13218
13939
|
pathParams: [
|
|
13219
13940
|
{
|
|
13220
13941
|
name: "sandboxID",
|
|
13221
|
-
sdkName: "sandboxID"
|
|
13942
|
+
sdkName: "sandboxID",
|
|
13943
|
+
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
13944
|
}
|
|
13223
13945
|
],
|
|
13224
13946
|
query: [
|
|
@@ -13248,7 +13970,8 @@ for more details.`
|
|
|
13248
13970
|
pathParams: [
|
|
13249
13971
|
{
|
|
13250
13972
|
name: "sandboxID",
|
|
13251
|
-
sdkName: "sandboxID"
|
|
13973
|
+
sdkName: "sandboxID",
|
|
13974
|
+
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
13975
|
}
|
|
13253
13976
|
],
|
|
13254
13977
|
query: [],
|
|
@@ -13303,7 +14026,8 @@ for more details.`
|
|
|
13303
14026
|
pathParams: [
|
|
13304
14027
|
{
|
|
13305
14028
|
name: "sandboxID",
|
|
13306
|
-
sdkName: "sandboxID"
|
|
14029
|
+
sdkName: "sandboxID",
|
|
14030
|
+
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
14031
|
}
|
|
13308
14032
|
],
|
|
13309
14033
|
query: [],
|
|
@@ -13331,7 +14055,8 @@ for more details.`
|
|
|
13331
14055
|
pathParams: [
|
|
13332
14056
|
{
|
|
13333
14057
|
name: "sandboxID",
|
|
13334
|
-
sdkName: "sandboxID"
|
|
14058
|
+
sdkName: "sandboxID",
|
|
14059
|
+
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
14060
|
}
|
|
13336
14061
|
],
|
|
13337
14062
|
query: [
|
|
@@ -13360,11 +14085,13 @@ for more details.`
|
|
|
13360
14085
|
pathParams: [
|
|
13361
14086
|
{
|
|
13362
14087
|
name: "sandboxID",
|
|
13363
|
-
sdkName: "sandboxID"
|
|
14088
|
+
sdkName: "sandboxID",
|
|
14089
|
+
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
14090
|
},
|
|
13365
14091
|
{
|
|
13366
14092
|
name: "processID",
|
|
13367
|
-
sdkName: "processID"
|
|
14093
|
+
sdkName: "processID",
|
|
14094
|
+
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
14095
|
}
|
|
13369
14096
|
],
|
|
13370
14097
|
query: []
|
|
@@ -13381,7 +14108,8 @@ for more details.`
|
|
|
13381
14108
|
pathParams: [
|
|
13382
14109
|
{
|
|
13383
14110
|
name: "sandboxID",
|
|
13384
|
-
sdkName: "sandboxID"
|
|
14111
|
+
sdkName: "sandboxID",
|
|
14112
|
+
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
14113
|
}
|
|
13386
14114
|
],
|
|
13387
14115
|
query: [],
|
|
@@ -13409,7 +14137,8 @@ for more details.`
|
|
|
13409
14137
|
pathParams: [
|
|
13410
14138
|
{
|
|
13411
14139
|
name: "sandboxID",
|
|
13412
|
-
sdkName: "sandboxID"
|
|
14140
|
+
sdkName: "sandboxID",
|
|
14141
|
+
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
14142
|
}
|
|
13414
14143
|
],
|
|
13415
14144
|
query: [],
|
|
@@ -13437,7 +14166,8 @@ for more details.`
|
|
|
13437
14166
|
pathParams: [
|
|
13438
14167
|
{
|
|
13439
14168
|
name: "sandboxID",
|
|
13440
|
-
sdkName: "sandboxID"
|
|
14169
|
+
sdkName: "sandboxID",
|
|
14170
|
+
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
14171
|
}
|
|
13442
14172
|
],
|
|
13443
14173
|
query: [],
|
|
@@ -13465,7 +14195,8 @@ for more details.`
|
|
|
13465
14195
|
pathParams: [
|
|
13466
14196
|
{
|
|
13467
14197
|
name: "sandbox_id",
|
|
13468
|
-
sdkName: "sandbox_id"
|
|
14198
|
+
sdkName: "sandbox_id",
|
|
14199
|
+
description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
|
|
13469
14200
|
}
|
|
13470
14201
|
],
|
|
13471
14202
|
query: [],
|
|
@@ -13511,7 +14242,8 @@ for more details.`
|
|
|
13511
14242
|
pathParams: [
|
|
13512
14243
|
{
|
|
13513
14244
|
name: "sandbox_id",
|
|
13514
|
-
sdkName: "sandbox_id"
|
|
14245
|
+
sdkName: "sandbox_id",
|
|
14246
|
+
description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
|
|
13515
14247
|
}
|
|
13516
14248
|
],
|
|
13517
14249
|
query: [
|
|
@@ -13535,7 +14267,8 @@ for more details.`
|
|
|
13535
14267
|
pathParams: [
|
|
13536
14268
|
{
|
|
13537
14269
|
name: "sandbox_id",
|
|
13538
|
-
sdkName: "sandbox_id"
|
|
14270
|
+
sdkName: "sandbox_id",
|
|
14271
|
+
description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
|
|
13539
14272
|
}
|
|
13540
14273
|
],
|
|
13541
14274
|
query: [
|
|
@@ -13559,7 +14292,8 @@ for more details.`
|
|
|
13559
14292
|
pathParams: [
|
|
13560
14293
|
{
|
|
13561
14294
|
name: "sandbox_id",
|
|
13562
|
-
sdkName: "sandbox_id"
|
|
14295
|
+
sdkName: "sandbox_id",
|
|
14296
|
+
description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
|
|
13563
14297
|
}
|
|
13564
14298
|
],
|
|
13565
14299
|
query: [],
|
|
@@ -13593,7 +14327,8 @@ for more details.`
|
|
|
13593
14327
|
pathParams: [
|
|
13594
14328
|
{
|
|
13595
14329
|
name: "sandbox_id",
|
|
13596
|
-
sdkName: "sandbox_id"
|
|
14330
|
+
sdkName: "sandbox_id",
|
|
14331
|
+
description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
|
|
13597
14332
|
}
|
|
13598
14333
|
],
|
|
13599
14334
|
query: [
|
|
@@ -13617,7 +14352,8 @@ for more details.`
|
|
|
13617
14352
|
pathParams: [
|
|
13618
14353
|
{
|
|
13619
14354
|
name: "sandbox_id",
|
|
13620
|
-
sdkName: "sandbox_id"
|
|
14355
|
+
sdkName: "sandbox_id",
|
|
14356
|
+
description: "Sandbox ID returned by sandboxes.create or sandboxes.list."
|
|
13621
14357
|
}
|
|
13622
14358
|
],
|
|
13623
14359
|
query: [
|
|
@@ -13678,7 +14414,8 @@ for more details.`
|
|
|
13678
14414
|
pathParams: [
|
|
13679
14415
|
{
|
|
13680
14416
|
name: "snapshotID",
|
|
13681
|
-
sdkName: "snapshotID"
|
|
14417
|
+
sdkName: "snapshotID",
|
|
14418
|
+
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
14419
|
}
|
|
13683
14420
|
],
|
|
13684
14421
|
query: []
|
|
@@ -13761,7 +14498,8 @@ for more details.`
|
|
|
13761
14498
|
pathParams: [
|
|
13762
14499
|
{
|
|
13763
14500
|
name: "volumeID",
|
|
13764
|
-
sdkName: "volumeID"
|
|
14501
|
+
sdkName: "volumeID",
|
|
14502
|
+
description: "Id of the team volume, the `volumeID` returned by createVolume or listVolumes."
|
|
13765
14503
|
}
|
|
13766
14504
|
],
|
|
13767
14505
|
query: []
|
|
@@ -13778,7 +14516,8 @@ for more details.`
|
|
|
13778
14516
|
pathParams: [
|
|
13779
14517
|
{
|
|
13780
14518
|
name: "volumeID",
|
|
13781
|
-
sdkName: "volumeID"
|
|
14519
|
+
sdkName: "volumeID",
|
|
14520
|
+
description: "Id of the team volume, the `volumeID` returned by createVolume or listVolumes."
|
|
13782
14521
|
}
|
|
13783
14522
|
],
|
|
13784
14523
|
query: []
|
|
@@ -14497,7 +15236,8 @@ for more details.`
|
|
|
14497
15236
|
pathParams: [
|
|
14498
15237
|
{
|
|
14499
15238
|
name: "id",
|
|
14500
|
-
sdkName: "id"
|
|
15239
|
+
sdkName: "id",
|
|
15240
|
+
description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
|
|
14501
15241
|
}
|
|
14502
15242
|
],
|
|
14503
15243
|
query: [
|
|
@@ -14521,7 +15261,8 @@ for more details.`
|
|
|
14521
15261
|
pathParams: [
|
|
14522
15262
|
{
|
|
14523
15263
|
name: "id",
|
|
14524
|
-
sdkName: "id"
|
|
15264
|
+
sdkName: "id",
|
|
15265
|
+
description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
|
|
14525
15266
|
}
|
|
14526
15267
|
],
|
|
14527
15268
|
query: [
|
|
@@ -14545,7 +15286,8 @@ for more details.`
|
|
|
14545
15286
|
pathParams: [
|
|
14546
15287
|
{
|
|
14547
15288
|
name: "id",
|
|
14548
|
-
sdkName: "id"
|
|
15289
|
+
sdkName: "id",
|
|
15290
|
+
description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
|
|
14549
15291
|
}
|
|
14550
15292
|
],
|
|
14551
15293
|
query: [
|
|
@@ -14586,7 +15328,8 @@ for more details.`
|
|
|
14586
15328
|
pathParams: [
|
|
14587
15329
|
{
|
|
14588
15330
|
name: "id",
|
|
14589
|
-
sdkName: "id"
|
|
15331
|
+
sdkName: "id",
|
|
15332
|
+
description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
|
|
14590
15333
|
}
|
|
14591
15334
|
],
|
|
14592
15335
|
query: [
|
|
@@ -14622,7 +15365,8 @@ for more details.`
|
|
|
14622
15365
|
pathParams: [
|
|
14623
15366
|
{
|
|
14624
15367
|
name: "id",
|
|
14625
|
-
sdkName: "id"
|
|
15368
|
+
sdkName: "id",
|
|
15369
|
+
description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
|
|
14626
15370
|
}
|
|
14627
15371
|
],
|
|
14628
15372
|
query: [
|
|
@@ -14667,11 +15411,13 @@ for more details.`
|
|
|
14667
15411
|
pathParams: [
|
|
14668
15412
|
{
|
|
14669
15413
|
name: "id",
|
|
14670
|
-
sdkName: "id"
|
|
15414
|
+
sdkName: "id",
|
|
15415
|
+
description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
|
|
14671
15416
|
},
|
|
14672
15417
|
{
|
|
14673
15418
|
name: "content",
|
|
14674
|
-
sdkName: "content"
|
|
15419
|
+
sdkName: "content",
|
|
15420
|
+
description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
|
|
14675
15421
|
}
|
|
14676
15422
|
],
|
|
14677
15423
|
query: [
|
|
@@ -14768,7 +15514,8 @@ for more details.`
|
|
|
14768
15514
|
pathParams: [
|
|
14769
15515
|
{
|
|
14770
15516
|
name: "name",
|
|
14771
|
-
sdkName: "name"
|
|
15517
|
+
sdkName: "name",
|
|
15518
|
+
description: "Label name from the repository label list."
|
|
14772
15519
|
}
|
|
14773
15520
|
],
|
|
14774
15521
|
query: [
|
|
@@ -14792,7 +15539,8 @@ for more details.`
|
|
|
14792
15539
|
pathParams: [
|
|
14793
15540
|
{
|
|
14794
15541
|
name: "name",
|
|
14795
|
-
sdkName: "name"
|
|
15542
|
+
sdkName: "name",
|
|
15543
|
+
description: "Label name from the repository label list."
|
|
14796
15544
|
}
|
|
14797
15545
|
],
|
|
14798
15546
|
query: [
|
|
@@ -14922,7 +15670,9 @@ for more details.`
|
|
|
14922
15670
|
pathParams: [
|
|
14923
15671
|
{
|
|
14924
15672
|
name: "number",
|
|
14925
|
-
sdkName: "number"
|
|
15673
|
+
sdkName: "number",
|
|
15674
|
+
type: "integer",
|
|
15675
|
+
description: "Milestone number shown by create and list; not the object id."
|
|
14926
15676
|
}
|
|
14927
15677
|
],
|
|
14928
15678
|
query: [
|
|
@@ -14946,7 +15696,9 @@ for more details.`
|
|
|
14946
15696
|
pathParams: [
|
|
14947
15697
|
{
|
|
14948
15698
|
name: "number",
|
|
14949
|
-
sdkName: "number"
|
|
15699
|
+
sdkName: "number",
|
|
15700
|
+
type: "integer",
|
|
15701
|
+
description: "Milestone number shown by create and list; not the object id."
|
|
14950
15702
|
}
|
|
14951
15703
|
],
|
|
14952
15704
|
query: [
|
|
@@ -14970,7 +15722,9 @@ for more details.`
|
|
|
14970
15722
|
pathParams: [
|
|
14971
15723
|
{
|
|
14972
15724
|
name: "number",
|
|
14973
|
-
sdkName: "number"
|
|
15725
|
+
sdkName: "number",
|
|
15726
|
+
type: "integer",
|
|
15727
|
+
description: "Milestone number shown by create and list; not the object id."
|
|
14974
15728
|
}
|
|
14975
15729
|
],
|
|
14976
15730
|
query: [
|
|
@@ -15157,7 +15911,9 @@ for more details.`
|
|
|
15157
15911
|
pathParams: [
|
|
15158
15912
|
{
|
|
15159
15913
|
name: "number",
|
|
15160
|
-
sdkName: "number"
|
|
15914
|
+
sdkName: "number",
|
|
15915
|
+
type: "integer",
|
|
15916
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15161
15917
|
}
|
|
15162
15918
|
],
|
|
15163
15919
|
query: [
|
|
@@ -15181,7 +15937,9 @@ for more details.`
|
|
|
15181
15937
|
pathParams: [
|
|
15182
15938
|
{
|
|
15183
15939
|
name: "number",
|
|
15184
|
-
sdkName: "number"
|
|
15940
|
+
sdkName: "number",
|
|
15941
|
+
type: "integer",
|
|
15942
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15185
15943
|
}
|
|
15186
15944
|
],
|
|
15187
15945
|
query: [
|
|
@@ -15275,7 +16033,9 @@ for more details.`
|
|
|
15275
16033
|
pathParams: [
|
|
15276
16034
|
{
|
|
15277
16035
|
name: "number",
|
|
15278
|
-
sdkName: "number"
|
|
16036
|
+
sdkName: "number",
|
|
16037
|
+
type: "integer",
|
|
16038
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15279
16039
|
}
|
|
15280
16040
|
],
|
|
15281
16041
|
query: [
|
|
@@ -15311,7 +16071,9 @@ for more details.`
|
|
|
15311
16071
|
pathParams: [
|
|
15312
16072
|
{
|
|
15313
16073
|
name: "number",
|
|
15314
|
-
sdkName: "number"
|
|
16074
|
+
sdkName: "number",
|
|
16075
|
+
type: "integer",
|
|
16076
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15315
16077
|
}
|
|
15316
16078
|
],
|
|
15317
16079
|
query: [
|
|
@@ -15352,7 +16114,9 @@ for more details.`
|
|
|
15352
16114
|
pathParams: [
|
|
15353
16115
|
{
|
|
15354
16116
|
name: "number",
|
|
15355
|
-
sdkName: "number"
|
|
16117
|
+
sdkName: "number",
|
|
16118
|
+
type: "integer",
|
|
16119
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15356
16120
|
}
|
|
15357
16121
|
],
|
|
15358
16122
|
query: [
|
|
@@ -15388,7 +16152,9 @@ for more details.`
|
|
|
15388
16152
|
pathParams: [
|
|
15389
16153
|
{
|
|
15390
16154
|
name: "number",
|
|
15391
|
-
sdkName: "number"
|
|
16155
|
+
sdkName: "number",
|
|
16156
|
+
type: "integer",
|
|
16157
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15392
16158
|
}
|
|
15393
16159
|
],
|
|
15394
16160
|
query: [
|
|
@@ -15423,11 +16189,15 @@ for more details.`
|
|
|
15423
16189
|
pathParams: [
|
|
15424
16190
|
{
|
|
15425
16191
|
name: "number",
|
|
15426
|
-
sdkName: "number"
|
|
16192
|
+
sdkName: "number",
|
|
16193
|
+
type: "integer",
|
|
16194
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15427
16195
|
},
|
|
15428
16196
|
{
|
|
15429
16197
|
name: "n",
|
|
15430
|
-
sdkName: "n"
|
|
16198
|
+
sdkName: "n",
|
|
16199
|
+
type: "integer",
|
|
16200
|
+
description: "Number of the other ticket in the relation or dependency."
|
|
15431
16201
|
}
|
|
15432
16202
|
],
|
|
15433
16203
|
query: [
|
|
@@ -15451,7 +16221,9 @@ for more details.`
|
|
|
15451
16221
|
pathParams: [
|
|
15452
16222
|
{
|
|
15453
16223
|
name: "number",
|
|
15454
|
-
sdkName: "number"
|
|
16224
|
+
sdkName: "number",
|
|
16225
|
+
type: "integer",
|
|
16226
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15455
16227
|
}
|
|
15456
16228
|
],
|
|
15457
16229
|
query: [
|
|
@@ -15487,7 +16259,9 @@ for more details.`
|
|
|
15487
16259
|
pathParams: [
|
|
15488
16260
|
{
|
|
15489
16261
|
name: "number",
|
|
15490
|
-
sdkName: "number"
|
|
16262
|
+
sdkName: "number",
|
|
16263
|
+
type: "integer",
|
|
16264
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15491
16265
|
}
|
|
15492
16266
|
],
|
|
15493
16267
|
query: [
|
|
@@ -15523,7 +16297,9 @@ for more details.`
|
|
|
15523
16297
|
pathParams: [
|
|
15524
16298
|
{
|
|
15525
16299
|
name: "number",
|
|
15526
|
-
sdkName: "number"
|
|
16300
|
+
sdkName: "number",
|
|
16301
|
+
type: "integer",
|
|
16302
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15527
16303
|
}
|
|
15528
16304
|
],
|
|
15529
16305
|
query: [
|
|
@@ -15547,7 +16323,9 @@ for more details.`
|
|
|
15547
16323
|
pathParams: [
|
|
15548
16324
|
{
|
|
15549
16325
|
name: "number",
|
|
15550
|
-
sdkName: "number"
|
|
16326
|
+
sdkName: "number",
|
|
16327
|
+
type: "integer",
|
|
16328
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15551
16329
|
}
|
|
15552
16330
|
],
|
|
15553
16331
|
query: [
|
|
@@ -15588,7 +16366,9 @@ for more details.`
|
|
|
15588
16366
|
pathParams: [
|
|
15589
16367
|
{
|
|
15590
16368
|
name: "number",
|
|
15591
|
-
sdkName: "number"
|
|
16369
|
+
sdkName: "number",
|
|
16370
|
+
type: "integer",
|
|
16371
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15592
16372
|
}
|
|
15593
16373
|
],
|
|
15594
16374
|
query: [
|
|
@@ -15624,7 +16404,9 @@ for more details.`
|
|
|
15624
16404
|
pathParams: [
|
|
15625
16405
|
{
|
|
15626
16406
|
name: "number",
|
|
15627
|
-
sdkName: "number"
|
|
16407
|
+
sdkName: "number",
|
|
16408
|
+
type: "integer",
|
|
16409
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15628
16410
|
}
|
|
15629
16411
|
],
|
|
15630
16412
|
query: [
|
|
@@ -15669,11 +16451,14 @@ for more details.`
|
|
|
15669
16451
|
pathParams: [
|
|
15670
16452
|
{
|
|
15671
16453
|
name: "number",
|
|
15672
|
-
sdkName: "number"
|
|
16454
|
+
sdkName: "number",
|
|
16455
|
+
type: "integer",
|
|
16456
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15673
16457
|
},
|
|
15674
16458
|
{
|
|
15675
16459
|
name: "content",
|
|
15676
|
-
sdkName: "content"
|
|
16460
|
+
sdkName: "content",
|
|
16461
|
+
description: "Identifier returned by the matching create or list operation; number paths take repository-local numbers."
|
|
15677
16462
|
}
|
|
15678
16463
|
],
|
|
15679
16464
|
query: [
|
|
@@ -15697,7 +16482,9 @@ for more details.`
|
|
|
15697
16482
|
pathParams: [
|
|
15698
16483
|
{
|
|
15699
16484
|
name: "number",
|
|
15700
|
-
sdkName: "number"
|
|
16485
|
+
sdkName: "number",
|
|
16486
|
+
type: "integer",
|
|
16487
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15701
16488
|
}
|
|
15702
16489
|
],
|
|
15703
16490
|
query: [
|
|
@@ -15733,7 +16520,9 @@ for more details.`
|
|
|
15733
16520
|
pathParams: [
|
|
15734
16521
|
{
|
|
15735
16522
|
name: "number",
|
|
15736
|
-
sdkName: "number"
|
|
16523
|
+
sdkName: "number",
|
|
16524
|
+
type: "integer",
|
|
16525
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15737
16526
|
}
|
|
15738
16527
|
],
|
|
15739
16528
|
query: [
|
|
@@ -15768,11 +16557,15 @@ for more details.`
|
|
|
15768
16557
|
pathParams: [
|
|
15769
16558
|
{
|
|
15770
16559
|
name: "number",
|
|
15771
|
-
sdkName: "number"
|
|
16560
|
+
sdkName: "number",
|
|
16561
|
+
type: "integer",
|
|
16562
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15772
16563
|
},
|
|
15773
16564
|
{
|
|
15774
16565
|
name: "n",
|
|
15775
|
-
sdkName: "n"
|
|
16566
|
+
sdkName: "n",
|
|
16567
|
+
type: "integer",
|
|
16568
|
+
description: "Number of the other ticket in the relation or dependency."
|
|
15776
16569
|
}
|
|
15777
16570
|
],
|
|
15778
16571
|
query: [
|
|
@@ -15796,7 +16589,9 @@ for more details.`
|
|
|
15796
16589
|
pathParams: [
|
|
15797
16590
|
{
|
|
15798
16591
|
name: "number",
|
|
15799
|
-
sdkName: "number"
|
|
16592
|
+
sdkName: "number",
|
|
16593
|
+
type: "integer",
|
|
16594
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15800
16595
|
}
|
|
15801
16596
|
],
|
|
15802
16597
|
query: [
|
|
@@ -15832,7 +16627,9 @@ for more details.`
|
|
|
15832
16627
|
pathParams: [
|
|
15833
16628
|
{
|
|
15834
16629
|
name: "number",
|
|
15835
|
-
sdkName: "number"
|
|
16630
|
+
sdkName: "number",
|
|
16631
|
+
type: "integer",
|
|
16632
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15836
16633
|
}
|
|
15837
16634
|
],
|
|
15838
16635
|
query: [
|
|
@@ -15873,11 +16670,15 @@ for more details.`
|
|
|
15873
16670
|
pathParams: [
|
|
15874
16671
|
{
|
|
15875
16672
|
name: "number",
|
|
15876
|
-
sdkName: "number"
|
|
16673
|
+
sdkName: "number",
|
|
16674
|
+
type: "integer",
|
|
16675
|
+
description: "Ticket number shown by create and list (#12 is 12); not the tk_ id."
|
|
15877
16676
|
},
|
|
15878
16677
|
{
|
|
15879
16678
|
name: "child",
|
|
15880
|
-
sdkName: "child"
|
|
16679
|
+
sdkName: "child",
|
|
16680
|
+
type: "integer",
|
|
16681
|
+
description: "Number of the sub-ticket to detach."
|
|
15881
16682
|
}
|
|
15882
16683
|
],
|
|
15883
16684
|
query: [
|
|
@@ -15977,7 +16778,8 @@ for more details.`
|
|
|
15977
16778
|
pathParams: [
|
|
15978
16779
|
{
|
|
15979
16780
|
name: "authorization_id",
|
|
15980
|
-
sdkName: "authorization_id"
|
|
16781
|
+
sdkName: "authorization_id",
|
|
16782
|
+
description: "ID of the authorization in your account, returned when authorization is created."
|
|
15981
16783
|
}
|
|
15982
16784
|
],
|
|
15983
16785
|
query: []
|
|
@@ -15994,7 +16796,8 @@ for more details.`
|
|
|
15994
16796
|
pathParams: [
|
|
15995
16797
|
{
|
|
15996
16798
|
name: "token",
|
|
15997
|
-
sdkName: "token"
|
|
16799
|
+
sdkName: "token",
|
|
16800
|
+
description: "One-time token from connect_url."
|
|
15998
16801
|
}
|
|
15999
16802
|
],
|
|
16000
16803
|
query: []
|
|
@@ -16011,7 +16814,8 @@ for more details.`
|
|
|
16011
16814
|
pathParams: [
|
|
16012
16815
|
{
|
|
16013
16816
|
name: "token",
|
|
16014
|
-
sdkName: "token"
|
|
16817
|
+
sdkName: "token",
|
|
16818
|
+
description: "One-time token from connect_url."
|
|
16015
16819
|
}
|
|
16016
16820
|
],
|
|
16017
16821
|
query: []
|
|
@@ -16028,7 +16832,8 @@ for more details.`
|
|
|
16028
16832
|
pathParams: [
|
|
16029
16833
|
{
|
|
16030
16834
|
name: "token",
|
|
16031
|
-
sdkName: "token"
|
|
16835
|
+
sdkName: "token",
|
|
16836
|
+
description: "One-time token from connect_url."
|
|
16032
16837
|
}
|
|
16033
16838
|
],
|
|
16034
16839
|
query: []
|
|
@@ -16165,7 +16970,8 @@ for more details.`
|
|
|
16165
16970
|
pathParams: [
|
|
16166
16971
|
{
|
|
16167
16972
|
name: "vault_id",
|
|
16168
|
-
sdkName: "vault_id"
|
|
16973
|
+
sdkName: "vault_id",
|
|
16974
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16169
16975
|
}
|
|
16170
16976
|
],
|
|
16171
16977
|
query: []
|
|
@@ -16182,7 +16988,8 @@ for more details.`
|
|
|
16182
16988
|
pathParams: [
|
|
16183
16989
|
{
|
|
16184
16990
|
name: "vault_id",
|
|
16185
|
-
sdkName: "vault_id"
|
|
16991
|
+
sdkName: "vault_id",
|
|
16992
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16186
16993
|
}
|
|
16187
16994
|
],
|
|
16188
16995
|
query: []
|
|
@@ -16199,7 +17006,8 @@ for more details.`
|
|
|
16199
17006
|
pathParams: [
|
|
16200
17007
|
{
|
|
16201
17008
|
name: "vault_id",
|
|
16202
|
-
sdkName: "vault_id"
|
|
17009
|
+
sdkName: "vault_id",
|
|
17010
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16203
17011
|
}
|
|
16204
17012
|
],
|
|
16205
17013
|
query: [],
|
|
@@ -16233,7 +17041,8 @@ for more details.`
|
|
|
16233
17041
|
pathParams: [
|
|
16234
17042
|
{
|
|
16235
17043
|
name: "vault_id",
|
|
16236
|
-
sdkName: "vault_id"
|
|
17044
|
+
sdkName: "vault_id",
|
|
17045
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16237
17046
|
}
|
|
16238
17047
|
],
|
|
16239
17048
|
query: []
|
|
@@ -16250,7 +17059,8 @@ for more details.`
|
|
|
16250
17059
|
pathParams: [
|
|
16251
17060
|
{
|
|
16252
17061
|
name: "vault_id",
|
|
16253
|
-
sdkName: "vault_id"
|
|
17062
|
+
sdkName: "vault_id",
|
|
17063
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16254
17064
|
}
|
|
16255
17065
|
],
|
|
16256
17066
|
query: [
|
|
@@ -16286,7 +17096,8 @@ for more details.`
|
|
|
16286
17096
|
pathParams: [
|
|
16287
17097
|
{
|
|
16288
17098
|
name: "vault_id",
|
|
16289
|
-
sdkName: "vault_id"
|
|
17099
|
+
sdkName: "vault_id",
|
|
17100
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16290
17101
|
}
|
|
16291
17102
|
],
|
|
16292
17103
|
query: [
|
|
@@ -16322,7 +17133,8 @@ for more details.`
|
|
|
16322
17133
|
pathParams: [
|
|
16323
17134
|
{
|
|
16324
17135
|
name: "vault_id",
|
|
16325
|
-
sdkName: "vault_id"
|
|
17136
|
+
sdkName: "vault_id",
|
|
17137
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16326
17138
|
}
|
|
16327
17139
|
],
|
|
16328
17140
|
query: [],
|
|
@@ -16396,11 +17208,13 @@ for more details.`
|
|
|
16396
17208
|
pathParams: [
|
|
16397
17209
|
{
|
|
16398
17210
|
name: "vault_id",
|
|
16399
|
-
sdkName: "vault_id"
|
|
17211
|
+
sdkName: "vault_id",
|
|
17212
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16400
17213
|
},
|
|
16401
17214
|
{
|
|
16402
17215
|
name: "secret",
|
|
16403
|
-
sdkName: "secret"
|
|
17216
|
+
sdkName: "secret",
|
|
17217
|
+
description: "Secret name, or its vsec_ ID."
|
|
16404
17218
|
}
|
|
16405
17219
|
],
|
|
16406
17220
|
query: []
|
|
@@ -16417,11 +17231,13 @@ for more details.`
|
|
|
16417
17231
|
pathParams: [
|
|
16418
17232
|
{
|
|
16419
17233
|
name: "vault_id",
|
|
16420
|
-
sdkName: "vault_id"
|
|
17234
|
+
sdkName: "vault_id",
|
|
17235
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16421
17236
|
},
|
|
16422
17237
|
{
|
|
16423
17238
|
name: "secret",
|
|
16424
|
-
sdkName: "secret"
|
|
17239
|
+
sdkName: "secret",
|
|
17240
|
+
description: "Secret name, or its vsec_ ID."
|
|
16425
17241
|
}
|
|
16426
17242
|
],
|
|
16427
17243
|
query: []
|
|
@@ -16438,11 +17254,13 @@ for more details.`
|
|
|
16438
17254
|
pathParams: [
|
|
16439
17255
|
{
|
|
16440
17256
|
name: "vault_id",
|
|
16441
|
-
sdkName: "vault_id"
|
|
17257
|
+
sdkName: "vault_id",
|
|
17258
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16442
17259
|
},
|
|
16443
17260
|
{
|
|
16444
17261
|
name: "secret",
|
|
16445
|
-
sdkName: "secret"
|
|
17262
|
+
sdkName: "secret",
|
|
17263
|
+
description: "Secret name, or its vsec_ ID."
|
|
16446
17264
|
}
|
|
16447
17265
|
],
|
|
16448
17266
|
query: [],
|
|
@@ -16489,11 +17307,13 @@ for more details.`
|
|
|
16489
17307
|
pathParams: [
|
|
16490
17308
|
{
|
|
16491
17309
|
name: "vault_id",
|
|
16492
|
-
sdkName: "vault_id"
|
|
17310
|
+
sdkName: "vault_id",
|
|
17311
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16493
17312
|
},
|
|
16494
17313
|
{
|
|
16495
17314
|
name: "secret",
|
|
16496
|
-
sdkName: "secret"
|
|
17315
|
+
sdkName: "secret",
|
|
17316
|
+
description: "Secret name, or its vsec_ ID."
|
|
16497
17317
|
}
|
|
16498
17318
|
],
|
|
16499
17319
|
query: []
|
|
@@ -16510,11 +17330,13 @@ for more details.`
|
|
|
16510
17330
|
pathParams: [
|
|
16511
17331
|
{
|
|
16512
17332
|
name: "vault_id",
|
|
16513
|
-
sdkName: "vault_id"
|
|
17333
|
+
sdkName: "vault_id",
|
|
17334
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16514
17335
|
},
|
|
16515
17336
|
{
|
|
16516
17337
|
name: "secret",
|
|
16517
|
-
sdkName: "secret"
|
|
17338
|
+
sdkName: "secret",
|
|
17339
|
+
description: "Secret name, or its vsec_ ID."
|
|
16518
17340
|
}
|
|
16519
17341
|
],
|
|
16520
17342
|
query: [],
|
|
@@ -16545,11 +17367,13 @@ for more details.`
|
|
|
16545
17367
|
pathParams: [
|
|
16546
17368
|
{
|
|
16547
17369
|
name: "vault_id",
|
|
16548
|
-
sdkName: "vault_id"
|
|
17370
|
+
sdkName: "vault_id",
|
|
17371
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16549
17372
|
},
|
|
16550
17373
|
{
|
|
16551
17374
|
name: "secret",
|
|
16552
|
-
sdkName: "secret"
|
|
17375
|
+
sdkName: "secret",
|
|
17376
|
+
description: "Secret name, or its vsec_ ID."
|
|
16553
17377
|
}
|
|
16554
17378
|
],
|
|
16555
17379
|
query: []
|
|
@@ -16566,7 +17390,8 @@ for more details.`
|
|
|
16566
17390
|
pathParams: [
|
|
16567
17391
|
{
|
|
16568
17392
|
name: "vault_id",
|
|
16569
|
-
sdkName: "vault_id"
|
|
17393
|
+
sdkName: "vault_id",
|
|
17394
|
+
description: "ID of the vault in your account, returned when the vault is created."
|
|
16570
17395
|
}
|
|
16571
17396
|
],
|
|
16572
17397
|
query: [],
|
|
@@ -17817,6 +18642,161 @@ var unblockEndUser = (options) => (options.client ?? client).post({
|
|
|
17817
18642
|
url: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock",
|
|
17818
18643
|
...options
|
|
17819
18644
|
});
|
|
18645
|
+
var listCustomers = (options) => (options.client ?? client).get({
|
|
18646
|
+
security: [{
|
|
18647
|
+
key: "BearerAuth",
|
|
18648
|
+
scheme: "bearer",
|
|
18649
|
+
type: "http"
|
|
18650
|
+
}, {
|
|
18651
|
+
key: "ApiKeyAuth",
|
|
18652
|
+
name: "X-API-Key",
|
|
18653
|
+
type: "apiKey"
|
|
18654
|
+
}],
|
|
18655
|
+
url: "/agent/v1/agents/{agent_id}/customers",
|
|
18656
|
+
...options
|
|
18657
|
+
});
|
|
18658
|
+
var deleteCustomer = (options) => (options.client ?? client).delete({
|
|
18659
|
+
security: [{
|
|
18660
|
+
key: "BearerAuth",
|
|
18661
|
+
scheme: "bearer",
|
|
18662
|
+
type: "http"
|
|
18663
|
+
}, {
|
|
18664
|
+
key: "ApiKeyAuth",
|
|
18665
|
+
name: "X-API-Key",
|
|
18666
|
+
type: "apiKey"
|
|
18667
|
+
}],
|
|
18668
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}",
|
|
18669
|
+
...options
|
|
18670
|
+
});
|
|
18671
|
+
var getCustomer = (options) => (options.client ?? client).get({
|
|
18672
|
+
security: [{
|
|
18673
|
+
key: "BearerAuth",
|
|
18674
|
+
scheme: "bearer",
|
|
18675
|
+
type: "http"
|
|
18676
|
+
}, {
|
|
18677
|
+
key: "ApiKeyAuth",
|
|
18678
|
+
name: "X-API-Key",
|
|
18679
|
+
type: "apiKey"
|
|
18680
|
+
}],
|
|
18681
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}",
|
|
18682
|
+
...options
|
|
18683
|
+
});
|
|
18684
|
+
var getCustomerDeletion = (options) => (options.client ?? client).get({
|
|
18685
|
+
security: [{
|
|
18686
|
+
key: "BearerAuth",
|
|
18687
|
+
scheme: "bearer",
|
|
18688
|
+
type: "http"
|
|
18689
|
+
}, {
|
|
18690
|
+
key: "ApiKeyAuth",
|
|
18691
|
+
name: "X-API-Key",
|
|
18692
|
+
type: "apiKey"
|
|
18693
|
+
}],
|
|
18694
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion",
|
|
18695
|
+
...options
|
|
18696
|
+
});
|
|
18697
|
+
var blockCustomer = (options) => (options.client ?? client).post({
|
|
18698
|
+
security: [{
|
|
18699
|
+
key: "BearerAuth",
|
|
18700
|
+
scheme: "bearer",
|
|
18701
|
+
type: "http"
|
|
18702
|
+
}, {
|
|
18703
|
+
key: "ApiKeyAuth",
|
|
18704
|
+
name: "X-API-Key",
|
|
18705
|
+
type: "apiKey"
|
|
18706
|
+
}],
|
|
18707
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}/block",
|
|
18708
|
+
...options
|
|
18709
|
+
});
|
|
18710
|
+
var unblockCustomer = (options) => (options.client ?? client).post({
|
|
18711
|
+
security: [{
|
|
18712
|
+
key: "BearerAuth",
|
|
18713
|
+
scheme: "bearer",
|
|
18714
|
+
type: "http"
|
|
18715
|
+
}, {
|
|
18716
|
+
key: "ApiKeyAuth",
|
|
18717
|
+
name: "X-API-Key",
|
|
18718
|
+
type: "apiKey"
|
|
18719
|
+
}],
|
|
18720
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock",
|
|
18721
|
+
...options
|
|
18722
|
+
});
|
|
18723
|
+
var revokeCustomerTokens = (options) => (options.client ?? client).post({
|
|
18724
|
+
security: [{
|
|
18725
|
+
key: "BearerAuth",
|
|
18726
|
+
scheme: "bearer",
|
|
18727
|
+
type: "http"
|
|
18728
|
+
}, {
|
|
18729
|
+
key: "ApiKeyAuth",
|
|
18730
|
+
name: "X-API-Key",
|
|
18731
|
+
type: "apiKey"
|
|
18732
|
+
}],
|
|
18733
|
+
url: "/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens",
|
|
18734
|
+
...options
|
|
18735
|
+
});
|
|
18736
|
+
var getAgentAppearance = (options) => (options.client ?? client).get({
|
|
18737
|
+
security: [{
|
|
18738
|
+
key: "BearerAuth",
|
|
18739
|
+
scheme: "bearer",
|
|
18740
|
+
type: "http"
|
|
18741
|
+
}, {
|
|
18742
|
+
key: "ApiKeyAuth",
|
|
18743
|
+
name: "X-API-Key",
|
|
18744
|
+
type: "apiKey"
|
|
18745
|
+
}],
|
|
18746
|
+
url: "/agent/v1/agents/{agent_id}/appearance",
|
|
18747
|
+
...options
|
|
18748
|
+
});
|
|
18749
|
+
var createCustomerGrantCode = (options) => (options.client ?? client).post({
|
|
18750
|
+
security: [{
|
|
18751
|
+
key: "BearerAuth",
|
|
18752
|
+
scheme: "bearer",
|
|
18753
|
+
type: "http"
|
|
18754
|
+
}, {
|
|
18755
|
+
key: "ApiKeyAuth",
|
|
18756
|
+
name: "X-API-Key",
|
|
18757
|
+
type: "apiKey"
|
|
18758
|
+
}],
|
|
18759
|
+
url: "/agent/v1/agents/{agent_id}/customers/auth/grant_codes",
|
|
18760
|
+
...options,
|
|
18761
|
+
headers: {
|
|
18762
|
+
"Content-Type": "application/json",
|
|
18763
|
+
...options.headers
|
|
18764
|
+
}
|
|
18765
|
+
});
|
|
18766
|
+
var createCustomerAccessToken = (options) => (options.client ?? client).post({
|
|
18767
|
+
url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens",
|
|
18768
|
+
...options,
|
|
18769
|
+
headers: {
|
|
18770
|
+
"Content-Type": "application/json",
|
|
18771
|
+
...options.headers
|
|
18772
|
+
}
|
|
18773
|
+
});
|
|
18774
|
+
var renewCustomerAccessToken = (options) => (options.client ?? client).post({
|
|
18775
|
+
security: [{
|
|
18776
|
+
key: "BearerAuth",
|
|
18777
|
+
scheme: "bearer",
|
|
18778
|
+
type: "http"
|
|
18779
|
+
}, {
|
|
18780
|
+
key: "ApiKeyAuth",
|
|
18781
|
+
name: "X-API-Key",
|
|
18782
|
+
type: "apiKey"
|
|
18783
|
+
}],
|
|
18784
|
+
url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew",
|
|
18785
|
+
...options
|
|
18786
|
+
});
|
|
18787
|
+
var deleteCurrentCustomerAccessToken = (options) => (options.client ?? client).delete({
|
|
18788
|
+
security: [{
|
|
18789
|
+
key: "BearerAuth",
|
|
18790
|
+
scheme: "bearer",
|
|
18791
|
+
type: "http"
|
|
18792
|
+
}, {
|
|
18793
|
+
key: "ApiKeyAuth",
|
|
18794
|
+
name: "X-API-Key",
|
|
18795
|
+
type: "apiKey"
|
|
18796
|
+
}],
|
|
18797
|
+
url: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current",
|
|
18798
|
+
...options
|
|
18799
|
+
});
|
|
17820
18800
|
var exchangeEmbedCode = (options) => (options.client ?? client).post({
|
|
17821
18801
|
url: "/agent/v1/embed/exchange",
|
|
17822
18802
|
...options,
|
|
@@ -23533,6 +24513,33 @@ function createAgent(transport) {
|
|
|
23533
24513
|
agents: {
|
|
23534
24514
|
archive: bind(transport, agentsArchive),
|
|
23535
24515
|
create: bind(transport, agentsCreate),
|
|
24516
|
+
customers: {
|
|
24517
|
+
auth: {
|
|
24518
|
+
accessTokens: {
|
|
24519
|
+
create: bind(transport, createCustomerAccessToken),
|
|
24520
|
+
deleteCurrent: bind(transport, deleteCurrentCustomerAccessToken),
|
|
24521
|
+
renew: {
|
|
24522
|
+
create: bind(transport, renewCustomerAccessToken)
|
|
24523
|
+
}
|
|
24524
|
+
},
|
|
24525
|
+
grantCodes: {
|
|
24526
|
+
create: bind(transport, createCustomerGrantCode)
|
|
24527
|
+
}
|
|
24528
|
+
},
|
|
24529
|
+
block: {
|
|
24530
|
+
create: bind(transport, blockCustomer)
|
|
24531
|
+
},
|
|
24532
|
+
delete: bind(transport, deleteCustomer),
|
|
24533
|
+
list: bind(transport, listCustomers),
|
|
24534
|
+
retrieve: bind(transport, getCustomer),
|
|
24535
|
+
retrieveDeletion: bind(transport, getCustomerDeletion),
|
|
24536
|
+
revokeTokens: {
|
|
24537
|
+
create: bind(transport, revokeCustomerTokens)
|
|
24538
|
+
},
|
|
24539
|
+
unblock: {
|
|
24540
|
+
create: bind(transport, unblockCustomer)
|
|
24541
|
+
}
|
|
24542
|
+
},
|
|
23536
24543
|
endUsers: {
|
|
23537
24544
|
block: {
|
|
23538
24545
|
create: bind(transport, blockEndUser)
|
|
@@ -23550,6 +24557,7 @@ function createAgent(transport) {
|
|
|
23550
24557
|
},
|
|
23551
24558
|
list: bind(transport, agentsList),
|
|
23552
24559
|
retrieve: bind(transport, agentsRetrieve),
|
|
24560
|
+
retrieveAppearance: bind(transport, getAgentAppearance),
|
|
23553
24561
|
unarchive: {
|
|
23554
24562
|
create: bind(transport, unarchiveAgent)
|
|
23555
24563
|
},
|
|
@@ -24970,7 +25978,7 @@ function operationOptions(op) {
|
|
|
24970
25978
|
if (p === target)
|
|
24971
25979
|
continue;
|
|
24972
25980
|
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 });
|
|
25981
|
+
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
25982
|
}
|
|
24975
25983
|
for (const location of ["query", "body"]) {
|
|
24976
25984
|
const fields = location === "query" ? op.query : op.body?.fields ?? [];
|
|
@@ -25068,7 +26076,7 @@ function convert(value, spec) {
|
|
|
25068
26076
|
} else if (spec.type === "number" || spec.type === "integer") {
|
|
25069
26077
|
const n = typeof value === "string" && value.trim() ? Number(value) : NaN;
|
|
25070
26078
|
if (!Number.isFinite(n) || spec.type === "integer" && !Number.isSafeInteger(n))
|
|
25071
|
-
throw new UsageError(`--${spec.name} must be ${spec.type}
|
|
26079
|
+
throw new UsageError(`--${spec.name} must be ${spec.type}`, spec.location === "path" ? spec.description : undefined);
|
|
25072
26080
|
result = n;
|
|
25073
26081
|
} else if (typeof value !== "string")
|
|
25074
26082
|
throw new UsageError(`--${spec.name} requires a value`);
|
|
@@ -25116,8 +26124,13 @@ function bindArgs(parsed, op, data) {
|
|
|
25116
26124
|
if (target) {
|
|
25117
26125
|
if (parsed.positional[0] === undefined)
|
|
25118
26126
|
missing.push(`<${target.sdkName}> (target ID)`);
|
|
25119
|
-
else
|
|
25120
|
-
|
|
26127
|
+
else {
|
|
26128
|
+
const raw = parsed.positional[0];
|
|
26129
|
+
if (target.type && !(target.type === "integer" ? Number.isSafeInteger(Number(raw)) : Number.isFinite(Number(raw))) || target.type && !raw.trim()) {
|
|
26130
|
+
throw new UsageError(`<${target.sdkName}> must be ${target.type}`, target.description);
|
|
26131
|
+
}
|
|
26132
|
+
opts.path = { [target.sdkName]: target.type ? Number(raw) : raw };
|
|
26133
|
+
}
|
|
25121
26134
|
}
|
|
25122
26135
|
if (data !== undefined)
|
|
25123
26136
|
opts.body = data;
|
|
@@ -25194,9 +26207,10 @@ function help(commands, prefix, command) {
|
|
|
25194
26207
|
`praxis ${command.words.join(" ")}${target ? ` <${target.sdkName}>` : ""} [options]`,
|
|
25195
26208
|
`SDK: ${command.op.resource}.${command.alias ?? command.op.method}`,
|
|
25196
26209
|
`${command.op.http} ${command.op.path}`,
|
|
25197
|
-
...target ? [`Position: <${target.sdkName}
|
|
26210
|
+
...target ? [`Position: <${target.sdkName}>${target.type ? ` <${target.type}>` : ""} (required target ID)`] : [],
|
|
25198
26211
|
"",
|
|
25199
26212
|
"Options:",
|
|
26213
|
+
...target?.description ? [` <${target.sdkName}> — ${target.description.replace(/\s+/g, " ")}`] : [],
|
|
25200
26214
|
...[...operationOptions(command.op), ...command.op.body ? [dataOption] : [], ...globalOptions].map((s) => ` ${describeOption(s)}`),
|
|
25201
26215
|
...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
26216
|
" -h is an alias of --help",
|
|
@@ -26377,7 +27391,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
26377
27391
|
}
|
|
26378
27392
|
|
|
26379
27393
|
// src/main.ts
|
|
26380
|
-
var version = "0.1.
|
|
27394
|
+
var version = "0.1.1-dev.54635ff";
|
|
26381
27395
|
var commands = commandTree(operations);
|
|
26382
27396
|
var manual = [["login"], ["logout"], ["whoami"], ["org", "list"], ["org", "switch"], ["api"], ["skill"]];
|
|
26383
27397
|
function route(argv) {
|