@deepraxis/sdk 0.1.1-dev.d775f1e → 0.1.1-dev.ea219e1
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 +19 -1
- package/README.md +1 -1
- package/dist/automation.d.ts +7 -0
- package/dist/core/client.d.ts +5 -1
- package/dist/core/client.js +10 -0
- package/dist/core/transport.js +1 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +59 -17
- package/dist/generated/sdk.gen.js +131 -16
- package/dist/generated/types.gen.d.ts +1686 -210
- package/dist/helpers/application-build.d.ts +10 -0
- package/dist/helpers/application-build.js +98 -0
- package/dist/helpers/application-publish.d.ts +8 -0
- package/dist/helpers/application-publish.js +26 -9
- package/dist/helpers/browser-connect.d.ts +78 -0
- package/dist/helpers/browser-connect.js +161 -0
- package/dist/helpers/browser-decisions.d.ts +44 -0
- package/dist/helpers/browser-decisions.js +84 -0
- package/dist/helpers/browser-documentation.d.ts +2 -0
- package/dist/helpers/browser-documentation.js +47 -0
- package/dist/helpers/file-upload.d.ts +2 -2
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +220 -40
- package/dist/operations.generated.js +270 -39
- package/dist/resources.generated.d.ts +112 -22
- package/dist/resources.generated.js +11 -0
- package/package.json +1 -1
|
@@ -4,7 +4,7 @@ export const operations = [
|
|
|
4
4
|
"resource": "agent.agents",
|
|
5
5
|
"method": "list",
|
|
6
6
|
"summary": "List agents",
|
|
7
|
-
"description": "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=service for per-session environments. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
7
|
+
"description": "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=general or kind=personal for durable-computer agents or kind=service for per-session environments. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
8
8
|
"http": "GET",
|
|
9
9
|
"path": "/agent/v1/agents",
|
|
10
10
|
"streaming": "no",
|
|
@@ -49,6 +49,7 @@ export const operations = [
|
|
|
49
49
|
"name": "kind",
|
|
50
50
|
"type": "string",
|
|
51
51
|
"enum": [
|
|
52
|
+
"general",
|
|
52
53
|
"personal",
|
|
53
54
|
"service"
|
|
54
55
|
],
|
|
@@ -133,17 +134,18 @@ export const operations = [
|
|
|
133
134
|
"type": "array",
|
|
134
135
|
"itemType": "object",
|
|
135
136
|
"required": false,
|
|
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. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
|
|
137
|
+
"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; general and personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time."
|
|
137
138
|
},
|
|
138
139
|
{
|
|
139
140
|
"name": "kind",
|
|
140
141
|
"type": "string",
|
|
141
142
|
"enum": [
|
|
143
|
+
"general",
|
|
142
144
|
"personal",
|
|
143
145
|
"service"
|
|
144
146
|
],
|
|
145
147
|
"required": false,
|
|
146
|
-
"description": "Immutable agent kind. personal
|
|
148
|
+
"description": "Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error."
|
|
147
149
|
},
|
|
148
150
|
{
|
|
149
151
|
"name": "computer_id",
|
|
@@ -193,7 +195,7 @@ export const operations = [
|
|
|
193
195
|
"name": "avatar",
|
|
194
196
|
"type": "string",
|
|
195
197
|
"required": false,
|
|
196
|
-
"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.
|
|
198
|
+
"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. General, personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
197
199
|
},
|
|
198
200
|
{
|
|
199
201
|
"name": "environment_id",
|
|
@@ -353,11 +355,12 @@ export const operations = [
|
|
|
353
355
|
"name": "kind",
|
|
354
356
|
"type": "string",
|
|
355
357
|
"enum": [
|
|
358
|
+
"general",
|
|
356
359
|
"personal",
|
|
357
360
|
"service"
|
|
358
361
|
],
|
|
359
362
|
"required": false,
|
|
360
|
-
"description": "Immutable agent kind. personal
|
|
363
|
+
"description": "Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error."
|
|
361
364
|
},
|
|
362
365
|
{
|
|
363
366
|
"name": "computer_id",
|
|
@@ -407,7 +410,7 @@ export const operations = [
|
|
|
407
410
|
"name": "avatar",
|
|
408
411
|
"type": "string",
|
|
409
412
|
"required": false,
|
|
410
|
-
"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.
|
|
413
|
+
"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. General, personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it."
|
|
411
414
|
},
|
|
412
415
|
{
|
|
413
416
|
"name": "environment_id",
|
|
@@ -920,7 +923,7 @@ export const operations = [
|
|
|
920
923
|
"resource": "agent.computers",
|
|
921
924
|
"method": "create",
|
|
922
925
|
"summary": "Create Computer",
|
|
923
|
-
"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.",
|
|
926
|
+
"description": "Create a durable computer: a named machine whose files outlive sessions, for general and 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.",
|
|
924
927
|
"http": "POST",
|
|
925
928
|
"path": "/agent/v1/computers",
|
|
926
929
|
"streaming": "no",
|
|
@@ -1346,7 +1349,7 @@ export const operations = [
|
|
|
1346
1349
|
"resource": "agent.deployments",
|
|
1347
1350
|
"method": "create",
|
|
1348
1351
|
"summary": "Create deployment",
|
|
1349
|
-
"description": "Freeze session parameters as a deployment; this operation does not open a session. Pass an agent id or versioned reference, a name, 1–50 user.message initial events and an environment_id from environments.list. Unlike Anthropic Managed Agents, /agent/v1 also accepts agent_with_overrides (model, permission_mode and cwd) and target=computer for personal agents, with environment_id omitted. Cron schedules use five POSIX fields and an IANA timezone. File resources are accepted. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Active schedules run every minute when due; session creation errors pause the deployment. Unsupported tools, mcp_servers, system and skills overrides return 400.",
|
|
1352
|
+
"description": "Freeze session parameters as a deployment; this operation does not open a session. Pass an agent id or versioned reference, a name, 1–50 user.message initial events and an environment_id from environments.list. Unlike Anthropic Managed Agents, /agent/v1 also accepts agent_with_overrides (model, permission_mode and cwd) and target=computer for general and personal agents, with environment_id omitted. Cron schedules use five POSIX fields and an IANA timezone. File resources are accepted. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Active schedules run every minute when due; session creation errors pause the deployment. Unsupported tools, mcp_servers, system and skills overrides return 400.",
|
|
1350
1353
|
"http": "POST",
|
|
1351
1354
|
"path": "/agent/v1/deployments",
|
|
1352
1355
|
"streaming": "no",
|
|
@@ -1423,7 +1426,7 @@ export const operations = [
|
|
|
1423
1426
|
"name": "target",
|
|
1424
1427
|
"type": "object",
|
|
1425
1428
|
"required": false,
|
|
1426
|
-
"description": "Execution target. environment (default) requires an existing, unarchived environment_id. computer is available only for personal agents and permits environment_id to be omitted."
|
|
1429
|
+
"description": "Execution target. environment (default) requires an existing, unarchived environment_id. computer is available only for general and personal agents and permits environment_id to be omitted."
|
|
1427
1430
|
}
|
|
1428
1431
|
]
|
|
1429
1432
|
}
|
|
@@ -1533,7 +1536,7 @@ export const operations = [
|
|
|
1533
1536
|
"name": "target",
|
|
1534
1537
|
"type": "object",
|
|
1535
1538
|
"required": false,
|
|
1536
|
-
"description": "Execution target. environment (default) requires an existing, unarchived environment_id. computer is available only for personal agents and permits environment_id to be omitted."
|
|
1539
|
+
"description": "Execution target. environment (default) requires an existing, unarchived environment_id. computer is available only for general and personal agents and permits environment_id to be omitted."
|
|
1537
1540
|
}
|
|
1538
1541
|
]
|
|
1539
1542
|
}
|
|
@@ -1898,7 +1901,7 @@ export const operations = [
|
|
|
1898
1901
|
"resource": "agent.sessions",
|
|
1899
1902
|
"method": "create",
|
|
1900
1903
|
"summary": "Create session",
|
|
1901
|
-
"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
|
|
1904
|
+
"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 decimal string of US dollars with at most 2 decimal places (\"20.00\" is USD 20.00); omitted budget defaults to \"20.00\" 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.",
|
|
1902
1905
|
"http": "POST",
|
|
1903
1906
|
"path": "/agent/v1/sessions",
|
|
1904
1907
|
"streaming": "no",
|
|
@@ -2187,7 +2190,7 @@ export const operations = [
|
|
|
2187
2190
|
"resource": "agent.sessions",
|
|
2188
2191
|
"method": "compact",
|
|
2189
2192
|
"summary": "Compact Session (Extension)",
|
|
2190
|
-
"description": "Request session context compaction and retrieve an operation receipt.\n\nAvailable only on /agent/v1. The body may be omitted or {}. Optional instructions must be a string and is forwarded unchanged. Idempotency-Key is forwarded unchanged; a UUID is generated when absent. Returns { type: session_compaction, id, status, reason? }, where id is the operation ID. queued/running return 202; skipped/succeeded/failed return 200. Non-string instructions return 400 invalid_request_error. Missing or inaccessible managed sessions return 404 not_found_error.",
|
|
2193
|
+
"description": "Request session context compaction and retrieve an operation receipt.\n\nAvailable only on /agent/v1. The body may be omitted or {}. Optional instructions must be a string and is forwarded unchanged. Idempotency-Key is forwarded unchanged; a UUID is generated when absent. Returns { type: session_compaction, id, status, reason? }, where id is the operation ID. queued/running return 202; skipped/succeeded/failed/cancelled return 200. Non-string instructions return 400 invalid_request_error. Missing or inaccessible managed sessions return 404 not_found_error.",
|
|
2191
2194
|
"http": "POST",
|
|
2192
2195
|
"path": "/agent/v1/sessions/{session_id}/compact",
|
|
2193
2196
|
"streaming": "no",
|
|
@@ -2239,7 +2242,7 @@ export const operations = [
|
|
|
2239
2242
|
"resource": "agent.sessions.compactions",
|
|
2240
2243
|
"method": "list",
|
|
2241
2244
|
"summary": "List Session Compactions (Extension)",
|
|
2242
|
-
"description": "Read session compaction history and summaries.\n\nAvailable only on /agent/v1. Returns { data: [...] }. Each entry contains type, id, event_id, trigger, status, model, compacted_message_count, input_tokens_before, input_tokens_after, summary, error and created_at, as recorded by the service. Missing or inaccessible managed sessions return 404 not_found_error.",
|
|
2245
|
+
"description": "Read session compaction history and summaries.\n\nAvailable only on /agent/v1. Returns { data: [...], active }. active is the queued or running compaction ({ type: session_compaction, id, status, trigger: manual|auto|idle }), or null when none; manual work takes precedence. Each data entry contains type, id, event_id, trigger, status, model, compacted_message_count, input_tokens_before, input_tokens_after, summary, error and created_at, as recorded by the service. Missing or inaccessible managed sessions return 404 not_found_error.",
|
|
2243
2246
|
"http": "GET",
|
|
2244
2247
|
"path": "/agent/v1/sessions/{session_id}/compactions",
|
|
2245
2248
|
"streaming": "no",
|
|
@@ -2451,9 +2454,9 @@ export const operations = [
|
|
|
2451
2454
|
"query": [
|
|
2452
2455
|
{
|
|
2453
2456
|
"name": "limit",
|
|
2454
|
-
"type": "
|
|
2457
|
+
"type": "integer",
|
|
2455
2458
|
"required": false,
|
|
2456
|
-
"description": "Number of
|
|
2459
|
+
"description": "Number of resources per page, from 1 to 100; defaults to 100."
|
|
2457
2460
|
},
|
|
2458
2461
|
{
|
|
2459
2462
|
"name": "page",
|
|
@@ -3813,7 +3816,7 @@ export const operations = [
|
|
|
3813
3816
|
"resource": "automation.actions",
|
|
3814
3817
|
"method": "list",
|
|
3815
3818
|
"summary": "List actions",
|
|
3816
|
-
"description": "Discover callable Actions and their ns/name references without executing them. Combine each returned namespace and name as ns/name; Action calls use the current revision and do not accept @version or @tag. Filter by name or description; results include seven-day statistics and revision summaries without implementation source. Archived actions are excluded by default.",
|
|
3819
|
+
"description": "Discover callable Actions and their ns/name references without executing them. Combine each returned namespace and name as ns/name; Action calls use the current revision and do not accept @version or @tag. Filter by name or description; results include seven-day statistics and revision summaries without implementation source. Archived actions are excluded by default. List items carry no input contract: get the action and read current_revision.input_schema. Call it with call(\"ns/name\", input) in a script or call: ns/name with with: in a workflow.",
|
|
3817
3820
|
"http": "GET",
|
|
3818
3821
|
"path": "/automation/v1/actions",
|
|
3819
3822
|
"streaming": "no",
|
|
@@ -3982,7 +3985,7 @@ export const operations = [
|
|
|
3982
3985
|
"resource": "automation.actions",
|
|
3983
3986
|
"method": "retrieve",
|
|
3984
3987
|
"summary": "Get an Action with its current input and output JSON Schemas",
|
|
3985
|
-
"description": "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input). The response ETag is the current revision ID for conditional updates.",
|
|
3988
|
+
"description": "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input) or in a workflow step with call: ocr and with:. Input that breaks the contract returns INPUT_INVALID, with the fields in errors[]. The response ETag is the current revision ID for conditional updates.",
|
|
3986
3989
|
"http": "GET",
|
|
3987
3990
|
"path": "/automation/v1/actions/{ns}/{name}",
|
|
3988
3991
|
"streaming": "no",
|
|
@@ -4398,6 +4401,177 @@ export const operations = [
|
|
|
4398
4401
|
"fields": []
|
|
4399
4402
|
}
|
|
4400
4403
|
},
|
|
4404
|
+
{
|
|
4405
|
+
"resource": "automation.humanTasks",
|
|
4406
|
+
"method": "list",
|
|
4407
|
+
"summary": "List human tasks",
|
|
4408
|
+
"description": "List the human tasks that praxis/approval workflow steps opened, newest first. By default it returns only open tasks assigned to the caller: their approval inbox. scope=all lists every task of the organization, and status and run_id narrow the list. Use a returned id with retrieve for details and respond to decide. Read-only: listing never changes a task.",
|
|
4409
|
+
"http": "GET",
|
|
4410
|
+
"path": "/automation/v1/human-tasks",
|
|
4411
|
+
"streaming": "no",
|
|
4412
|
+
"pagination": true,
|
|
4413
|
+
"pathParams": [],
|
|
4414
|
+
"query": [
|
|
4415
|
+
{
|
|
4416
|
+
"name": "limit",
|
|
4417
|
+
"type": "integer",
|
|
4418
|
+
"required": false,
|
|
4419
|
+
"description": "Page size, 1–100, default 50."
|
|
4420
|
+
},
|
|
4421
|
+
{
|
|
4422
|
+
"name": "cursor",
|
|
4423
|
+
"type": "string",
|
|
4424
|
+
"required": false,
|
|
4425
|
+
"description": "The next_cursor of the previous page; omit for the first page."
|
|
4426
|
+
},
|
|
4427
|
+
{
|
|
4428
|
+
"name": "status",
|
|
4429
|
+
"type": "array",
|
|
4430
|
+
"itemType": "string",
|
|
4431
|
+
"enum": [
|
|
4432
|
+
"open",
|
|
4433
|
+
"completed",
|
|
4434
|
+
"expired",
|
|
4435
|
+
"cancelled"
|
|
4436
|
+
],
|
|
4437
|
+
"required": false,
|
|
4438
|
+
"description": "Filter by status, comma-separated: open, completed, expired, cancelled. Defaults to open."
|
|
4439
|
+
},
|
|
4440
|
+
{
|
|
4441
|
+
"name": "run_id",
|
|
4442
|
+
"type": "string",
|
|
4443
|
+
"required": false,
|
|
4444
|
+
"description": "Only tasks opened by this run (run_)."
|
|
4445
|
+
},
|
|
4446
|
+
{
|
|
4447
|
+
"name": "scope",
|
|
4448
|
+
"type": "string",
|
|
4449
|
+
"enum": [
|
|
4450
|
+
"assigned",
|
|
4451
|
+
"all"
|
|
4452
|
+
],
|
|
4453
|
+
"required": false,
|
|
4454
|
+
"description": "assigned (default) lists only tasks assigned to the caller; all lists every task of the organization."
|
|
4455
|
+
}
|
|
4456
|
+
]
|
|
4457
|
+
},
|
|
4458
|
+
{
|
|
4459
|
+
"resource": "automation.humanTasks",
|
|
4460
|
+
"method": "retrieve",
|
|
4461
|
+
"summary": "Retrieve a human task",
|
|
4462
|
+
"description": "Read one human task - title, Markdown body, context, actions, form, assignees, mode, due time, responses and outcome - so an assignee can choose an action and fill the form. Read-only; the Console approval page /automation/tasks/{id} reads the same resource.",
|
|
4463
|
+
"http": "GET",
|
|
4464
|
+
"path": "/automation/v1/human-tasks/{id}",
|
|
4465
|
+
"streaming": "no",
|
|
4466
|
+
"pagination": false,
|
|
4467
|
+
"pathParams": [
|
|
4468
|
+
{
|
|
4469
|
+
"name": "id",
|
|
4470
|
+
"sdkName": "id",
|
|
4471
|
+
"description": "Human task ID (htask_), from the list or the run's waits."
|
|
4472
|
+
}
|
|
4473
|
+
],
|
|
4474
|
+
"query": []
|
|
4475
|
+
},
|
|
4476
|
+
{
|
|
4477
|
+
"resource": "automation.humanTasks",
|
|
4478
|
+
"method": "cancel",
|
|
4479
|
+
"summary": "Cancel a human task",
|
|
4480
|
+
"description": "Cancel an open human task; only the person who started the run or an organization API key may cancel. The task becomes cancelled and the waiting workflow step raises a runtime error with code HUMAN_TASK_CANCELLED, which try/catch can catch. Open tasks are cancelled automatically when their run ends, so this call is not needed then.",
|
|
4481
|
+
"http": "POST",
|
|
4482
|
+
"path": "/automation/v1/human-tasks/{id}/cancel",
|
|
4483
|
+
"streaming": "no",
|
|
4484
|
+
"pagination": false,
|
|
4485
|
+
"pathParams": [
|
|
4486
|
+
{
|
|
4487
|
+
"name": "id",
|
|
4488
|
+
"sdkName": "id",
|
|
4489
|
+
"description": "Human task ID (htask_)."
|
|
4490
|
+
}
|
|
4491
|
+
],
|
|
4492
|
+
"query": [],
|
|
4493
|
+
"body": {
|
|
4494
|
+
"required": false,
|
|
4495
|
+
"fields": [
|
|
4496
|
+
{
|
|
4497
|
+
"name": "reason",
|
|
4498
|
+
"type": "string",
|
|
4499
|
+
"required": false,
|
|
4500
|
+
"description": "Optional cancellation reason, at most 500 characters."
|
|
4501
|
+
}
|
|
4502
|
+
]
|
|
4503
|
+
}
|
|
4504
|
+
},
|
|
4505
|
+
{
|
|
4506
|
+
"resource": "automation.humanTasks",
|
|
4507
|
+
"method": "delegate",
|
|
4508
|
+
"summary": "Delegate a human task",
|
|
4509
|
+
"description": "An assignee who has not responded hands their place to another user (to_user), replacing their entry in assignees.users in place, so sequential order is kept. The new user cannot already be an assignee, nor the initiator unless self-approval is allowed. The task must still be open.",
|
|
4510
|
+
"http": "POST",
|
|
4511
|
+
"path": "/automation/v1/human-tasks/{id}/delegate",
|
|
4512
|
+
"streaming": "no",
|
|
4513
|
+
"pagination": false,
|
|
4514
|
+
"pathParams": [
|
|
4515
|
+
{
|
|
4516
|
+
"name": "id",
|
|
4517
|
+
"sdkName": "id",
|
|
4518
|
+
"description": "Human task ID (htask_)."
|
|
4519
|
+
}
|
|
4520
|
+
],
|
|
4521
|
+
"query": [],
|
|
4522
|
+
"body": {
|
|
4523
|
+
"required": true,
|
|
4524
|
+
"fields": [
|
|
4525
|
+
{
|
|
4526
|
+
"name": "to_user",
|
|
4527
|
+
"type": "string",
|
|
4528
|
+
"required": true,
|
|
4529
|
+
"description": "User ID taking over; cannot already be an assignee, nor the initiator unless self-approval is allowed."
|
|
4530
|
+
}
|
|
4531
|
+
]
|
|
4532
|
+
}
|
|
4533
|
+
},
|
|
4534
|
+
{
|
|
4535
|
+
"resource": "automation.humanTasks",
|
|
4536
|
+
"method": "respond",
|
|
4537
|
+
"summary": "Respond to a human task",
|
|
4538
|
+
"description": "Submit an action (action_id), form values (values) and a comment as the calling user. Depending on the task's mode the response either decides it (status becomes completed, outcome is set, and the waiting workflow resumes with outcome as the step output) or is recorded while other assignees are awaited. When two assignees respond at once, exactly one decides and the other gets TASK_CLOSED. An agent may respond only if the workflow set allow_agent_decision. Send an Idempotency-Key to retry safely.",
|
|
4539
|
+
"http": "POST",
|
|
4540
|
+
"path": "/automation/v1/human-tasks/{id}/respond",
|
|
4541
|
+
"streaming": "no",
|
|
4542
|
+
"pagination": false,
|
|
4543
|
+
"pathParams": [
|
|
4544
|
+
{
|
|
4545
|
+
"name": "id",
|
|
4546
|
+
"sdkName": "id",
|
|
4547
|
+
"description": "Human task ID (htask_)."
|
|
4548
|
+
}
|
|
4549
|
+
],
|
|
4550
|
+
"query": [],
|
|
4551
|
+
"body": {
|
|
4552
|
+
"required": true,
|
|
4553
|
+
"fields": [
|
|
4554
|
+
{
|
|
4555
|
+
"name": "action_id",
|
|
4556
|
+
"type": "string",
|
|
4557
|
+
"required": true,
|
|
4558
|
+
"description": "The chosen action ID from the task's actions, for example approve."
|
|
4559
|
+
},
|
|
4560
|
+
{
|
|
4561
|
+
"name": "values",
|
|
4562
|
+
"type": "object",
|
|
4563
|
+
"required": false,
|
|
4564
|
+
"description": "Any JSON object whose keys are strings and whose values are any JSON value."
|
|
4565
|
+
},
|
|
4566
|
+
{
|
|
4567
|
+
"name": "comment",
|
|
4568
|
+
"type": "string",
|
|
4569
|
+
"required": false,
|
|
4570
|
+
"description": "Comment of at most 4000 characters; required when the action has require_comment true."
|
|
4571
|
+
}
|
|
4572
|
+
]
|
|
4573
|
+
}
|
|
4574
|
+
},
|
|
4401
4575
|
{
|
|
4402
4576
|
"resource": "automation.resolve",
|
|
4403
4577
|
"method": "retrieve",
|
|
@@ -4578,7 +4752,7 @@ export const operations = [
|
|
|
4578
4752
|
"resource": "automation.runs",
|
|
4579
4753
|
"method": "create",
|
|
4580
4754
|
"summary": "Run a published target or execute draft source",
|
|
4581
|
-
"description": "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to
|
|
4755
|
+
"description": "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 30 days. Each run can start at most 100 child runs, with at most 20 active at once; nesting depth is limited to 10. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. With language=yaml, source is a workflow YAML: the run input is . in the first step, and the shape is described in create workflow. Error details are in errors[] (pointer, detail, hint). New non-deterministic run IDs contain 78 characters, compared with 46 for legacy random IDs; treat IDs as opaque strings. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed.",
|
|
4582
4756
|
"http": "POST",
|
|
4583
4757
|
"path": "/automation/v1/runs",
|
|
4584
4758
|
"streaming": "no",
|
|
@@ -5070,7 +5244,7 @@ export const operations = [
|
|
|
5070
5244
|
"resource": "automation.scripts",
|
|
5071
5245
|
"method": "create",
|
|
5072
5246
|
"summary": "Create a script",
|
|
5073
|
-
"description": "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.",
|
|
5247
|
+
"description": "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. The return value is limited to 1 MiB: write large results to a file with call(\"write-file\", ...) and return the file ID. A call error carries errors[] (pointer, detail, hint); String(e) is only the summary. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.",
|
|
5074
5248
|
"http": "POST",
|
|
5075
5249
|
"path": "/automation/v1/scripts",
|
|
5076
5250
|
"streaming": "no",
|
|
@@ -6019,7 +6193,7 @@ export const operations = [
|
|
|
6019
6193
|
"resource": "automation.validate",
|
|
6020
6194
|
"method": "create",
|
|
6021
6195
|
"summary": "Validate a definition",
|
|
6022
|
-
"description": "Check source without executing it when you need diagnostics, inferred schemas or references. This is optional before praxis.automation.runs.create, which also validates source before execution. Actions, scripts and workflows are supported; results include validity without saving. Invalid source is reported with valid=false. Script/action output schemas are inferred from return types: Promise unwrapping, Record, intersections and Date. Unknown types yield an empty schema and a warning in warnings. Source diagnostics use /source or /implementation/source with 1-based line/column. For kind=action the same admission checks as action creation apply (no external imports, platform operations only as direct call(praxis/<api>.<op>, input) calls, no agent or automation calls), so source that validates is not rejected at creation.",
|
|
6196
|
+
"description": "Check source without executing it when you need diagnostics, inferred schemas or references. This is optional before praxis.automation.runs.create, which also validates source before execution. Actions, scripts and workflows are supported; results include validity without saving. Invalid source is reported with valid=false. Script/action output schemas are inferred from return types: Promise unwrapping, Record, intersections and Date. Unknown types yield an empty schema and a warning in warnings. Source diagnostics use /source or /implementation/source with 1-based line/column. For kind=action the same admission checks as action creation apply (no external imports, platform operations only as direct call(praxis/<api>.<op>, input) calls, no agent or automation calls), so source that validates is not rejected at creation. For kind=workflow the YAML needs document (dsl, namespace, name, version) and do; each problem is one entry in errors[] (pointer, detail, hint), so read the first one. A listen outside the supported subset (to.all, inside a fork) and emit are not reported here and fail with DEFINITION_INVALID only when a run is created. Workflow syntax reference: https://deepraxis.com/docs/developers/automation/reference/workflow-syntax.",
|
|
6023
6197
|
"http": "POST",
|
|
6024
6198
|
"path": "/automation/v1/validate",
|
|
6025
6199
|
"streaming": "no",
|
|
@@ -6126,7 +6300,7 @@ export const operations = [
|
|
|
6126
6300
|
"resource": "automation.workflows",
|
|
6127
6301
|
"method": "create",
|
|
6128
6302
|
"summary": "Create a workflow",
|
|
6129
|
-
"description": "Save a YAML workflow as an editable draft
|
|
6303
|
+
"description": "Workflow syntax reference: https://deepraxis.com/docs/developers/automation/reference/workflow-syntax. Save a YAML workflow as an editable draft; this does not validate, publish or run it, so check it with validate (kind=workflow) first. Minimal draft: document with dsl (\"1.0.3\"), namespace, name and version, plus a do list of steps, for example document: {dsl: \"1.0.3\", namespace: demo, name: add, version: \"1.0.0\"} and do: [{first: {call: demo/add-one, with: {n: \"${ .n }\"}}}]. call: <ns/name> calls an Action directly (bare name for built-ins such as ocr) and with is the Action input; the input contract is at current_revision.input_schema in the get-action response. run: starts a saved script or child workflow. The run input is . in the first step, and expressions are jq written as a whole ${ ... } string. Limits: Action 30 s (run-sandbox 10 min), workflow 24 h by default and 30 days at most, payload 1 MiB. Test the draft by sending its source and language=yaml to praxis.automation.runs.create. Guide: /docs/developers/automation/guides/write-workflow. Error details are in the errors[] of the response (pointer, detail, hint). Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. run.workflow accepts ns/name@range or {namespace, name, version, input}; run.script uses the same reference shape as a platform extension. Object namespace, name and version are required; version accepts an exact version, dist-tag or range, locked at publication. Object input defaults to {} and supports expressions; string references retain task-level with. run.await defaults to true and returns the child output. With false, the child uses detach and the task immediately returns {run_id}; parent cancellation does not cascade. Inline script.code returns DEFINITION_INVALID with a detail asking you to save a script and reference it first. raise.error retains its type URI, status, title and detail in the run error.",
|
|
6130
6304
|
"http": "POST",
|
|
6131
6305
|
"path": "/automation/v1/workflows",
|
|
6132
6306
|
"streaming": "no",
|
|
@@ -6196,7 +6370,7 @@ export const operations = [
|
|
|
6196
6370
|
"resource": "automation.workflows",
|
|
6197
6371
|
"method": "update",
|
|
6198
6372
|
"summary": "Update a workflow draft",
|
|
6199
|
-
"description": "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.",
|
|
6373
|
+
"description": "Update description, labels or draft with the current draft revision in If-Match, taken from draft.revision in the get-workflow response. Even metadata-only updates create a new draft revision. A mismatch returns 412 PRECONDITION_FAILED; read the draft again, merge and retry. The draft is not validated here, so check it with validate (kind=workflow) before publishing. Error details are in errors[]. See the workflow syntax reference at https://deepraxis.com/docs/developers/automation/reference/workflow-syntax.",
|
|
6200
6374
|
"http": "PATCH",
|
|
6201
6375
|
"path": "/automation/v1/workflows/{ns}/{name}",
|
|
6202
6376
|
"streaming": "no",
|
|
@@ -6434,7 +6608,7 @@ export const operations = [
|
|
|
6434
6608
|
"publish"
|
|
6435
6609
|
],
|
|
6436
6610
|
"summary": "Publish a workflow version",
|
|
6437
|
-
"description": "Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. String and object run.workflow/run.script references share version resolution and dependency locking. Publishing removes +build metadata from the version number.",
|
|
6611
|
+
"description": "Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. String and object run.workflow/run.script references share version resolution and dependency locking. Publishing removes +build metadata from the version number. For a workflow, document namespace, name and version must equal the publish target, otherwise DEFINITION_IDENTITY_MISMATCH; where a DEFINITION_INVALID failure sits is listed in errors[] (pointer, detail, hint).",
|
|
6438
6612
|
"http": "POST",
|
|
6439
6613
|
"path": "/automation/v1/workflows/{ns}/{name}/versions",
|
|
6440
6614
|
"streaming": "no",
|
|
@@ -8118,7 +8292,7 @@ export const operations = [
|
|
|
8118
8292
|
"resource": "file.files",
|
|
8119
8293
|
"method": "create",
|
|
8120
8294
|
"summary": "Upload file",
|
|
8121
|
-
"description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data
|
|
8295
|
+
"description": "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.",
|
|
8122
8296
|
"http": "POST",
|
|
8123
8297
|
"path": "/file/v1/files",
|
|
8124
8298
|
"streaming": "no",
|
|
@@ -8140,23 +8314,16 @@ export const operations = [
|
|
|
8140
8314
|
"type": "string",
|
|
8141
8315
|
"enum": [
|
|
8142
8316
|
"user_data",
|
|
8143
|
-
"assistants",
|
|
8144
8317
|
"vision"
|
|
8145
8318
|
],
|
|
8146
8319
|
"required": true,
|
|
8147
|
-
"description": "Purpose label stored with the file: user_data
|
|
8320
|
+
"description": "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data."
|
|
8148
8321
|
},
|
|
8149
8322
|
{
|
|
8150
8323
|
"name": "expires_after",
|
|
8151
8324
|
"type": "object",
|
|
8152
8325
|
"required": false,
|
|
8153
8326
|
"description": "Optional expiry relative to created_at. Files without an expiry persist until deleted."
|
|
8154
|
-
},
|
|
8155
|
-
{
|
|
8156
|
-
"name": "praxis",
|
|
8157
|
-
"type": "object",
|
|
8158
|
-
"required": false,
|
|
8159
|
-
"description": "Own-face extensions. Use at most one expiry setting."
|
|
8160
8327
|
}
|
|
8161
8328
|
]
|
|
8162
8329
|
}
|
|
@@ -8219,7 +8386,7 @@ export const operations = [
|
|
|
8219
8386
|
"resource": "file.uploads",
|
|
8220
8387
|
"method": "create",
|
|
8221
8388
|
"summary": "Create an upload",
|
|
8222
|
-
"description": "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data
|
|
8389
|
+
"description": "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.",
|
|
8223
8390
|
"http": "POST",
|
|
8224
8391
|
"path": "/file/v1/uploads",
|
|
8225
8392
|
"streaming": "no",
|
|
@@ -8252,11 +8419,10 @@ export const operations = [
|
|
|
8252
8419
|
"type": "string",
|
|
8253
8420
|
"enum": [
|
|
8254
8421
|
"user_data",
|
|
8255
|
-
"assistants",
|
|
8256
8422
|
"vision"
|
|
8257
8423
|
],
|
|
8258
8424
|
"required": true,
|
|
8259
|
-
"description": "Use user_data for conversation attachments,
|
|
8425
|
+
"description": "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images."
|
|
8260
8426
|
},
|
|
8261
8427
|
{
|
|
8262
8428
|
"name": "expires_after",
|
|
@@ -9436,7 +9602,7 @@ export const operations = [
|
|
|
9436
9602
|
"name": "overwrite",
|
|
9437
9603
|
"type": "boolean",
|
|
9438
9604
|
"required": false,
|
|
9439
|
-
"description": "Allow replacing an existing public_id, preserving its asset_id and increasing its version. False returns the existing resource without replacing it; defaults to true."
|
|
9605
|
+
"description": "Allow replacing an existing public_id, preserving its asset_id and increasing its version. Only the latest version is deliverable; old version URLs return 404. Create a new public_id to retain old deliveries. False returns the existing resource without replacing it; defaults to true."
|
|
9440
9606
|
},
|
|
9441
9607
|
{
|
|
9442
9608
|
"name": "tags",
|
|
@@ -9494,7 +9660,8 @@ export const operations = [
|
|
|
9494
9660
|
{
|
|
9495
9661
|
"name": "file_id",
|
|
9496
9662
|
"type": "string",
|
|
9497
|
-
"required": true
|
|
9663
|
+
"required": true,
|
|
9664
|
+
"description": "File ID to copy into this library; passed as the upload source instead of file bytes. This creates an independent public copy readable without authentication. Deleting the source File does not delete this asset; do not import confidential content."
|
|
9498
9665
|
},
|
|
9499
9666
|
{
|
|
9500
9667
|
"name": "public_id",
|
|
@@ -9548,7 +9715,7 @@ export const operations = [
|
|
|
9548
9715
|
"name": "overwrite",
|
|
9549
9716
|
"type": "boolean",
|
|
9550
9717
|
"required": false,
|
|
9551
|
-
"description": "Allow replacing an existing public_id, preserving its asset_id and increasing its version. False returns the existing resource without replacing it; defaults to true."
|
|
9718
|
+
"description": "Allow replacing an existing public_id, preserving its asset_id and increasing its version. Only the latest version is deliverable; old version URLs return 404. Create a new public_id to retain old deliveries. False returns the existing resource without replacing it; defaults to true."
|
|
9552
9719
|
},
|
|
9553
9720
|
{
|
|
9554
9721
|
"name": "tags",
|
|
@@ -10065,7 +10232,7 @@ export const operations = [
|
|
|
10065
10232
|
"name": "expression",
|
|
10066
10233
|
"type": "string",
|
|
10067
10234
|
"required": false,
|
|
10068
|
-
"description": "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets."
|
|
10235
|
+
"description": "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: [\"context\"] to include context."
|
|
10069
10236
|
},
|
|
10070
10237
|
{
|
|
10071
10238
|
"name": "sort_by",
|
|
@@ -10211,6 +10378,70 @@ export const operations = [
|
|
|
10211
10378
|
]
|
|
10212
10379
|
}
|
|
10213
10380
|
},
|
|
10381
|
+
{
|
|
10382
|
+
"resource": "meta.docs",
|
|
10383
|
+
"method": "search",
|
|
10384
|
+
"summary": "Search platform documentation",
|
|
10385
|
+
"description": "Find guides and references by keyword before reading them with praxis.meta.docs.retrieve. Public; no API key required. Matches documentation titles, headings and page text without case sensitivity; all query words must occur. q is required; limit defaults to 20 and accepts 1–50. lang defaults to zh or use en for English. Returns paths, page titles, canonical URLs and short matching snippets; no matches returns an empty array.",
|
|
10386
|
+
"http": "GET",
|
|
10387
|
+
"path": "/meta/v1/docs/search",
|
|
10388
|
+
"streaming": "no",
|
|
10389
|
+
"pagination": false,
|
|
10390
|
+
"pathParams": [],
|
|
10391
|
+
"query": [
|
|
10392
|
+
{
|
|
10393
|
+
"name": "q",
|
|
10394
|
+
"type": "string",
|
|
10395
|
+
"required": true,
|
|
10396
|
+
"description": "Keywords describing the syntax or guide needed, for example export or workflow."
|
|
10397
|
+
},
|
|
10398
|
+
{
|
|
10399
|
+
"name": "limit",
|
|
10400
|
+
"type": "integer",
|
|
10401
|
+
"required": false,
|
|
10402
|
+
"description": "Maximum number of matching pages returned; integer 1–50, default 20."
|
|
10403
|
+
},
|
|
10404
|
+
{
|
|
10405
|
+
"name": "lang",
|
|
10406
|
+
"type": "string",
|
|
10407
|
+
"enum": [
|
|
10408
|
+
"zh",
|
|
10409
|
+
"en"
|
|
10410
|
+
],
|
|
10411
|
+
"required": false,
|
|
10412
|
+
"description": "Documentation language: zh for Chinese (default), en for English."
|
|
10413
|
+
}
|
|
10414
|
+
]
|
|
10415
|
+
},
|
|
10416
|
+
{
|
|
10417
|
+
"resource": "meta.docs",
|
|
10418
|
+
"method": "retrieve",
|
|
10419
|
+
"summary": "Read documentation Markdown",
|
|
10420
|
+
"description": "Read a platform guide or reference before implementing an unfamiliar capability. Public; no API key required. Take path from praxis.meta.docs.search, or use developers/automation/guides/write-workflow. Append #heading-id to path to read only that section, including its subsections. Encode the hash as %23 over HTTP; SDK callers pass it in the path string. lang defaults to zh; en selects the English page. Unknown pages or anchors return DOC_NOT_FOUND; search again for a valid path.",
|
|
10421
|
+
"http": "GET",
|
|
10422
|
+
"path": "/meta/v1/docs/{path}",
|
|
10423
|
+
"streaming": "no",
|
|
10424
|
+
"pagination": false,
|
|
10425
|
+
"pathParams": [
|
|
10426
|
+
{
|
|
10427
|
+
"name": "path",
|
|
10428
|
+
"sdkName": "path",
|
|
10429
|
+
"description": "Slash-separated documentation path from docs.search; optionally append #heading-id to select a section."
|
|
10430
|
+
}
|
|
10431
|
+
],
|
|
10432
|
+
"query": [
|
|
10433
|
+
{
|
|
10434
|
+
"name": "lang",
|
|
10435
|
+
"type": "string",
|
|
10436
|
+
"enum": [
|
|
10437
|
+
"zh",
|
|
10438
|
+
"en"
|
|
10439
|
+
],
|
|
10440
|
+
"required": false,
|
|
10441
|
+
"description": "Documentation language: zh for Chinese (default), en for English."
|
|
10442
|
+
}
|
|
10443
|
+
]
|
|
10444
|
+
},
|
|
10214
10445
|
{
|
|
10215
10446
|
"resource": "meta.health",
|
|
10216
10447
|
"method": "retrieve",
|