@deepraxis/cli 0.2.0-dev.a538fab → 0.2.0-dev.b9bc446
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/COMMANDS.md +10 -1
- package/dist/praxis.js +423 -44
- package/package.json +1 -1
package/COMMANDS.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Generated by `bun run commands`. DO NOT EDIT.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
435 HTTP operations; 437 commands including aliases.
|
|
6
6
|
|
|
7
7
|
Environment: `PRAXIS_ENV=develop|production` (dev package defaults to `develop`; stable package defaults to `production`). No `--env` option.
|
|
8
8
|
|
|
@@ -222,6 +222,13 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
222
222
|
| `praxis api browser session stream <sessionId>` | `browser.sessions.stream` | GET `/browser/v1/sessions/{sessionId}/stream` | |
|
|
223
223
|
| `praxis api browser session update <sessionId>` | `browser.sessions.update` | POST `/browser/v1/sessions/{sessionId}` | `--status` |
|
|
224
224
|
| `praxis api browser session viewer create` | `browser.sessions.viewer.create` | POST `/browser/v1/sessions/{sessionId}/viewer` | `--session`, `--viewer-id` |
|
|
225
|
+
| `praxis api canvas canvase create` | `canvas.canvases.create` | POST `/canvas/v1/canvases` | `--name` |
|
|
226
|
+
| `praxis api canvas canvase delete <canvas_id>` | `canvas.canvases.delete` | DELETE `/canvas/v1/canvases/{canvas_id}` | |
|
|
227
|
+
| `praxis api canvas canvase execute <canvas_id>` | `canvas.canvases.execute` | POST `/canvas/v1/canvases/{canvas_id}:execute` | `--script`, `--edit-id`, `--expected-version` |
|
|
228
|
+
| `praxis api canvas canvase get <canvas_id>` | `canvas.canvases.retrieve` | GET `/canvas/v1/canvases/{canvas_id}` | |
|
|
229
|
+
| `praxis api canvas canvase image list` | `canvas.canvases.images.list` | GET `/canvas/v1/canvases/{canvas_id}/images` | `--canvase`, `--ids`, `--scale`, `--param-format` |
|
|
230
|
+
| `praxis api canvas canvase list` | `canvas.canvases.list` | GET `/canvas/v1/canvases` | `--param-limit`, `--param-cursor` |
|
|
231
|
+
| `praxis api canvas canvase node list` | `canvas.canvases.nodes.list` | GET `/canvas/v1/canvases/{canvas_id}/nodes` | `--canvase`, `--ids`, `--depth` |
|
|
225
232
|
| `praxis api database create` | `database.databases.create` | POST `/database/v1/databases` | `--name` |
|
|
226
233
|
| `praxis api database delete <database_id>` | `database.databases.delete` | DELETE `/database/v1/databases/{database_id}` | |
|
|
227
234
|
| `praxis api database event list` | `database.databases.events.list` | GET `/database/v1/databases/{database_id}/events` | `--database`, `--after-seq`, `--param-limit`, `--order`, `--before-seq` |
|
|
@@ -299,6 +306,8 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
299
306
|
| `praxis api media library search-semantic` | `media.libraries.search.semantic.create` | POST `/media/v1/libraries/{library_id}/search/semantic` | `--library`, `--query`, `--filter`, `--top-k`, `--mode` |
|
|
300
307
|
| `praxis api media library search-visual` | `media.libraries.search.visual.create` | POST `/media/v1/libraries/{library_id}/search/visual` | `--library`, `--asset-id`, `--top-k`, `--filter` |
|
|
301
308
|
| `praxis api media library update <library_id>` | `media.libraries.update` | PATCH `/media/v1/libraries/{library_id}` | `--name` |
|
|
309
|
+
| `praxis api meta doc get <path>` | `meta.docs.retrieve` | GET `/meta/v1/docs/{path}` | `--lang` |
|
|
310
|
+
| `praxis api meta doc search` | `meta.docs.search` | GET `/meta/v1/docs/search` | `--q`, `--param-limit`, `--lang` |
|
|
302
311
|
| `praxis api meta health get` | `meta.health.retrieve` | GET `/meta/v1/health` | |
|
|
303
312
|
| `praxis api meta method get <name>` | `meta.methods.retrieve` | GET `/meta/v1/methods/{name}` | |
|
|
304
313
|
| `praxis api meta method list` | `meta.methods.list` | GET `/meta/v1/methods` | `--q`, `--param-limit`, `--after-id` |
|
package/dist/praxis.js
CHANGED
|
@@ -11,7 +11,7 @@ var operations = [
|
|
|
11
11
|
resource: "agent.agents",
|
|
12
12
|
method: "list",
|
|
13
13
|
summary: "List agents",
|
|
14
|
-
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
|
|
14
|
+
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, kind=service for per-session environments, or kind=assume for external MCP clients. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
15
15
|
http: "GET",
|
|
16
16
|
path: "/agent/v1/agents",
|
|
17
17
|
streaming: "no",
|
|
@@ -56,8 +56,10 @@ var operations = [
|
|
|
56
56
|
name: "kind",
|
|
57
57
|
type: "string",
|
|
58
58
|
enum: [
|
|
59
|
+
"general",
|
|
59
60
|
"personal",
|
|
60
|
-
"service"
|
|
61
|
+
"service",
|
|
62
|
+
"assume"
|
|
61
63
|
],
|
|
62
64
|
required: false,
|
|
63
65
|
description: "Filter agents by their immutable kind, including agents created before kind was recorded."
|
|
@@ -68,7 +70,7 @@ var operations = [
|
|
|
68
70
|
resource: "agent.agents",
|
|
69
71
|
method: "create",
|
|
70
72
|
summary: "Create agent",
|
|
71
|
-
description: `Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. 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"}]}.`,
|
|
73
|
+
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"}]}. For kind assume, provide name and computer_id without model, models, subagent_model, subagents or multiagent; vault_ids are accepted, bindings and environment_id are refused. Drive assume agents over MCP at /agent/v1/agents/{id}/mcp.`,
|
|
72
74
|
http: "POST",
|
|
73
75
|
path: "/agent/v1/agents",
|
|
74
76
|
streaming: "no",
|
|
@@ -81,8 +83,8 @@ var operations = [
|
|
|
81
83
|
{
|
|
82
84
|
name: "model",
|
|
83
85
|
type: "object",
|
|
84
|
-
required:
|
|
85
|
-
description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected."
|
|
86
|
+
required: false,
|
|
87
|
+
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. Forbidden and omitted on assume agents."
|
|
86
88
|
},
|
|
87
89
|
{
|
|
88
90
|
name: "name",
|
|
@@ -141,17 +143,19 @@ across all toolsets allowed.`
|
|
|
141
143
|
type: "array",
|
|
142
144
|
itemType: "object",
|
|
143
145
|
required: false,
|
|
144
|
-
description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- 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."
|
|
146
|
+
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."
|
|
145
147
|
},
|
|
146
148
|
{
|
|
147
149
|
name: "kind",
|
|
148
150
|
type: "string",
|
|
149
151
|
enum: [
|
|
152
|
+
"general",
|
|
150
153
|
"personal",
|
|
151
|
-
"service"
|
|
154
|
+
"service",
|
|
155
|
+
"assume"
|
|
152
156
|
],
|
|
153
157
|
required: false,
|
|
154
|
-
description: "Immutable agent kind. personal
|
|
158
|
+
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. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted."
|
|
155
159
|
},
|
|
156
160
|
{
|
|
157
161
|
name: "computer_id",
|
|
@@ -201,7 +205,7 @@ across all toolsets allowed.`
|
|
|
201
205
|
name: "avatar",
|
|
202
206
|
type: "string",
|
|
203
207
|
required: false,
|
|
204
|
-
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.
|
|
208
|
+
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."
|
|
205
209
|
},
|
|
206
210
|
{
|
|
207
211
|
name: "environment_id",
|
|
@@ -243,7 +247,7 @@ across all toolsets allowed.`
|
|
|
243
247
|
{
|
|
244
248
|
name: "agent_id",
|
|
245
249
|
sdkName: "agent_id",
|
|
246
|
-
description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name."
|
|
250
|
+
description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
247
251
|
}
|
|
248
252
|
],
|
|
249
253
|
query: [
|
|
@@ -259,7 +263,7 @@ across all toolsets allowed.`
|
|
|
259
263
|
resource: "agent.agents",
|
|
260
264
|
method: "update",
|
|
261
265
|
summary: "Update agent",
|
|
262
|
-
description: "Save configuration changes as a new immutable version. Send latest_version from a default retrieve or update response as the request version for optimistic concurrency; a stale value returns 409. apply defaults to true and makes the new version effective; apply false saves without changing active_version. The response contains the effective configuration, with version equal to active_version and latest_version naming the newest saved version. An unchanged configuration, including a note-only update, is a no-op returning 200 and the current effective version without creating or activating a version. version_note records up to 280 characters only when a configuration change creates a new version; null is equivalent to omission. Use agents.versions.apply to activate an existing saved version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400.",
|
|
266
|
+
description: "Save configuration changes as a new immutable version. Send latest_version from a default retrieve or update response as the request version for optimistic concurrency; a stale value returns 409. apply defaults to true and makes the new version effective; apply false saves without changing active_version. The response contains the effective configuration, with version equal to active_version and latest_version naming the newest saved version. An unchanged configuration, including a note-only update, is a no-op returning 200 and the current effective version without creating or activating a version. version_note records up to 280 characters only when a configuration change creates a new version; null is equivalent to omission. Use agents.versions.apply to activate an existing saved version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400. Assume agents reject model, models, subagent_model, subagents and multiagent on every update; other fields follow the general agent rules, with vault_ids also accepted.",
|
|
263
267
|
http: "POST",
|
|
264
268
|
path: "/agent/v1/agents/{agent_id}",
|
|
265
269
|
streaming: "no",
|
|
@@ -268,7 +272,7 @@ across all toolsets allowed.`
|
|
|
268
272
|
{
|
|
269
273
|
name: "agent_id",
|
|
270
274
|
sdkName: "agent_id",
|
|
271
|
-
description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name."
|
|
275
|
+
description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
272
276
|
}
|
|
273
277
|
],
|
|
274
278
|
query: [],
|
|
@@ -300,7 +304,7 @@ to 64 chars each) with values up to 512 chars.`
|
|
|
300
304
|
name: "model",
|
|
301
305
|
type: "object",
|
|
302
306
|
required: false,
|
|
303
|
-
description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected."
|
|
307
|
+
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. Forbidden and omitted on assume agents."
|
|
304
308
|
},
|
|
305
309
|
{
|
|
306
310
|
name: "multiagent",
|
|
@@ -365,11 +369,13 @@ toolsets allowed.`
|
|
|
365
369
|
name: "kind",
|
|
366
370
|
type: "string",
|
|
367
371
|
enum: [
|
|
372
|
+
"general",
|
|
368
373
|
"personal",
|
|
369
|
-
"service"
|
|
374
|
+
"service",
|
|
375
|
+
"assume"
|
|
370
376
|
],
|
|
371
377
|
required: false,
|
|
372
|
-
description: "Immutable agent kind. personal
|
|
378
|
+
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. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted."
|
|
373
379
|
},
|
|
374
380
|
{
|
|
375
381
|
name: "computer_id",
|
|
@@ -419,7 +425,7 @@ toolsets allowed.`
|
|
|
419
425
|
name: "avatar",
|
|
420
426
|
type: "string",
|
|
421
427
|
required: false,
|
|
422
|
-
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.
|
|
428
|
+
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."
|
|
423
429
|
},
|
|
424
430
|
{
|
|
425
431
|
name: "environment_id",
|
|
@@ -463,7 +469,7 @@ Agent Kit calls this from the page with a customer access token of this agent; y
|
|
|
463
469
|
{
|
|
464
470
|
name: "agent_id",
|
|
465
471
|
sdkName: "agent_id",
|
|
466
|
-
description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for."
|
|
472
|
+
description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
467
473
|
}
|
|
468
474
|
],
|
|
469
475
|
query: []
|
|
@@ -481,7 +487,7 @@ Agent Kit calls this from the page with a customer access token of this agent; y
|
|
|
481
487
|
{
|
|
482
488
|
name: "agent_id",
|
|
483
489
|
sdkName: "agent_id",
|
|
484
|
-
description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name."
|
|
490
|
+
description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
485
491
|
}
|
|
486
492
|
],
|
|
487
493
|
query: []
|
|
@@ -501,7 +507,7 @@ Call this from your backend with your API key, or from the console. Customers fo
|
|
|
501
507
|
{
|
|
502
508
|
name: "agent_id",
|
|
503
509
|
sdkName: "agent_id",
|
|
504
|
-
description: "Active service agent id from agent creation or listing."
|
|
510
|
+
description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
505
511
|
}
|
|
506
512
|
],
|
|
507
513
|
query: [
|
|
@@ -556,7 +562,7 @@ No Authorization header is required: the grant code or the publishable key is th
|
|
|
556
562
|
{
|
|
557
563
|
name: "agent_id",
|
|
558
564
|
sdkName: "agent_id",
|
|
559
|
-
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
|
|
565
|
+
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
560
566
|
}
|
|
561
567
|
],
|
|
562
568
|
query: [],
|
|
@@ -580,7 +586,7 @@ Send the current customer access token as the Bearer credential, with no body, w
|
|
|
580
586
|
{
|
|
581
587
|
name: "agent_id",
|
|
582
588
|
sdkName: "agent_id",
|
|
583
|
-
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
|
|
589
|
+
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
584
590
|
}
|
|
585
591
|
],
|
|
586
592
|
query: []
|
|
@@ -600,7 +606,7 @@ Send the current customer access token as the Bearer credential, with no body, a
|
|
|
600
606
|
{
|
|
601
607
|
name: "agent_id",
|
|
602
608
|
sdkName: "agent_id",
|
|
603
|
-
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
|
|
609
|
+
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
604
610
|
}
|
|
605
611
|
],
|
|
606
612
|
query: []
|
|
@@ -620,7 +626,7 @@ Call this from your backend with your API key after your own login succeeds, the
|
|
|
620
626
|
{
|
|
621
627
|
name: "agent_id",
|
|
622
628
|
sdkName: "agent_id",
|
|
623
|
-
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing."
|
|
629
|
+
description: "Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
624
630
|
}
|
|
625
631
|
],
|
|
626
632
|
query: [],
|
|
@@ -712,7 +718,7 @@ Develop only. Set confirm to the exact customer id; a missing or different confi
|
|
|
712
718
|
{
|
|
713
719
|
name: "agent_id",
|
|
714
720
|
sdkName: "agent_id",
|
|
715
|
-
description: "Active service agent id from agent creation or listing."
|
|
721
|
+
description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
716
722
|
},
|
|
717
723
|
{
|
|
718
724
|
name: "customer_id",
|
|
@@ -744,7 +750,7 @@ Use the customer id from the list or your own customer_id. An unknown customer r
|
|
|
744
750
|
{
|
|
745
751
|
name: "agent_id",
|
|
746
752
|
sdkName: "agent_id",
|
|
747
|
-
description: "Active service agent id from agent creation or listing."
|
|
753
|
+
description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
748
754
|
},
|
|
749
755
|
{
|
|
750
756
|
name: "customer_id",
|
|
@@ -769,7 +775,7 @@ Blocks the customer, then ends every live sign-in the way logout does: each acce
|
|
|
769
775
|
{
|
|
770
776
|
name: "agent_id",
|
|
771
777
|
sdkName: "agent_id",
|
|
772
|
-
description: "Active service agent id from agent creation or listing."
|
|
778
|
+
description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
773
779
|
},
|
|
774
780
|
{
|
|
775
781
|
name: "customer_id",
|
|
@@ -794,7 +800,7 @@ Use the same agent_id and customer id as the confirmed DELETE. Status is pending
|
|
|
794
800
|
{
|
|
795
801
|
name: "agent_id",
|
|
796
802
|
sdkName: "agent_id",
|
|
797
|
-
description: "Active service agent id from agent creation or listing."
|
|
803
|
+
description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
798
804
|
},
|
|
799
805
|
{
|
|
800
806
|
name: "customer_id",
|
|
@@ -819,7 +825,7 @@ Ends every live sign-in of the customer, revoking each access token and closing
|
|
|
819
825
|
{
|
|
820
826
|
name: "agent_id",
|
|
821
827
|
sdkName: "agent_id",
|
|
822
|
-
description: "Active service agent id from agent creation or listing."
|
|
828
|
+
description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
823
829
|
},
|
|
824
830
|
{
|
|
825
831
|
name: "customer_id",
|
|
@@ -844,7 +850,7 @@ Idempotent. Access tokens revoked while the customer was blocked stay revoked; s
|
|
|
844
850
|
{
|
|
845
851
|
name: "agent_id",
|
|
846
852
|
sdkName: "agent_id",
|
|
847
|
-
description: "Active service agent id from agent creation or listing."
|
|
853
|
+
description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
848
854
|
},
|
|
849
855
|
{
|
|
850
856
|
name: "customer_id",
|
|
@@ -867,7 +873,7 @@ Idempotent. Access tokens revoked while the customer was blocked stay revoked; s
|
|
|
867
873
|
{
|
|
868
874
|
name: "agent_id",
|
|
869
875
|
sdkName: "agent_id",
|
|
870
|
-
description: "Agent id from creation or listing."
|
|
876
|
+
description: "Agent id from creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
871
877
|
}
|
|
872
878
|
],
|
|
873
879
|
query: []
|
|
@@ -885,7 +891,7 @@ Idempotent. Access tokens revoked while the customer was blocked stay revoked; s
|
|
|
885
891
|
{
|
|
886
892
|
name: "agent_id",
|
|
887
893
|
sdkName: "agent_id",
|
|
888
|
-
description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name."
|
|
894
|
+
description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
889
895
|
}
|
|
890
896
|
],
|
|
891
897
|
query: [
|
|
@@ -916,7 +922,7 @@ Idempotent. Access tokens revoked while the customer was blocked stay revoked; s
|
|
|
916
922
|
{
|
|
917
923
|
name: "agent_id",
|
|
918
924
|
sdkName: "agent_id",
|
|
919
|
-
description: "Agent identifier from agents.create or agents.list."
|
|
925
|
+
description: "Agent identifier from agents.create or agents.list. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
|
|
920
926
|
},
|
|
921
927
|
{
|
|
922
928
|
name: "version",
|
|
@@ -958,7 +964,7 @@ Praxis extension: MA only has session-scoped temporary containers and memory_sto
|
|
|
958
964
|
resource: "agent.computers",
|
|
959
965
|
method: "create",
|
|
960
966
|
summary: "Create Computer",
|
|
961
|
-
description: `Create a durable computer: a named machine whose files outlive sessions, for personal agents.
|
|
967
|
+
description: `Create a durable computer: a named machine whose files outlive sessions, for general and personal agents.
|
|
962
968
|
|
|
963
969
|
Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.`,
|
|
964
970
|
http: "POST",
|
|
@@ -1409,7 +1415,7 @@ archived).`
|
|
|
1409
1415
|
resource: "agent.deployments",
|
|
1410
1416
|
method: "create",
|
|
1411
1417
|
summary: "Create deployment",
|
|
1412
|
-
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.",
|
|
1418
|
+
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.",
|
|
1413
1419
|
http: "POST",
|
|
1414
1420
|
path: "/agent/v1/deployments",
|
|
1415
1421
|
streaming: "no",
|
|
@@ -1490,7 +1496,7 @@ created from this deployment. Maximum 50.`
|
|
|
1490
1496
|
name: "target",
|
|
1491
1497
|
type: "object",
|
|
1492
1498
|
required: false,
|
|
1493
|
-
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."
|
|
1499
|
+
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."
|
|
1494
1500
|
}
|
|
1495
1501
|
]
|
|
1496
1502
|
}
|
|
@@ -1607,7 +1613,7 @@ null to clear. Maximum 50.`
|
|
|
1607
1613
|
name: "target",
|
|
1608
1614
|
type: "object",
|
|
1609
1615
|
required: false,
|
|
1610
|
-
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."
|
|
1616
|
+
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."
|
|
1611
1617
|
}
|
|
1612
1618
|
]
|
|
1613
1619
|
}
|
|
@@ -1973,7 +1979,7 @@ clears to null; an empty string is stored as an empty string.`
|
|
|
1973
1979
|
resource: "agent.sessions",
|
|
1974
1980
|
method: "create",
|
|
1975
1981
|
summary: "Create session",
|
|
1976
|
-
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.`,
|
|
1982
|
+
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. Assume agents return 400 INVALID_PARAMS; drive them over MCP at /agent/v1/agents/{id}/mcp instead.`,
|
|
1977
1983
|
http: "POST",
|
|
1978
1984
|
path: "/agent/v1/sessions",
|
|
1979
1985
|
streaming: "no",
|
|
@@ -2277,7 +2283,7 @@ Own-face extension. No request body is required. Uses the same stop implementati
|
|
|
2277
2283
|
summary: "Compact Session (Extension)",
|
|
2278
2284
|
description: `Request session context compaction and retrieve an operation receipt.
|
|
2279
2285
|
|
|
2280
|
-
Available 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.`,
|
|
2286
|
+
Available 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.`,
|
|
2281
2287
|
http: "POST",
|
|
2282
2288
|
path: "/agent/v1/sessions/{session_id}/compact",
|
|
2283
2289
|
streaming: "no",
|
|
@@ -2333,7 +2339,7 @@ Available only on /agent/v1. Returns { type: session_compaction, id, status, rea
|
|
|
2333
2339
|
summary: "List Session Compactions (Extension)",
|
|
2334
2340
|
description: `Read session compaction history and summaries.
|
|
2335
2341
|
|
|
2336
|
-
Available 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.`,
|
|
2342
|
+
Available 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.`,
|
|
2337
2343
|
http: "GET",
|
|
2338
2344
|
path: "/agent/v1/sessions/{session_id}/compactions",
|
|
2339
2345
|
streaming: "no",
|
|
@@ -6303,7 +6309,7 @@ file at the root of that directory.`
|
|
|
6303
6309
|
resource: "automation.validate",
|
|
6304
6310
|
method: "create",
|
|
6305
6311
|
summary: "Validate a definition",
|
|
6306
|
-
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.",
|
|
6312
|
+
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.",
|
|
6307
6313
|
http: "POST",
|
|
6308
6314
|
path: "/automation/v1/validate",
|
|
6309
6315
|
streaming: "no",
|
|
@@ -6410,7 +6416,7 @@ file at the root of that directory.`
|
|
|
6410
6416
|
resource: "automation.workflows",
|
|
6411
6417
|
method: "create",
|
|
6412
6418
|
summary: "Create a workflow",
|
|
6413
|
-
description: '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.',
|
|
6419
|
+
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.',
|
|
6414
6420
|
http: "POST",
|
|
6415
6421
|
path: "/automation/v1/workflows",
|
|
6416
6422
|
streaming: "no",
|
|
@@ -6480,7 +6486,7 @@ file at the root of that directory.`
|
|
|
6480
6486
|
resource: "automation.workflows",
|
|
6481
6487
|
method: "update",
|
|
6482
6488
|
summary: "Update a workflow draft",
|
|
6483
|
-
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[].",
|
|
6489
|
+
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.",
|
|
6484
6490
|
http: "PATCH",
|
|
6485
6491
|
path: "/automation/v1/workflows/{ns}/{name}",
|
|
6486
6492
|
streaming: "no",
|
|
@@ -7393,6 +7399,220 @@ file at the root of that directory.`
|
|
|
7393
7399
|
]
|
|
7394
7400
|
}
|
|
7395
7401
|
},
|
|
7402
|
+
{
|
|
7403
|
+
resource: "canvas.canvases",
|
|
7404
|
+
method: "list",
|
|
7405
|
+
summary: "List canvases",
|
|
7406
|
+
description: "Discover canvases in the API key's organization and obtain ids for retrieval or editing. Results are ordered by updated_at from newest to oldest. limit is 1–100 and defaults to 50; omit cursor for the first page, then copy next_cursor into the next request until it is null. Deleted canvases are unavailable.",
|
|
7407
|
+
http: "GET",
|
|
7408
|
+
path: "/canvas/v1/canvases",
|
|
7409
|
+
streaming: "no",
|
|
7410
|
+
pagination: true,
|
|
7411
|
+
pathParams: [],
|
|
7412
|
+
query: [
|
|
7413
|
+
{
|
|
7414
|
+
name: "limit",
|
|
7415
|
+
type: "integer",
|
|
7416
|
+
required: false,
|
|
7417
|
+
description: "Maximum canvases to return per page, from 1 to 100; defaults to 50 when omitted."
|
|
7418
|
+
},
|
|
7419
|
+
{
|
|
7420
|
+
name: "cursor",
|
|
7421
|
+
type: "string",
|
|
7422
|
+
required: false,
|
|
7423
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
7424
|
+
}
|
|
7425
|
+
]
|
|
7426
|
+
},
|
|
7427
|
+
{
|
|
7428
|
+
resource: "canvas.canvases",
|
|
7429
|
+
method: "create",
|
|
7430
|
+
summary: "Create canvas",
|
|
7431
|
+
description: "Create a blank design canvas in the API key's organization before drawing with praxis.canvas.canvases.execute. Send an optional name of at most 200 characters; omitting name uses Untitled. Each successful call creates a new canvas and returns its id and viewer_url with HTTP 201; save the id for subsequent reads, edits and deletion.",
|
|
7432
|
+
http: "POST",
|
|
7433
|
+
path: "/canvas/v1/canvases",
|
|
7434
|
+
streaming: "no",
|
|
7435
|
+
pagination: false,
|
|
7436
|
+
pathParams: [],
|
|
7437
|
+
query: [],
|
|
7438
|
+
body: {
|
|
7439
|
+
required: false,
|
|
7440
|
+
fields: [
|
|
7441
|
+
{
|
|
7442
|
+
name: "name",
|
|
7443
|
+
type: "string",
|
|
7444
|
+
required: false,
|
|
7445
|
+
description: "Display name for the new canvas, at most 200 characters; omission uses Untitled."
|
|
7446
|
+
}
|
|
7447
|
+
]
|
|
7448
|
+
}
|
|
7449
|
+
},
|
|
7450
|
+
{
|
|
7451
|
+
resource: "canvas.canvases",
|
|
7452
|
+
method: "delete",
|
|
7453
|
+
summary: "Delete canvas",
|
|
7454
|
+
description: "Permanently delete a canvas and its design content when it is no longer needed. Obtain canvas_id from create or list and confirm the target before calling; deletion cannot be undone. HTTP 200 confirms deletion with deleted=true. Subsequent access returns CANVAS_NOT_FOUND, as it does for a missing canvas or one outside the API key's organization.",
|
|
7455
|
+
http: "DELETE",
|
|
7456
|
+
path: "/canvas/v1/canvases/{canvas_id}",
|
|
7457
|
+
streaming: "no",
|
|
7458
|
+
pagination: false,
|
|
7459
|
+
pathParams: [
|
|
7460
|
+
{
|
|
7461
|
+
name: "canvas_id",
|
|
7462
|
+
sdkName: "canvas_id",
|
|
7463
|
+
description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted."
|
|
7464
|
+
}
|
|
7465
|
+
],
|
|
7466
|
+
query: []
|
|
7467
|
+
},
|
|
7468
|
+
{
|
|
7469
|
+
resource: "canvas.canvases",
|
|
7470
|
+
method: "retrieve",
|
|
7471
|
+
summary: "Retrieve canvas",
|
|
7472
|
+
description: "Inspect the current canvas before editing, like Pencil get_app_state. The response adds top-level node summaries in canvas order and reusable component ids to the canvas metadata. Use these ids in nodes.list, images.list or an execute script; use the returned version as expected_version to detect concurrent edits. Read full node content with nodes.list rather than guessing fields from these summaries.",
|
|
7473
|
+
http: "GET",
|
|
7474
|
+
path: "/canvas/v1/canvases/{canvas_id}",
|
|
7475
|
+
streaming: "no",
|
|
7476
|
+
pagination: false,
|
|
7477
|
+
pathParams: [
|
|
7478
|
+
{
|
|
7479
|
+
name: "canvas_id",
|
|
7480
|
+
sdkName: "canvas_id",
|
|
7481
|
+
description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted."
|
|
7482
|
+
}
|
|
7483
|
+
],
|
|
7484
|
+
query: []
|
|
7485
|
+
},
|
|
7486
|
+
{
|
|
7487
|
+
resource: "canvas.canvases.images",
|
|
7488
|
+
method: "list",
|
|
7489
|
+
summary: "Render canvas nodes",
|
|
7490
|
+
description: "Render 1–4 nodes to inspect the visual result of a design edit. Use ids from retrieve, execute.created or execute.screenshots; scale defaults to 1 and accepts 0.25–4, and png is the only supported format. Unlike Figma, images contains inline data:image/png;base64,... URLs, not hosted image URLs; a null entry means no image is available for that id. Use nodes.list for editable node content instead of pixels.",
|
|
7491
|
+
http: "GET",
|
|
7492
|
+
path: "/canvas/v1/canvases/{canvas_id}/images",
|
|
7493
|
+
streaming: "no",
|
|
7494
|
+
pagination: false,
|
|
7495
|
+
pathParams: [
|
|
7496
|
+
{
|
|
7497
|
+
name: "canvas_id",
|
|
7498
|
+
sdkName: "canvas_id",
|
|
7499
|
+
description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted."
|
|
7500
|
+
}
|
|
7501
|
+
],
|
|
7502
|
+
query: [
|
|
7503
|
+
{
|
|
7504
|
+
name: "ids",
|
|
7505
|
+
type: "string",
|
|
7506
|
+
required: true,
|
|
7507
|
+
description: "Comma-separated list of 1–4 node ids to render, from retrieve, execute.created or execute.screenshots."
|
|
7508
|
+
},
|
|
7509
|
+
{
|
|
7510
|
+
name: "scale",
|
|
7511
|
+
type: "number",
|
|
7512
|
+
required: false,
|
|
7513
|
+
description: "Output pixel scale relative to canvas dimensions, from 0.25 to 4 inclusive; defaults to 1 when omitted."
|
|
7514
|
+
},
|
|
7515
|
+
{
|
|
7516
|
+
name: "format",
|
|
7517
|
+
type: "string",
|
|
7518
|
+
enum: [
|
|
7519
|
+
"png"
|
|
7520
|
+
],
|
|
7521
|
+
required: false,
|
|
7522
|
+
description: "Image encoding; png produces a PNG data URL and is the only supported value. Omit to use png."
|
|
7523
|
+
}
|
|
7524
|
+
]
|
|
7525
|
+
},
|
|
7526
|
+
{
|
|
7527
|
+
resource: "canvas.canvases.nodes",
|
|
7528
|
+
method: "list",
|
|
7529
|
+
summary: "Read canvas nodes",
|
|
7530
|
+
description: "Read node documents for inspection before changing individual nodes. Supply 1–100 comma-separated node ids from retrieve or execute, or instance paths such as a/b. depth is an integer at least 0; omit it for complete subtrees. Each requested id maps to a document wrapper or null if absent. Unlike Figma, document contains a Pencil .pen 2.21 node, not a Figma node. For top-level summaries use canvases.retrieve; for pixels use images.list.",
|
|
7531
|
+
http: "GET",
|
|
7532
|
+
path: "/canvas/v1/canvases/{canvas_id}/nodes",
|
|
7533
|
+
streaming: "no",
|
|
7534
|
+
pagination: false,
|
|
7535
|
+
pathParams: [
|
|
7536
|
+
{
|
|
7537
|
+
name: "canvas_id",
|
|
7538
|
+
sdkName: "canvas_id",
|
|
7539
|
+
description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted."
|
|
7540
|
+
}
|
|
7541
|
+
],
|
|
7542
|
+
query: [
|
|
7543
|
+
{
|
|
7544
|
+
name: "ids",
|
|
7545
|
+
type: "string",
|
|
7546
|
+
required: true,
|
|
7547
|
+
description: "Comma-separated list of 1–100 node ids from retrieve or execute, or instance paths such as a/b; missing ids map to null."
|
|
7548
|
+
},
|
|
7549
|
+
{
|
|
7550
|
+
name: "depth",
|
|
7551
|
+
type: "integer",
|
|
7552
|
+
required: false,
|
|
7553
|
+
description: "Maximum child depth below each requested node, as an integer at least 0; 0 returns the node without descendants, and omission returns the complete subtree."
|
|
7554
|
+
}
|
|
7555
|
+
]
|
|
7556
|
+
},
|
|
7557
|
+
{
|
|
7558
|
+
resource: "canvas.canvases",
|
|
7559
|
+
method: "execute",
|
|
7560
|
+
summary: "Execute canvas script",
|
|
7561
|
+
description: `Draw or edit a canvas atomically with a synchronous Pencil execute script. First create a canvas with praxis.canvas.canvases.create and use its id as canvas_id; inspect an existing canvas with retrieve before modifying it. Send exactly one of script (new source) or edit_id (a failed script to patch using edits). Unlike Figma REST, :execute writes design content; nodes use Pencil .pen schema 2.21 (frame/group/rectangle/ellipse/polygon/path/text/icon/ref/note), not Figma node fields.
|
|
7562
|
+
|
|
7563
|
+
The root variable is document. Synchronous functions are Insert / Copy / Update / Replace / Move / Delete / SetVariables / Get / GetVariables / FindEmptySpace / Print / TakeScreenshot; globals persist for the next call. A first frame needs only this body.script:
|
|
7564
|
+
|
|
7565
|
+
\`\`\`js
|
|
7566
|
+
const f = Insert(document, { type: "frame", name: "Hero", width: 1200, layout: "vertical", padding: 48, fill: "#FFFFFF" }); Insert(f, { type: "text", content: "Hello", fontSize: 32, fill: "#111111" }); Print(f)
|
|
7567
|
+
\`\`\`
|
|
7568
|
+
|
|
7569
|
+
Use viewer_url to watch the result in Console. TakeScreenshot records node ids in screenshots; call images.list with those ids to fetch PNG data URLs. See the [Canvas execute reference](https://deepraxis.com/en/docs/api/native/canvas/execute) for request fields and results, and the [Pencil node schema](https://docs.pencil.dev/core-concepts/pen-files) for node content.
|
|
7570
|
+
|
|
7571
|
+
A successful write increments version by one. Optionally set expected_version to the version from retrieve or nodes.list; on 409 REVISION_CONFLICT read again, merge your intent and retry with the current version. Every script failure rolls back all writes. On 400 SCRIPT_ERROR, SCRIPT_LIMIT or OPS_REJECTED, use error.details.edit_id plus edits to repair and rerun the stored source without resending the entire script; details may include line, column and rejection. On 400 EDIT_EXPIRED the saved script is older than ten minutes: submit a corrected new script. On 429 CANVAS_BUSY, more than four calls are queued for this canvas: wait for pending calls before retrying.
|
|
7572
|
+
`,
|
|
7573
|
+
http: "POST",
|
|
7574
|
+
path: "/canvas/v1/canvases/{canvas_id}:execute",
|
|
7575
|
+
streaming: "no",
|
|
7576
|
+
pagination: false,
|
|
7577
|
+
pathParams: [
|
|
7578
|
+
{
|
|
7579
|
+
name: "canvas_id",
|
|
7580
|
+
sdkName: "canvas_id",
|
|
7581
|
+
description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted."
|
|
7582
|
+
}
|
|
7583
|
+
],
|
|
7584
|
+
query: [],
|
|
7585
|
+
body: {
|
|
7586
|
+
required: true,
|
|
7587
|
+
fields: [
|
|
7588
|
+
{
|
|
7589
|
+
name: "script",
|
|
7590
|
+
type: "string",
|
|
7591
|
+
required: false,
|
|
7592
|
+
description: "New synchronous Pencil execute source using document as the root; provide this or edit_id, never both. See the operation's first-frame example."
|
|
7593
|
+
},
|
|
7594
|
+
{
|
|
7595
|
+
name: "edit_id",
|
|
7596
|
+
type: "string",
|
|
7597
|
+
required: false,
|
|
7598
|
+
description: "Saved failed-script identifier from error.details.edit_id; use with edits instead of script within ten minutes of the failure."
|
|
7599
|
+
},
|
|
7600
|
+
{
|
|
7601
|
+
name: "edits",
|
|
7602
|
+
type: "array",
|
|
7603
|
+
itemType: "object",
|
|
7604
|
+
required: false,
|
|
7605
|
+
description: "Text replacements applied to the source identified by edit_id before rerunning; use error line, column or rejection to choose the correction."
|
|
7606
|
+
},
|
|
7607
|
+
{
|
|
7608
|
+
name: "expected_version",
|
|
7609
|
+
type: "string",
|
|
7610
|
+
required: false,
|
|
7611
|
+
description: "Revision from retrieve, nodes.list or the previous execute response; omit for an unguarded write. A mismatch returns 409 REVISION_CONFLICT with details.version."
|
|
7612
|
+
}
|
|
7613
|
+
]
|
|
7614
|
+
}
|
|
7615
|
+
},
|
|
7396
7616
|
{
|
|
7397
7617
|
resource: "database.databases",
|
|
7398
7618
|
method: "list",
|
|
@@ -10491,6 +10711,70 @@ The default is return=minimal: success returns HTTP 201 with an empty body. Send
|
|
|
10491
10711
|
]
|
|
10492
10712
|
}
|
|
10493
10713
|
},
|
|
10714
|
+
{
|
|
10715
|
+
resource: "meta.docs",
|
|
10716
|
+
method: "search",
|
|
10717
|
+
summary: "Search platform documentation",
|
|
10718
|
+
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.",
|
|
10719
|
+
http: "GET",
|
|
10720
|
+
path: "/meta/v1/docs/search",
|
|
10721
|
+
streaming: "no",
|
|
10722
|
+
pagination: false,
|
|
10723
|
+
pathParams: [],
|
|
10724
|
+
query: [
|
|
10725
|
+
{
|
|
10726
|
+
name: "q",
|
|
10727
|
+
type: "string",
|
|
10728
|
+
required: true,
|
|
10729
|
+
description: "Keywords describing the syntax or guide needed, for example export or workflow."
|
|
10730
|
+
},
|
|
10731
|
+
{
|
|
10732
|
+
name: "limit",
|
|
10733
|
+
type: "integer",
|
|
10734
|
+
required: false,
|
|
10735
|
+
description: "Maximum number of matching pages returned; integer 1–50, default 20."
|
|
10736
|
+
},
|
|
10737
|
+
{
|
|
10738
|
+
name: "lang",
|
|
10739
|
+
type: "string",
|
|
10740
|
+
enum: [
|
|
10741
|
+
"zh",
|
|
10742
|
+
"en"
|
|
10743
|
+
],
|
|
10744
|
+
required: false,
|
|
10745
|
+
description: "Documentation language: zh for Chinese (default), en for English."
|
|
10746
|
+
}
|
|
10747
|
+
]
|
|
10748
|
+
},
|
|
10749
|
+
{
|
|
10750
|
+
resource: "meta.docs",
|
|
10751
|
+
method: "retrieve",
|
|
10752
|
+
summary: "Read documentation Markdown",
|
|
10753
|
+
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.",
|
|
10754
|
+
http: "GET",
|
|
10755
|
+
path: "/meta/v1/docs/{path}",
|
|
10756
|
+
streaming: "no",
|
|
10757
|
+
pagination: false,
|
|
10758
|
+
pathParams: [
|
|
10759
|
+
{
|
|
10760
|
+
name: "path",
|
|
10761
|
+
sdkName: "path",
|
|
10762
|
+
description: "Slash-separated documentation path from docs.search; optionally append #heading-id to select a section."
|
|
10763
|
+
}
|
|
10764
|
+
],
|
|
10765
|
+
query: [
|
|
10766
|
+
{
|
|
10767
|
+
name: "lang",
|
|
10768
|
+
type: "string",
|
|
10769
|
+
enum: [
|
|
10770
|
+
"zh",
|
|
10771
|
+
"en"
|
|
10772
|
+
],
|
|
10773
|
+
required: false,
|
|
10774
|
+
description: "Documentation language: zh for Chinese (default), en for English."
|
|
10775
|
+
}
|
|
10776
|
+
]
|
|
10777
|
+
},
|
|
10494
10778
|
{
|
|
10495
10779
|
resource: "meta.health",
|
|
10496
10780
|
method: "retrieve",
|
|
@@ -19094,6 +19378,8 @@ var fileCancelUpload = (options) => (options.client ?? client).post({
|
|
|
19094
19378
|
var healthCheck = (options) => (options?.client ?? client).get({ url: "/meta/v1/health", ...options });
|
|
19095
19379
|
var metaMethodsSearch = (options) => (options?.client ?? client).get({ url: "/meta/v1/methods", ...options });
|
|
19096
19380
|
var metaMethodsRetrieve = (options) => (options.client ?? client).get({ url: "/meta/v1/methods/{name}", ...options });
|
|
19381
|
+
var metaDocsRetrieve = (options) => (options.client ?? client).get({ url: "/meta/v1/docs/{path}", ...options });
|
|
19382
|
+
var metaDocsSearch = (options) => (options.client ?? client).get({ url: "/meta/v1/docs/search", ...options });
|
|
19097
19383
|
var listModels = (options) => (options?.client ?? client).get({
|
|
19098
19384
|
querySerializer: { parameters: {
|
|
19099
19385
|
supported_api: { array: { explode: false } },
|
|
@@ -21948,6 +22234,77 @@ var automationHumanTasksDelegate = (options) => (options.client ?? client).post(
|
|
|
21948
22234
|
...options.headers
|
|
21949
22235
|
}
|
|
21950
22236
|
});
|
|
22237
|
+
var canvasListCanvases = (options) => (options?.client ?? client).get({
|
|
22238
|
+
security: [{
|
|
22239
|
+
key: "canvas-bearerAuth",
|
|
22240
|
+
scheme: "bearer",
|
|
22241
|
+
type: "http"
|
|
22242
|
+
}],
|
|
22243
|
+
url: "/canvas/v1/canvases",
|
|
22244
|
+
...options
|
|
22245
|
+
});
|
|
22246
|
+
var canvasCreateCanvas = (options) => (options?.client ?? client).post({
|
|
22247
|
+
security: [{
|
|
22248
|
+
key: "canvas-bearerAuth",
|
|
22249
|
+
scheme: "bearer",
|
|
22250
|
+
type: "http"
|
|
22251
|
+
}],
|
|
22252
|
+
url: "/canvas/v1/canvases",
|
|
22253
|
+
...options,
|
|
22254
|
+
headers: {
|
|
22255
|
+
"Content-Type": "application/json",
|
|
22256
|
+
...options?.headers
|
|
22257
|
+
}
|
|
22258
|
+
});
|
|
22259
|
+
var canvasDeleteCanvas = (options) => (options.client ?? client).delete({
|
|
22260
|
+
security: [{
|
|
22261
|
+
key: "canvas-bearerAuth",
|
|
22262
|
+
scheme: "bearer",
|
|
22263
|
+
type: "http"
|
|
22264
|
+
}],
|
|
22265
|
+
url: "/canvas/v1/canvases/{canvas_id}",
|
|
22266
|
+
...options
|
|
22267
|
+
});
|
|
22268
|
+
var canvasRetrieveCanvas = (options) => (options.client ?? client).get({
|
|
22269
|
+
security: [{
|
|
22270
|
+
key: "canvas-bearerAuth",
|
|
22271
|
+
scheme: "bearer",
|
|
22272
|
+
type: "http"
|
|
22273
|
+
}],
|
|
22274
|
+
url: "/canvas/v1/canvases/{canvas_id}",
|
|
22275
|
+
...options
|
|
22276
|
+
});
|
|
22277
|
+
var canvasListNodes = (options) => (options.client ?? client).get({
|
|
22278
|
+
security: [{
|
|
22279
|
+
key: "canvas-bearerAuth",
|
|
22280
|
+
scheme: "bearer",
|
|
22281
|
+
type: "http"
|
|
22282
|
+
}],
|
|
22283
|
+
url: "/canvas/v1/canvases/{canvas_id}/nodes",
|
|
22284
|
+
...options
|
|
22285
|
+
});
|
|
22286
|
+
var canvasListImages = (options) => (options.client ?? client).get({
|
|
22287
|
+
security: [{
|
|
22288
|
+
key: "canvas-bearerAuth",
|
|
22289
|
+
scheme: "bearer",
|
|
22290
|
+
type: "http"
|
|
22291
|
+
}],
|
|
22292
|
+
url: "/canvas/v1/canvases/{canvas_id}/images",
|
|
22293
|
+
...options
|
|
22294
|
+
});
|
|
22295
|
+
var canvasExecute = (options) => (options.client ?? client).post({
|
|
22296
|
+
security: [{
|
|
22297
|
+
key: "canvas-bearerAuth",
|
|
22298
|
+
scheme: "bearer",
|
|
22299
|
+
type: "http"
|
|
22300
|
+
}],
|
|
22301
|
+
url: "/canvas/v1/canvases/{canvas_id}:execute",
|
|
22302
|
+
...options,
|
|
22303
|
+
headers: {
|
|
22304
|
+
"Content-Type": "application/json",
|
|
22305
|
+
...options.headers
|
|
22306
|
+
}
|
|
22307
|
+
});
|
|
21951
22308
|
var databaseListDatabases = (options) => (options?.client ?? client).get({
|
|
21952
22309
|
security: [{
|
|
21953
22310
|
key: "database-bearerAuth",
|
|
@@ -24554,6 +24911,23 @@ function createBrowser(transport) {
|
|
|
24554
24911
|
}
|
|
24555
24912
|
};
|
|
24556
24913
|
}
|
|
24914
|
+
function createCanvas(transport) {
|
|
24915
|
+
return {
|
|
24916
|
+
canvases: {
|
|
24917
|
+
create: bind(transport, canvasCreateCanvas),
|
|
24918
|
+
delete: bind(transport, canvasDeleteCanvas),
|
|
24919
|
+
execute: bind(transport, canvasExecute),
|
|
24920
|
+
images: {
|
|
24921
|
+
list: bind(transport, canvasListImages)
|
|
24922
|
+
},
|
|
24923
|
+
list: bindPage(transport, canvasListCanvases),
|
|
24924
|
+
nodes: {
|
|
24925
|
+
list: bind(transport, canvasListNodes)
|
|
24926
|
+
},
|
|
24927
|
+
retrieve: bind(transport, canvasRetrieveCanvas)
|
|
24928
|
+
}
|
|
24929
|
+
};
|
|
24930
|
+
}
|
|
24557
24931
|
function createDatabase(transport) {
|
|
24558
24932
|
return {
|
|
24559
24933
|
databases: {
|
|
@@ -24715,6 +25089,10 @@ function createMedia(transport) {
|
|
|
24715
25089
|
}
|
|
24716
25090
|
function createMeta(transport) {
|
|
24717
25091
|
return {
|
|
25092
|
+
docs: {
|
|
25093
|
+
retrieve: bind(transport, metaDocsRetrieve),
|
|
25094
|
+
search: bind(transport, metaDocsSearch)
|
|
25095
|
+
},
|
|
24718
25096
|
health: {
|
|
24719
25097
|
retrieve: bind(transport, healthCheck)
|
|
24720
25098
|
},
|
|
@@ -25039,6 +25417,7 @@ var resourceFactories = {
|
|
|
25039
25417
|
application: createApplication,
|
|
25040
25418
|
automation: createAutomation,
|
|
25041
25419
|
browser: createBrowser,
|
|
25420
|
+
canvas: createCanvas,
|
|
25042
25421
|
database: createDatabase,
|
|
25043
25422
|
file: createFile,
|
|
25044
25423
|
knowledge: createKnowledge,
|
|
@@ -25206,7 +25585,7 @@ function assertKnownOptions(options) {
|
|
|
25206
25585
|
class Transport {
|
|
25207
25586
|
config;
|
|
25208
25587
|
constructor(options) {
|
|
25209
|
-
this.config = { timeoutMs:
|
|
25588
|
+
this.config = { timeoutMs: 600000, maxRetries: 2, fetch: globalThis.fetch, ...options };
|
|
25210
25589
|
this.validate(this.config.timeoutMs, this.config.maxRetries);
|
|
25211
25590
|
}
|
|
25212
25591
|
validate(timeout, retries) {
|
|
@@ -27952,7 +28331,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
27952
28331
|
}
|
|
27953
28332
|
|
|
27954
28333
|
// src/main.ts
|
|
27955
|
-
var version = "0.2.0-dev.
|
|
28334
|
+
var version = "0.2.0-dev.b9bc446";
|
|
27956
28335
|
var commands = commandTree(operations);
|
|
27957
28336
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
27958
28337
|
function route(argv) {
|