@deepraxis/sdk 0.1.0-dev.331f4e7 → 0.1.0-dev.35d57f8
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/METHODS.md +39 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +147 -61
- package/dist/generated/sdk.gen.js +274 -23
- package/dist/generated/types.gen.d.ts +2045 -667
- package/dist/operations.generated.d.ts +369 -82
- package/dist/operations.generated.js +436 -95
- package/dist/resources.generated.d.ts +166 -119
- package/dist/resources.generated.js +27 -0
- package/package.json +1 -1
|
@@ -61,7 +61,7 @@ export const operations = [
|
|
|
61
61
|
"resource": "agent.agents",
|
|
62
62
|
"method": "create",
|
|
63
63
|
"summary": "Create agent",
|
|
64
|
-
"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.
|
|
64
|
+
"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\"}]}.",
|
|
65
65
|
"http": "POST",
|
|
66
66
|
"path": "/agent/v1/agents",
|
|
67
67
|
"streaming": "no",
|
|
@@ -75,13 +75,13 @@ export const operations = [
|
|
|
75
75
|
"name": "model",
|
|
76
76
|
"type": "object",
|
|
77
77
|
"required": true,
|
|
78
|
-
"description": "
|
|
78
|
+
"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."
|
|
79
79
|
},
|
|
80
80
|
{
|
|
81
81
|
"name": "name",
|
|
82
82
|
"type": "string",
|
|
83
83
|
"required": true,
|
|
84
|
-
"description": "
|
|
84
|
+
"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."
|
|
85
85
|
},
|
|
86
86
|
{
|
|
87
87
|
"name": "description",
|
|
@@ -113,7 +113,7 @@ export const operations = [
|
|
|
113
113
|
"type": "array",
|
|
114
114
|
"itemType": "object",
|
|
115
115
|
"required": false,
|
|
116
|
-
"description": "
|
|
116
|
+
"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."
|
|
117
117
|
},
|
|
118
118
|
{
|
|
119
119
|
"name": "system",
|
|
@@ -129,25 +129,11 @@ export const operations = [
|
|
|
129
129
|
"description": "Tool configurations available to the agent. Maximum of 128 tools\nacross all toolsets allowed."
|
|
130
130
|
},
|
|
131
131
|
{
|
|
132
|
-
"name": "
|
|
133
|
-
"type": "array",
|
|
134
|
-
"itemType": "object",
|
|
135
|
-
"required": false,
|
|
136
|
-
"description": "Database allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings."
|
|
137
|
-
},
|
|
138
|
-
{
|
|
139
|
-
"name": "vector_stores",
|
|
140
|
-
"type": "array",
|
|
141
|
-
"itemType": "object",
|
|
142
|
-
"required": false,
|
|
143
|
-
"description": "Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings."
|
|
144
|
-
},
|
|
145
|
-
{
|
|
146
|
-
"name": "files",
|
|
132
|
+
"name": "bindings",
|
|
147
133
|
"type": "array",
|
|
148
134
|
"itemType": "object",
|
|
149
135
|
"required": false,
|
|
150
|
-
"description": "
|
|
136
|
+
"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."
|
|
151
137
|
},
|
|
152
138
|
{
|
|
153
139
|
"name": "kind",
|
|
@@ -197,6 +183,25 @@ export const operations = [
|
|
|
197
183
|
"required": false,
|
|
198
184
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
199
185
|
},
|
|
186
|
+
{
|
|
187
|
+
"name": "avatar",
|
|
188
|
+
"type": "string",
|
|
189
|
+
"required": false,
|
|
190
|
+
"description": "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"name": "environment_id",
|
|
194
|
+
"type": "string",
|
|
195
|
+
"required": false,
|
|
196
|
+
"description": "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "vault_ids",
|
|
200
|
+
"type": "array",
|
|
201
|
+
"itemType": "string",
|
|
202
|
+
"required": false,
|
|
203
|
+
"description": "Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
204
|
+
},
|
|
200
205
|
{
|
|
201
206
|
"name": "preset",
|
|
202
207
|
"type": "string",
|
|
@@ -215,7 +220,7 @@ export const operations = [
|
|
|
215
220
|
"resource": "agent.agents",
|
|
216
221
|
"method": "retrieve",
|
|
217
222
|
"summary": "Get agent",
|
|
218
|
-
"description": "Read one agent by id
|
|
223
|
+
"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.",
|
|
219
224
|
"http": "GET",
|
|
220
225
|
"path": "/agent/v1/agents/{agent_id}",
|
|
221
226
|
"streaming": "no",
|
|
@@ -231,7 +236,7 @@ export const operations = [
|
|
|
231
236
|
"name": "version",
|
|
232
237
|
"type": "number",
|
|
233
238
|
"required": false,
|
|
234
|
-
"description": "Agent version to read; omit for the latest.
|
|
239
|
+
"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."
|
|
235
240
|
}
|
|
236
241
|
]
|
|
237
242
|
},
|
|
@@ -239,7 +244,7 @@ export const operations = [
|
|
|
239
244
|
"resource": "agent.agents",
|
|
240
245
|
"method": "update",
|
|
241
246
|
"summary": "Update agent",
|
|
242
|
-
"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.
|
|
247
|
+
"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.",
|
|
243
248
|
"http": "POST",
|
|
244
249
|
"path": "/agent/v1/agents/{agent_id}",
|
|
245
250
|
"streaming": "no",
|
|
@@ -277,7 +282,7 @@ export const operations = [
|
|
|
277
282
|
"name": "model",
|
|
278
283
|
"type": "object",
|
|
279
284
|
"required": false,
|
|
280
|
-
"description": "
|
|
285
|
+
"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."
|
|
281
286
|
},
|
|
282
287
|
{
|
|
283
288
|
"name": "multiagent",
|
|
@@ -289,14 +294,14 @@ export const operations = [
|
|
|
289
294
|
"name": "name",
|
|
290
295
|
"type": "string",
|
|
291
296
|
"required": false,
|
|
292
|
-
"description": "
|
|
297
|
+
"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."
|
|
293
298
|
},
|
|
294
299
|
{
|
|
295
300
|
"name": "skills",
|
|
296
301
|
"type": "array",
|
|
297
302
|
"itemType": "object",
|
|
298
303
|
"required": false,
|
|
299
|
-
"description": "
|
|
304
|
+
"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."
|
|
300
305
|
},
|
|
301
306
|
{
|
|
302
307
|
"name": "system",
|
|
@@ -327,28 +332,14 @@ export const operations = [
|
|
|
327
332
|
"name": "version_note",
|
|
328
333
|
"type": "string",
|
|
329
334
|
"required": false,
|
|
330
|
-
"description": "Optional change explanation stored as note on the new immutable version, up to 280 characters. Omission stores
|
|
331
|
-
},
|
|
332
|
-
{
|
|
333
|
-
"name": "databases",
|
|
334
|
-
"type": "array",
|
|
335
|
-
"itemType": "object",
|
|
336
|
-
"required": false,
|
|
337
|
-
"description": "Replace this resource allowlist; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept nonempty bindings."
|
|
335
|
+
"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."
|
|
338
336
|
},
|
|
339
337
|
{
|
|
340
|
-
"name": "
|
|
341
|
-
"type": "array",
|
|
342
|
-
"itemType": "object",
|
|
343
|
-
"required": false,
|
|
344
|
-
"description": "Replace this resource allowlist; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept nonempty bindings."
|
|
345
|
-
},
|
|
346
|
-
{
|
|
347
|
-
"name": "files",
|
|
338
|
+
"name": "bindings",
|
|
348
339
|
"type": "array",
|
|
349
340
|
"itemType": "object",
|
|
350
341
|
"required": false,
|
|
351
|
-
"description": "Replace
|
|
342
|
+
"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."
|
|
352
343
|
},
|
|
353
344
|
{
|
|
354
345
|
"name": "kind",
|
|
@@ -398,6 +389,25 @@ export const operations = [
|
|
|
398
389
|
"required": false,
|
|
399
390
|
"description": "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable."
|
|
400
391
|
},
|
|
392
|
+
{
|
|
393
|
+
"name": "avatar",
|
|
394
|
+
"type": "string",
|
|
395
|
+
"required": false,
|
|
396
|
+
"description": "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "environment_id",
|
|
400
|
+
"type": "string",
|
|
401
|
+
"required": false,
|
|
402
|
+
"description": "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
403
|
+
},
|
|
404
|
+
{
|
|
405
|
+
"name": "vault_ids",
|
|
406
|
+
"type": "array",
|
|
407
|
+
"itemType": "string",
|
|
408
|
+
"required": false,
|
|
409
|
+
"description": "Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
410
|
+
},
|
|
401
411
|
{
|
|
402
412
|
"name": "preset",
|
|
403
413
|
"type": "string",
|
|
@@ -429,6 +439,144 @@ export const operations = [
|
|
|
429
439
|
],
|
|
430
440
|
"query": []
|
|
431
441
|
},
|
|
442
|
+
{
|
|
443
|
+
"resource": "agent.agents.customers.auth.accessTokens",
|
|
444
|
+
"method": "create",
|
|
445
|
+
"summary": "Create customer access token",
|
|
446
|
+
"description": "Exchange a grant code, or the agent's publishable key for an anonymous visitor, for a customer access token that authorizes the agent's embedded sessions.\n\nNo Authorization header is required: the grant code or the publishable key is the credential. Agent Kit calls this from the browser, so send the page Origin. With grant_code, the code is consumed atomically: concurrent attempts have exactly one winner, and unknown, used, expired and other-agent codes all return the same 401 GRANT_CODE_INVALID. The sign-in starts now and lasts the code's max_session_seconds. Unlike Shopify, a visitor without an account gets a token too: send publishable_key instead and a new anonymous customer (anon_…) is created, bound to the request Origin, for 7 days. The access token lasts at most two hours and never outlives the sign-in; renew it with access_tokens/renew before expires_at. Both forms share the per-IP minute limit of anonymous issuance (default 20). Example body: {\"grant_code\":\"cgc_…\"}.",
|
|
447
|
+
"http": "POST",
|
|
448
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/access_tokens",
|
|
449
|
+
"streaming": "no",
|
|
450
|
+
"pagination": false,
|
|
451
|
+
"pathParams": [
|
|
452
|
+
{
|
|
453
|
+
"name": "agent_id",
|
|
454
|
+
"sdkName": "agent_id"
|
|
455
|
+
}
|
|
456
|
+
],
|
|
457
|
+
"query": [],
|
|
458
|
+
"body": {
|
|
459
|
+
"required": true,
|
|
460
|
+
"fields": []
|
|
461
|
+
}
|
|
462
|
+
},
|
|
463
|
+
{
|
|
464
|
+
"resource": "agent.agents.customers.auth.accessTokens",
|
|
465
|
+
"method": "deleteCurrent",
|
|
466
|
+
"summary": "Log out customer",
|
|
467
|
+
"description": "Log the customer out by revoking the sign-in of the presented access token and every token issued in it.\n\nSend the current customer access token as the Bearer credential, with no body, when the customer logs out of your site. Every token of the sign-in, including renewed ones, stops working, and their live event streams close; the customer's conversations are kept. Returns 204. Calling it again with the same token returns 401 ACCESS_TOKEN_REVOKED, so treat that as already logged out.",
|
|
468
|
+
"http": "DELETE",
|
|
469
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current",
|
|
470
|
+
"streaming": "no",
|
|
471
|
+
"pagination": false,
|
|
472
|
+
"pathParams": [
|
|
473
|
+
{
|
|
474
|
+
"name": "agent_id",
|
|
475
|
+
"sdkName": "agent_id"
|
|
476
|
+
}
|
|
477
|
+
],
|
|
478
|
+
"query": []
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"resource": "agent.agents.customers.auth.accessTokens.renew",
|
|
482
|
+
"method": "create",
|
|
483
|
+
"summary": "Renew customer access token",
|
|
484
|
+
"description": "Get a fresh customer access token in the same sign-in, authenticated with the current one.\n\nSend the current customer access token as the Bearer credential, with no body, a few minutes before expires_at. The new token keeps the version, budget, context, metadata and origin binding of the sign-in and lasts at most two hours, never past session_expires_at. Unlike Shopify, renewal does not revoke the presented token: it stays valid until its own expiry, so a reply that is streaming on it is not cut off. When less than 60 seconds of the sign-in remain, renewal returns 401 CUSTOMER_SESSION_EXPIRED; sign the customer in again with a new grant code from your backend. A token that was logged out or merged returns 401 ACCESS_TOKEN_REVOKED.",
|
|
485
|
+
"http": "POST",
|
|
486
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew",
|
|
487
|
+
"streaming": "no",
|
|
488
|
+
"pagination": false,
|
|
489
|
+
"pathParams": [
|
|
490
|
+
{
|
|
491
|
+
"name": "agent_id",
|
|
492
|
+
"sdkName": "agent_id"
|
|
493
|
+
}
|
|
494
|
+
],
|
|
495
|
+
"query": []
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"resource": "agent.agents.customers.auth.grantCodes",
|
|
499
|
+
"method": "create",
|
|
500
|
+
"summary": "Create customer grant code",
|
|
501
|
+
"description": "Sign your logged-in customer in to a service agent from your backend with a one-time grant code that Agent Kit exchanges for a customer access token.\n\nCall this from your backend with your API key after your own login succeeds, then pass the returned code to Agent Kit in the browser; never call it from the browser. Customer authorization follows Shopify Storefront customer access tokens (Multipass-style sign-in, a short-lived token, renewal and logout), so that experience applies. customer_id is your own identifier for the customer: use an opaque id such as your database user id, not an email address or phone number. The value auth is reserved, and ids starting with anon_ are reserved for anonymous customers. The code works once and expires after expires_in seconds (default 900). The sign-in it starts lasts max_session_seconds (default 7 days); version, budget_cents, 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\"}.",
|
|
502
|
+
"http": "POST",
|
|
503
|
+
"path": "/agent/v1/agents/{agent_id}/customers/auth/grant_codes",
|
|
504
|
+
"streaming": "no",
|
|
505
|
+
"pagination": false,
|
|
506
|
+
"pathParams": [
|
|
507
|
+
{
|
|
508
|
+
"name": "agent_id",
|
|
509
|
+
"sdkName": "agent_id"
|
|
510
|
+
}
|
|
511
|
+
],
|
|
512
|
+
"query": [],
|
|
513
|
+
"body": {
|
|
514
|
+
"required": true,
|
|
515
|
+
"fields": [
|
|
516
|
+
{
|
|
517
|
+
"name": "customer_id",
|
|
518
|
+
"type": "string",
|
|
519
|
+
"required": true,
|
|
520
|
+
"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."
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
"name": "version",
|
|
524
|
+
"type": "integer",
|
|
525
|
+
"required": false,
|
|
526
|
+
"description": "Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued."
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"name": "budget_cents",
|
|
530
|
+
"type": "integer",
|
|
531
|
+
"required": false,
|
|
532
|
+
"description": "Budget in cents for each session the customer starts. Defaults to the embed policy session budget and cannot exceed its maximum."
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"name": "system_message",
|
|
536
|
+
"type": "array",
|
|
537
|
+
"itemType": "object",
|
|
538
|
+
"required": false,
|
|
539
|
+
"description": "Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total."
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"name": "agent_override",
|
|
543
|
+
"type": "object",
|
|
544
|
+
"required": false,
|
|
545
|
+
"description": "Optional system prompt override, accepted only when the embed policy allows agent overrides."
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"name": "metadata",
|
|
549
|
+
"type": "object",
|
|
550
|
+
"required": false,
|
|
551
|
+
"description": "Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved."
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
"name": "origin",
|
|
555
|
+
"type": "string",
|
|
556
|
+
"required": false,
|
|
557
|
+
"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."
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"name": "expires_in",
|
|
561
|
+
"type": "integer",
|
|
562
|
+
"required": false,
|
|
563
|
+
"description": "Seconds the code stays redeemable, from 60 to 86400. Defaults to 900."
|
|
564
|
+
},
|
|
565
|
+
{
|
|
566
|
+
"name": "max_session_seconds",
|
|
567
|
+
"type": "integer",
|
|
568
|
+
"required": false,
|
|
569
|
+
"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."
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
"name": "anonymous_access_token",
|
|
573
|
+
"type": "string",
|
|
574
|
+
"required": false,
|
|
575
|
+
"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."
|
|
576
|
+
}
|
|
577
|
+
]
|
|
578
|
+
}
|
|
579
|
+
},
|
|
432
580
|
{
|
|
433
581
|
"resource": "agent.agents.endUsers",
|
|
434
582
|
"method": "list",
|
|
@@ -619,7 +767,7 @@ export const operations = [
|
|
|
619
767
|
"resource": "agent.agents.versions",
|
|
620
768
|
"method": "list",
|
|
621
769
|
"summary": "List agent versions",
|
|
622
|
-
"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.",
|
|
770
|
+
"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.",
|
|
623
771
|
"http": "GET",
|
|
624
772
|
"path": "/agent/v1/agents/{agent_id}/versions",
|
|
625
773
|
"streaming": "no",
|
|
@@ -669,8 +817,8 @@ export const operations = [
|
|
|
669
817
|
{
|
|
670
818
|
"resource": "agent.computers",
|
|
671
819
|
"method": "list",
|
|
672
|
-
"summary": "
|
|
673
|
-
"description": "
|
|
820
|
+
"summary": "List Computers",
|
|
821
|
+
"description": "List the computers of your organization, archived ones included.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
674
822
|
"http": "GET",
|
|
675
823
|
"path": "/agent/v1/computers",
|
|
676
824
|
"streaming": "no",
|
|
@@ -694,8 +842,8 @@ export const operations = [
|
|
|
694
842
|
{
|
|
695
843
|
"resource": "agent.computers",
|
|
696
844
|
"method": "create",
|
|
697
|
-
"summary": "
|
|
698
|
-
"description": "
|
|
845
|
+
"summary": "Create Computer",
|
|
846
|
+
"description": "Create a durable computer: a named machine whose files outlive sessions, for personal agents.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
699
847
|
"http": "POST",
|
|
700
848
|
"path": "/agent/v1/computers",
|
|
701
849
|
"streaming": "no",
|
|
@@ -740,8 +888,8 @@ export const operations = [
|
|
|
740
888
|
{
|
|
741
889
|
"resource": "agent.computers",
|
|
742
890
|
"method": "retrieve",
|
|
743
|
-
"summary": "
|
|
744
|
-
"description": "
|
|
891
|
+
"summary": "Get Computer",
|
|
892
|
+
"description": "Read one computer's status, storage use and sandbox id.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
745
893
|
"http": "GET",
|
|
746
894
|
"path": "/agent/v1/computers/{computer_id}",
|
|
747
895
|
"streaming": "no",
|
|
@@ -757,8 +905,8 @@ export const operations = [
|
|
|
757
905
|
{
|
|
758
906
|
"resource": "agent.computers",
|
|
759
907
|
"method": "update",
|
|
760
|
-
"summary": "
|
|
761
|
-
"description": "
|
|
908
|
+
"summary": "Update Computer",
|
|
909
|
+
"description": "Rename a computer.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
762
910
|
"http": "POST",
|
|
763
911
|
"path": "/agent/v1/computers/{computer_id}",
|
|
764
912
|
"streaming": "no",
|
|
@@ -785,8 +933,8 @@ export const operations = [
|
|
|
785
933
|
{
|
|
786
934
|
"resource": "agent.computers",
|
|
787
935
|
"method": "archive",
|
|
788
|
-
"summary": "
|
|
789
|
-
"description": "
|
|
936
|
+
"summary": "Archive Computer",
|
|
937
|
+
"description": "Archive a computer: its files stay readable but new sessions cannot use it.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
790
938
|
"http": "POST",
|
|
791
939
|
"path": "/agent/v1/computers/{computer_id}/archive",
|
|
792
940
|
"streaming": "no",
|
|
@@ -862,8 +1010,8 @@ export const operations = [
|
|
|
862
1010
|
{
|
|
863
1011
|
"resource": "agent.computers.files",
|
|
864
1012
|
"method": "list",
|
|
865
|
-
"summary": "
|
|
866
|
-
"description": "
|
|
1013
|
+
"summary": "List Computer Files",
|
|
1014
|
+
"description": "List the entries of one directory on a computer.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
867
1015
|
"http": "GET",
|
|
868
1016
|
"path": "/agent/v1/computers/{computer_id}/files",
|
|
869
1017
|
"streaming": "no",
|
|
@@ -886,8 +1034,8 @@ export const operations = [
|
|
|
886
1034
|
{
|
|
887
1035
|
"resource": "agent.computers.files",
|
|
888
1036
|
"method": "retrieveContent",
|
|
889
|
-
"summary": "
|
|
890
|
-
"description": "
|
|
1037
|
+
"summary": "Get Computer File Content",
|
|
1038
|
+
"description": "Download the bytes of one file on a computer, up to 16 MiB, with single-range support.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.",
|
|
891
1039
|
"http": "GET",
|
|
892
1040
|
"path": "/agent/v1/computers/{computer_id}/files/content",
|
|
893
1041
|
"streaming": "no",
|
|
@@ -1602,7 +1750,7 @@ export const operations = [
|
|
|
1602
1750
|
"resource": "agent.environments",
|
|
1603
1751
|
"method": "create",
|
|
1604
1752
|
"summary": "Create environment",
|
|
1605
|
-
"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.",
|
|
1753
|
+
"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.",
|
|
1606
1754
|
"http": "POST",
|
|
1607
1755
|
"path": "/agent/v1/environments",
|
|
1608
1756
|
"streaming": "no",
|
|
@@ -1635,16 +1783,6 @@ export const operations = [
|
|
|
1635
1783
|
"type": "object",
|
|
1636
1784
|
"required": false,
|
|
1637
1785
|
"description": "Free-form string key/value pairs."
|
|
1638
|
-
},
|
|
1639
|
-
{
|
|
1640
|
-
"name": "scope",
|
|
1641
|
-
"type": "string",
|
|
1642
|
-
"enum": [
|
|
1643
|
-
"organization",
|
|
1644
|
-
"account"
|
|
1645
|
-
],
|
|
1646
|
-
"required": false,
|
|
1647
|
-
"description": "The visibility scope for this environment. 'organization' makes the\nenvironment visible to all accounts. 'account' restricts visibility to the\nowning account only. API organizations support only 'organization'; 'account' is\nrejected. If not specified, defaults based on organization type."
|
|
1648
1786
|
}
|
|
1649
1787
|
]
|
|
1650
1788
|
}
|
|
@@ -1670,7 +1808,7 @@ export const operations = [
|
|
|
1670
1808
|
"resource": "agent.environments",
|
|
1671
1809
|
"method": "update",
|
|
1672
1810
|
"summary": "Update environment",
|
|
1673
|
-
"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.",
|
|
1811
|
+
"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.",
|
|
1674
1812
|
"http": "POST",
|
|
1675
1813
|
"path": "/agent/v1/environments/{environment_id}",
|
|
1676
1814
|
"streaming": "no",
|
|
@@ -1708,16 +1846,6 @@ export const operations = [
|
|
|
1708
1846
|
"type": "string",
|
|
1709
1847
|
"required": false,
|
|
1710
1848
|
"description": "Updated name for the environment"
|
|
1711
|
-
},
|
|
1712
|
-
{
|
|
1713
|
-
"name": "scope",
|
|
1714
|
-
"type": "string",
|
|
1715
|
-
"enum": [
|
|
1716
|
-
"organization",
|
|
1717
|
-
"account"
|
|
1718
|
-
],
|
|
1719
|
-
"required": false,
|
|
1720
|
-
"description": "The visibility scope for this environment. 'organization' makes the\nenvironment visible to all accounts. 'account' restricts visibility to the\nowning account only."
|
|
1721
1849
|
}
|
|
1722
1850
|
]
|
|
1723
1851
|
}
|
|
@@ -1726,7 +1854,7 @@ export const operations = [
|
|
|
1726
1854
|
"resource": "agent.environments",
|
|
1727
1855
|
"method": "archive",
|
|
1728
1856
|
"summary": "Archive environment",
|
|
1729
|
-
"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.",
|
|
1857
|
+
"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.",
|
|
1730
1858
|
"http": "POST",
|
|
1731
1859
|
"path": "/agent/v1/environments/{environment_id}/archive",
|
|
1732
1860
|
"streaming": "no",
|
|
@@ -1743,7 +1871,7 @@ export const operations = [
|
|
|
1743
1871
|
"resource": "agent.sessions",
|
|
1744
1872
|
"method": "list",
|
|
1745
1873
|
"summary": "List sessions",
|
|
1746
|
-
"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
|
|
1874
|
+
"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.",
|
|
1747
1875
|
"http": "GET",
|
|
1748
1876
|
"path": "/agent/v1/sessions",
|
|
1749
1877
|
"streaming": "no",
|
|
@@ -1772,7 +1900,7 @@ export const operations = [
|
|
|
1772
1900
|
"name": "created_at[gte]",
|
|
1773
1901
|
"type": "string",
|
|
1774
1902
|
"required": false,
|
|
1775
|
-
"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
|
|
1903
|
+
"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."
|
|
1776
1904
|
},
|
|
1777
1905
|
{
|
|
1778
1906
|
"name": "created_at[lt]",
|
|
@@ -1784,7 +1912,7 @@ export const operations = [
|
|
|
1784
1912
|
"name": "created_at[lte]",
|
|
1785
1913
|
"type": "string",
|
|
1786
1914
|
"required": false,
|
|
1787
|
-
"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
|
|
1915
|
+
"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."
|
|
1788
1916
|
},
|
|
1789
1917
|
{
|
|
1790
1918
|
"name": "deployment_id",
|
|
@@ -1800,7 +1928,7 @@ export const operations = [
|
|
|
1800
1928
|
true
|
|
1801
1929
|
],
|
|
1802
1930
|
"required": false,
|
|
1803
|
-
"description": "
|
|
1931
|
+
"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."
|
|
1804
1932
|
},
|
|
1805
1933
|
{
|
|
1806
1934
|
"name": "memory_store_id",
|
|
@@ -1868,7 +1996,7 @@ export const operations = [
|
|
|
1868
1996
|
"resource": "agent.sessions",
|
|
1869
1997
|
"method": "create",
|
|
1870
1998
|
"summary": "Create session",
|
|
1871
|
-
"description": "Create a session: one conversation with an agent. Pass agent as an agent id
|
|
1999
|
+
"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.",
|
|
1872
2000
|
"http": "POST",
|
|
1873
2001
|
"path": "/agent/v1/sessions",
|
|
1874
2002
|
"streaming": "no",
|
|
@@ -1882,19 +2010,19 @@ export const operations = [
|
|
|
1882
2010
|
"name": "agent",
|
|
1883
2011
|
"type": "object",
|
|
1884
2012
|
"required": true,
|
|
1885
|
-
"description": "
|
|
2013
|
+
"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."
|
|
1886
2014
|
},
|
|
1887
2015
|
{
|
|
1888
2016
|
"name": "environment_id",
|
|
1889
2017
|
"type": "string",
|
|
1890
2018
|
"required": false,
|
|
1891
|
-
"description": "Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission
|
|
2019
|
+
"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."
|
|
1892
2020
|
},
|
|
1893
2021
|
{
|
|
1894
2022
|
"name": "budget",
|
|
1895
2023
|
"type": "object",
|
|
1896
2024
|
"required": false,
|
|
1897
|
-
"description": "Session spending limit
|
|
2025
|
+
"description": "Session spending limit, {type: \"limit\", max_list_cost: {amount, currency}}; null when unlimited. Creation defaults to a limit of 2000 US cents (USD 20.00) when omitted. amount is a positive integer string of US cents; removing the limit with null prevents setting it again for that session."
|
|
1898
2026
|
},
|
|
1899
2027
|
{
|
|
1900
2028
|
"name": "initial_events",
|
|
@@ -2015,12 +2143,6 @@ export const operations = [
|
|
|
2015
2143
|
"body": {
|
|
2016
2144
|
"required": true,
|
|
2017
2145
|
"fields": [
|
|
2018
|
-
{
|
|
2019
|
-
"name": "agent",
|
|
2020
|
-
"type": "object",
|
|
2021
|
-
"required": false,
|
|
2022
|
-
"description": "Agent definition the session uses after the change; null when unchanged."
|
|
2023
|
-
},
|
|
2024
2146
|
{
|
|
2025
2147
|
"name": "budget",
|
|
2026
2148
|
"type": "object",
|
|
@@ -2754,6 +2876,225 @@ export const operations = [
|
|
|
2754
2876
|
}
|
|
2755
2877
|
]
|
|
2756
2878
|
},
|
|
2879
|
+
{
|
|
2880
|
+
"resource": "agent.skills",
|
|
2881
|
+
"method": "list",
|
|
2882
|
+
"summary": "List skills",
|
|
2883
|
+
"description": "List the skills uploaded to your organization, newest first, in pages of at most 100 (default 20). Use it to find a skill id before reading, versioning or deleting it. Only source=custom has content; source=anthropic returns an empty list. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
2884
|
+
"http": "GET",
|
|
2885
|
+
"path": "/agent/v1/skills",
|
|
2886
|
+
"streaming": "no",
|
|
2887
|
+
"pagination": false,
|
|
2888
|
+
"pathParams": [],
|
|
2889
|
+
"query": [
|
|
2890
|
+
{
|
|
2891
|
+
"name": "source",
|
|
2892
|
+
"type": "string",
|
|
2893
|
+
"required": false,
|
|
2894
|
+
"description": "Filter skills by source.\n\nIf provided, only skills from the specified source will be returned:\n\n- `\"custom\"`: only return user-created skills\n- `\"anthropic\"`: only return Anthropic-created skills"
|
|
2895
|
+
},
|
|
2896
|
+
{
|
|
2897
|
+
"name": "limit",
|
|
2898
|
+
"type": "number",
|
|
2899
|
+
"required": false,
|
|
2900
|
+
"description": "Number of items per page."
|
|
2901
|
+
},
|
|
2902
|
+
{
|
|
2903
|
+
"name": "page",
|
|
2904
|
+
"type": "string",
|
|
2905
|
+
"required": false,
|
|
2906
|
+
"description": "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400."
|
|
2907
|
+
}
|
|
2908
|
+
]
|
|
2909
|
+
},
|
|
2910
|
+
{
|
|
2911
|
+
"resource": "agent.skills",
|
|
2912
|
+
"method": "create",
|
|
2913
|
+
"summary": "Create skill",
|
|
2914
|
+
"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.",
|
|
2915
|
+
"http": "POST",
|
|
2916
|
+
"path": "/agent/v1/skills",
|
|
2917
|
+
"streaming": "no",
|
|
2918
|
+
"pagination": false,
|
|
2919
|
+
"multipart": true,
|
|
2920
|
+
"pathParams": [],
|
|
2921
|
+
"query": [],
|
|
2922
|
+
"body": {
|
|
2923
|
+
"required": true,
|
|
2924
|
+
"fields": [
|
|
2925
|
+
{
|
|
2926
|
+
"name": "files",
|
|
2927
|
+
"type": "array",
|
|
2928
|
+
"itemType": "string",
|
|
2929
|
+
"required": true,
|
|
2930
|
+
"description": "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory."
|
|
2931
|
+
},
|
|
2932
|
+
{
|
|
2933
|
+
"name": "display_name",
|
|
2934
|
+
"type": "string",
|
|
2935
|
+
"required": false,
|
|
2936
|
+
"description": "Human-readable, single-line label for the Skill. Maximum 255\ncharacters. Always set: derived from the SKILL.md frontmatter `name` when\nomitted at creation. Not unique."
|
|
2937
|
+
}
|
|
2938
|
+
]
|
|
2939
|
+
}
|
|
2940
|
+
},
|
|
2941
|
+
{
|
|
2942
|
+
"resource": "agent.skills",
|
|
2943
|
+
"method": "delete",
|
|
2944
|
+
"summary": "Delete skill",
|
|
2945
|
+
"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.",
|
|
2946
|
+
"http": "DELETE",
|
|
2947
|
+
"path": "/agent/v1/skills/{skill_id}",
|
|
2948
|
+
"streaming": "no",
|
|
2949
|
+
"pagination": false,
|
|
2950
|
+
"pathParams": [
|
|
2951
|
+
{
|
|
2952
|
+
"name": "skill_id",
|
|
2953
|
+
"sdkName": "skill_id"
|
|
2954
|
+
}
|
|
2955
|
+
],
|
|
2956
|
+
"query": []
|
|
2957
|
+
},
|
|
2958
|
+
{
|
|
2959
|
+
"resource": "agent.skills",
|
|
2960
|
+
"method": "retrieve",
|
|
2961
|
+
"summary": "Get skill",
|
|
2962
|
+
"description": "Read one skill by id: its display_name, source and latest_version_id. skill_id comes from skills.create or skills.list. A skill of another organization, or a deleted one, returns 404 Skill not found.",
|
|
2963
|
+
"http": "GET",
|
|
2964
|
+
"path": "/agent/v1/skills/{skill_id}",
|
|
2965
|
+
"streaming": "no",
|
|
2966
|
+
"pagination": false,
|
|
2967
|
+
"pathParams": [
|
|
2968
|
+
{
|
|
2969
|
+
"name": "skill_id",
|
|
2970
|
+
"sdkName": "skill_id"
|
|
2971
|
+
}
|
|
2972
|
+
],
|
|
2973
|
+
"query": []
|
|
2974
|
+
},
|
|
2975
|
+
{
|
|
2976
|
+
"resource": "agent.skills.versions",
|
|
2977
|
+
"method": "list",
|
|
2978
|
+
"summary": "List skill versions",
|
|
2979
|
+
"description": "List the live versions of one skill, newest first, in pages of at most 100 (default 20). Each item carries the name and description read from the SKILL.md of that version. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
2980
|
+
"http": "GET",
|
|
2981
|
+
"path": "/agent/v1/skills/{skill_id}/versions",
|
|
2982
|
+
"streaming": "no",
|
|
2983
|
+
"pagination": false,
|
|
2984
|
+
"pathParams": [
|
|
2985
|
+
{
|
|
2986
|
+
"name": "skill_id",
|
|
2987
|
+
"sdkName": "skill_id"
|
|
2988
|
+
}
|
|
2989
|
+
],
|
|
2990
|
+
"query": [
|
|
2991
|
+
{
|
|
2992
|
+
"name": "limit",
|
|
2993
|
+
"type": "number",
|
|
2994
|
+
"required": false,
|
|
2995
|
+
"description": "Number of items per page."
|
|
2996
|
+
},
|
|
2997
|
+
{
|
|
2998
|
+
"name": "page",
|
|
2999
|
+
"type": "string",
|
|
3000
|
+
"required": false,
|
|
3001
|
+
"description": "Opaque pagination cursor: pass the next_page value of the previous response unchanged. Omit it for the first page. A cursor from a different query or a malformed one returns 400."
|
|
3002
|
+
}
|
|
3003
|
+
]
|
|
3004
|
+
},
|
|
3005
|
+
{
|
|
3006
|
+
"resource": "agent.skills.versions",
|
|
3007
|
+
"method": "create",
|
|
3008
|
+
"summary": "Create skill version",
|
|
3009
|
+
"description": "Upload a new version of a skill with the same multipart/form-data shape and limits as skills.create (8 MB, 200 files, one top-level directory containing SKILL.md). The SKILL.md name must equal the name of the skill; a different name returns 400. The new version becomes latest_version_id of the skill, and earlier versions stay unchanged because versions are immutable. Attach it to an agent with `skills` on the agent.",
|
|
3010
|
+
"http": "POST",
|
|
3011
|
+
"path": "/agent/v1/skills/{skill_id}/versions",
|
|
3012
|
+
"streaming": "no",
|
|
3013
|
+
"pagination": false,
|
|
3014
|
+
"multipart": true,
|
|
3015
|
+
"pathParams": [
|
|
3016
|
+
{
|
|
3017
|
+
"name": "skill_id",
|
|
3018
|
+
"sdkName": "skill_id"
|
|
3019
|
+
}
|
|
3020
|
+
],
|
|
3021
|
+
"query": [],
|
|
3022
|
+
"body": {
|
|
3023
|
+
"required": true,
|
|
3024
|
+
"fields": [
|
|
3025
|
+
{
|
|
3026
|
+
"name": "files",
|
|
3027
|
+
"type": "array",
|
|
3028
|
+
"itemType": "string",
|
|
3029
|
+
"required": true,
|
|
3030
|
+
"description": "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory."
|
|
3031
|
+
}
|
|
3032
|
+
]
|
|
3033
|
+
}
|
|
3034
|
+
},
|
|
3035
|
+
{
|
|
3036
|
+
"resource": "agent.skills.versions",
|
|
3037
|
+
"method": "delete",
|
|
3038
|
+
"summary": "Delete skill version",
|
|
3039
|
+
"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.",
|
|
3040
|
+
"http": "DELETE",
|
|
3041
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}",
|
|
3042
|
+
"streaming": "no",
|
|
3043
|
+
"pagination": false,
|
|
3044
|
+
"pathParams": [
|
|
3045
|
+
{
|
|
3046
|
+
"name": "skill_id",
|
|
3047
|
+
"sdkName": "skill_id"
|
|
3048
|
+
},
|
|
3049
|
+
{
|
|
3050
|
+
"name": "version",
|
|
3051
|
+
"sdkName": "version"
|
|
3052
|
+
}
|
|
3053
|
+
],
|
|
3054
|
+
"query": []
|
|
3055
|
+
},
|
|
3056
|
+
{
|
|
3057
|
+
"resource": "agent.skills.versions",
|
|
3058
|
+
"method": "retrieve",
|
|
3059
|
+
"summary": "Get skill version",
|
|
3060
|
+
"description": "Read one version of a skill: its name, description and created_at as read from SKILL.md. version is the id returned by skills.versions.create or skills.versions.list. A deleted or unknown version returns 404 Skill version not found.",
|
|
3061
|
+
"http": "GET",
|
|
3062
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}",
|
|
3063
|
+
"streaming": "no",
|
|
3064
|
+
"pagination": false,
|
|
3065
|
+
"pathParams": [
|
|
3066
|
+
{
|
|
3067
|
+
"name": "skill_id",
|
|
3068
|
+
"sdkName": "skill_id"
|
|
3069
|
+
},
|
|
3070
|
+
{
|
|
3071
|
+
"name": "version",
|
|
3072
|
+
"sdkName": "version"
|
|
3073
|
+
}
|
|
3074
|
+
],
|
|
3075
|
+
"query": []
|
|
3076
|
+
},
|
|
3077
|
+
{
|
|
3078
|
+
"resource": "agent.skills.versions",
|
|
3079
|
+
"method": "retrieveContent",
|
|
3080
|
+
"summary": "Download skill version",
|
|
3081
|
+
"description": "Download the content of one version as a zip archive (application/zip): the uploaded directory with its top-level folder and every file. version is the id returned by skills.versions.create or skills.versions.list; a deleted version returns 404.",
|
|
3082
|
+
"http": "GET",
|
|
3083
|
+
"path": "/agent/v1/skills/{skill_id}/versions/{version}/content",
|
|
3084
|
+
"streaming": "no",
|
|
3085
|
+
"pagination": false,
|
|
3086
|
+
"pathParams": [
|
|
3087
|
+
{
|
|
3088
|
+
"name": "skill_id",
|
|
3089
|
+
"sdkName": "skill_id"
|
|
3090
|
+
},
|
|
3091
|
+
{
|
|
3092
|
+
"name": "version",
|
|
3093
|
+
"sdkName": "version"
|
|
3094
|
+
}
|
|
3095
|
+
],
|
|
3096
|
+
"query": []
|
|
3097
|
+
},
|
|
2757
3098
|
{
|
|
2758
3099
|
"resource": "agent.toolsets",
|
|
2759
3100
|
"method": "list",
|