@deepraxis/cli 0.2.0-dev.27bb19e → 0.2.0-dev.349f88a
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 -2
- package/dist/praxis.js +410 -36
- 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
|
+
436 HTTP operations; 438 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
|
|
|
@@ -117,7 +117,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
117
117
|
| `praxis api application worker deployment list` | `application.workers.deployments.list` | GET `/application/v1/workers/{worker_id}/deployments` | `--worker`, `--param-cursor`, `--param-limit` |
|
|
118
118
|
| `praxis api application worker event list` | `application.workers.events.list` | GET `/application/v1/workers/{worker_id}/events` | `--worker`, `--after-seq`, `--param-limit` |
|
|
119
119
|
| `praxis api application worker get <worker_id>` | `application.workers.retrieve` | GET `/application/v1/workers/{worker_id}` | `--expand` |
|
|
120
|
-
| `praxis api application worker grant create` | `application.workers.grants.create` | POST `/application/v1/workers/{worker_id}/grants` | `--worker`, `--access` |
|
|
120
|
+
| `praxis api application worker grant create` | `application.workers.grants.create` | POST `/application/v1/workers/{worker_id}/grants` | `--worker`, `--alias`, `--access` |
|
|
121
121
|
| `praxis api application worker grant delete <grant_id>` | `application.workers.grants.delete` | DELETE `/application/v1/workers/{worker_id}/grants/{grant_id}` | `--worker` |
|
|
122
122
|
| `praxis api application worker grant list` | `application.workers.grants.list` | GET `/application/v1/workers/{worker_id}/grants` | `--worker` |
|
|
123
123
|
| `praxis api application worker list` | `application.workers.list` | GET `/application/v1/workers` | `--param-cursor`, `--param-limit`, `--status` |
|
|
@@ -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` |
|
|
@@ -332,6 +339,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
332
339
|
| `praxis api model response get <response_id>` | `model.responses.retrieve` | GET `/model/v1/responses/{response_id}` | |
|
|
333
340
|
| `praxis api model response input-item list` | `model.responses.inputItems.list` | GET `/model/v1/responses/{response_id}/input_items` | `--response` |
|
|
334
341
|
| `praxis api model response input-token create` | `model.responses.inputTokens.create` | POST `/model/v1/responses/input_tokens` | |
|
|
342
|
+
| `praxis api model systemone create` | `model.systemone.create` | POST `/model/v1/systemone` | `--model` |
|
|
335
343
|
| `praxis api model video create` | `model.videos.create` | POST `/model/v1/videos` | `--model`, `--prompt`, `--duration`, `--size`, `--resolution`, `--aspect-ratio`, `--generate-audio`, `--seed`, `--callback-url`, `--quality` |
|
|
336
344
|
| `praxis api model video delete <video_id>` | `model.videos.delete` | DELETE `/model/v1/videos/{video_id}` | |
|
|
337
345
|
| `praxis api model video get <video_id>` | `model.videos.retrieve` | GET `/model/v1/videos/{video_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=general or 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",
|
|
@@ -58,7 +58,8 @@ var operations = [
|
|
|
58
58
|
enum: [
|
|
59
59
|
"general",
|
|
60
60
|
"personal",
|
|
61
|
-
"service"
|
|
61
|
+
"service",
|
|
62
|
+
"assume"
|
|
62
63
|
],
|
|
63
64
|
required: false,
|
|
64
65
|
description: "Filter agents by their immutable kind, including agents created before kind was recorded."
|
|
@@ -69,7 +70,7 @@ var operations = [
|
|
|
69
70
|
resource: "agent.agents",
|
|
70
71
|
method: "create",
|
|
71
72
|
summary: "Create agent",
|
|
72
|
-
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 without model, models, subagent_model, subagents or multiagent; omit computer_id to register a new computer named after the agent without starting an instance, or provide an existing computer_id; vault_ids are accepted, bindings and environment_id are refused. Drive assume agents over MCP at /agent/v1/agents/{id}/mcp.`,
|
|
73
74
|
http: "POST",
|
|
74
75
|
path: "/agent/v1/agents",
|
|
75
76
|
streaming: "no",
|
|
@@ -82,8 +83,8 @@ var operations = [
|
|
|
82
83
|
{
|
|
83
84
|
name: "model",
|
|
84
85
|
type: "object",
|
|
85
|
-
required:
|
|
86
|
-
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."
|
|
87
88
|
},
|
|
88
89
|
{
|
|
89
90
|
name: "name",
|
|
@@ -150,10 +151,11 @@ across all toolsets allowed.`
|
|
|
150
151
|
enum: [
|
|
151
152
|
"general",
|
|
152
153
|
"personal",
|
|
153
|
-
"service"
|
|
154
|
+
"service",
|
|
155
|
+
"assume"
|
|
154
156
|
],
|
|
155
157
|
required: false,
|
|
156
|
-
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."
|
|
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."
|
|
157
159
|
},
|
|
158
160
|
{
|
|
159
161
|
name: "computer_id",
|
|
@@ -245,7 +247,7 @@ across all toolsets allowed.`
|
|
|
245
247
|
{
|
|
246
248
|
name: "agent_id",
|
|
247
249
|
sdkName: "agent_id",
|
|
248
|
-
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_…."
|
|
249
251
|
}
|
|
250
252
|
],
|
|
251
253
|
query: [
|
|
@@ -261,7 +263,7 @@ across all toolsets allowed.`
|
|
|
261
263
|
resource: "agent.agents",
|
|
262
264
|
method: "update",
|
|
263
265
|
summary: "Update agent",
|
|
264
|
-
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.",
|
|
265
267
|
http: "POST",
|
|
266
268
|
path: "/agent/v1/agents/{agent_id}",
|
|
267
269
|
streaming: "no",
|
|
@@ -270,7 +272,7 @@ across all toolsets allowed.`
|
|
|
270
272
|
{
|
|
271
273
|
name: "agent_id",
|
|
272
274
|
sdkName: "agent_id",
|
|
273
|
-
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_…."
|
|
274
276
|
}
|
|
275
277
|
],
|
|
276
278
|
query: [],
|
|
@@ -302,7 +304,7 @@ to 64 chars each) with values up to 512 chars.`
|
|
|
302
304
|
name: "model",
|
|
303
305
|
type: "object",
|
|
304
306
|
required: false,
|
|
305
|
-
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."
|
|
306
308
|
},
|
|
307
309
|
{
|
|
308
310
|
name: "multiagent",
|
|
@@ -369,10 +371,11 @@ toolsets allowed.`
|
|
|
369
371
|
enum: [
|
|
370
372
|
"general",
|
|
371
373
|
"personal",
|
|
372
|
-
"service"
|
|
374
|
+
"service",
|
|
375
|
+
"assume"
|
|
373
376
|
],
|
|
374
377
|
required: false,
|
|
375
|
-
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."
|
|
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."
|
|
376
379
|
},
|
|
377
380
|
{
|
|
378
381
|
name: "computer_id",
|
|
@@ -466,7 +469,7 @@ Agent Kit calls this from the page with a customer access token of this agent; y
|
|
|
466
469
|
{
|
|
467
470
|
name: "agent_id",
|
|
468
471
|
sdkName: "agent_id",
|
|
469
|
-
description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for."
|
|
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_…."
|
|
470
473
|
}
|
|
471
474
|
],
|
|
472
475
|
query: []
|
|
@@ -484,7 +487,7 @@ Agent Kit calls this from the page with a customer access token of this agent; y
|
|
|
484
487
|
{
|
|
485
488
|
name: "agent_id",
|
|
486
489
|
sdkName: "agent_id",
|
|
487
|
-
description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name."
|
|
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_…."
|
|
488
491
|
}
|
|
489
492
|
],
|
|
490
493
|
query: []
|
|
@@ -504,7 +507,7 @@ Call this from your backend with your API key, or from the console. Customers fo
|
|
|
504
507
|
{
|
|
505
508
|
name: "agent_id",
|
|
506
509
|
sdkName: "agent_id",
|
|
507
|
-
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_…."
|
|
508
511
|
}
|
|
509
512
|
],
|
|
510
513
|
query: [
|
|
@@ -559,7 +562,7 @@ No Authorization header is required: the grant code or the publishable key is th
|
|
|
559
562
|
{
|
|
560
563
|
name: "agent_id",
|
|
561
564
|
sdkName: "agent_id",
|
|
562
|
-
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_…."
|
|
563
566
|
}
|
|
564
567
|
],
|
|
565
568
|
query: [],
|
|
@@ -583,7 +586,7 @@ Send the current customer access token as the Bearer credential, with no body, w
|
|
|
583
586
|
{
|
|
584
587
|
name: "agent_id",
|
|
585
588
|
sdkName: "agent_id",
|
|
586
|
-
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_…."
|
|
587
590
|
}
|
|
588
591
|
],
|
|
589
592
|
query: []
|
|
@@ -603,7 +606,7 @@ Send the current customer access token as the Bearer credential, with no body, a
|
|
|
603
606
|
{
|
|
604
607
|
name: "agent_id",
|
|
605
608
|
sdkName: "agent_id",
|
|
606
|
-
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_…."
|
|
607
610
|
}
|
|
608
611
|
],
|
|
609
612
|
query: []
|
|
@@ -623,7 +626,7 @@ Call this from your backend with your API key after your own login succeeds, the
|
|
|
623
626
|
{
|
|
624
627
|
name: "agent_id",
|
|
625
628
|
sdkName: "agent_id",
|
|
626
|
-
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_…."
|
|
627
630
|
}
|
|
628
631
|
],
|
|
629
632
|
query: [],
|
|
@@ -715,7 +718,7 @@ Develop only. Set confirm to the exact customer id; a missing or different confi
|
|
|
715
718
|
{
|
|
716
719
|
name: "agent_id",
|
|
717
720
|
sdkName: "agent_id",
|
|
718
|
-
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_…."
|
|
719
722
|
},
|
|
720
723
|
{
|
|
721
724
|
name: "customer_id",
|
|
@@ -747,7 +750,7 @@ Use the customer id from the list or your own customer_id. An unknown customer r
|
|
|
747
750
|
{
|
|
748
751
|
name: "agent_id",
|
|
749
752
|
sdkName: "agent_id",
|
|
750
|
-
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_…."
|
|
751
754
|
},
|
|
752
755
|
{
|
|
753
756
|
name: "customer_id",
|
|
@@ -772,7 +775,7 @@ Blocks the customer, then ends every live sign-in the way logout does: each acce
|
|
|
772
775
|
{
|
|
773
776
|
name: "agent_id",
|
|
774
777
|
sdkName: "agent_id",
|
|
775
|
-
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_…."
|
|
776
779
|
},
|
|
777
780
|
{
|
|
778
781
|
name: "customer_id",
|
|
@@ -797,7 +800,7 @@ Use the same agent_id and customer id as the confirmed DELETE. Status is pending
|
|
|
797
800
|
{
|
|
798
801
|
name: "agent_id",
|
|
799
802
|
sdkName: "agent_id",
|
|
800
|
-
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_…."
|
|
801
804
|
},
|
|
802
805
|
{
|
|
803
806
|
name: "customer_id",
|
|
@@ -822,7 +825,7 @@ Ends every live sign-in of the customer, revoking each access token and closing
|
|
|
822
825
|
{
|
|
823
826
|
name: "agent_id",
|
|
824
827
|
sdkName: "agent_id",
|
|
825
|
-
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_…."
|
|
826
829
|
},
|
|
827
830
|
{
|
|
828
831
|
name: "customer_id",
|
|
@@ -847,7 +850,7 @@ Idempotent. Access tokens revoked while the customer was blocked stay revoked; s
|
|
|
847
850
|
{
|
|
848
851
|
name: "agent_id",
|
|
849
852
|
sdkName: "agent_id",
|
|
850
|
-
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_…."
|
|
851
854
|
},
|
|
852
855
|
{
|
|
853
856
|
name: "customer_id",
|
|
@@ -870,7 +873,7 @@ Idempotent. Access tokens revoked while the customer was blocked stay revoked; s
|
|
|
870
873
|
{
|
|
871
874
|
name: "agent_id",
|
|
872
875
|
sdkName: "agent_id",
|
|
873
|
-
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_…."
|
|
874
877
|
}
|
|
875
878
|
],
|
|
876
879
|
query: []
|
|
@@ -888,7 +891,7 @@ Idempotent. Access tokens revoked while the customer was blocked stay revoked; s
|
|
|
888
891
|
{
|
|
889
892
|
name: "agent_id",
|
|
890
893
|
sdkName: "agent_id",
|
|
891
|
-
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_…."
|
|
892
895
|
}
|
|
893
896
|
],
|
|
894
897
|
query: [
|
|
@@ -919,7 +922,7 @@ Idempotent. Access tokens revoked while the customer was blocked stay revoked; s
|
|
|
919
922
|
{
|
|
920
923
|
name: "agent_id",
|
|
921
924
|
sdkName: "agent_id",
|
|
922
|
-
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_…."
|
|
923
926
|
},
|
|
924
927
|
{
|
|
925
928
|
name: "version",
|
|
@@ -1976,7 +1979,7 @@ clears to null; an empty string is stored as an empty string.`
|
|
|
1976
1979
|
resource: "agent.sessions",
|
|
1977
1980
|
method: "create",
|
|
1978
1981
|
summary: "Create session",
|
|
1979
|
-
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.`,
|
|
1980
1983
|
http: "POST",
|
|
1981
1984
|
path: "/agent/v1/sessions",
|
|
1982
1985
|
streaming: "no",
|
|
@@ -3617,7 +3620,7 @@ file at the root of that directory.`
|
|
|
3617
3620
|
resource: "application.workers.grants",
|
|
3618
3621
|
method: "create",
|
|
3619
3622
|
summary: "Create grant",
|
|
3620
|
-
description: "
|
|
3623
|
+
description: "Record access to an organization-owned database or knowledge base, all organization files (files, id *), or models (models, id *, read only). Each resource and optional alias must be unique within this Worker. Foreign and missing resources both return RESOURCE_NOT_FOUND (404); an unavailable resource service returns PROVIDER_CAPACITY (503, retryable).",
|
|
3621
3624
|
http: "POST",
|
|
3622
3625
|
path: "/application/v1/workers/{worker_id}/grants",
|
|
3623
3626
|
streaming: "no",
|
|
@@ -3637,7 +3640,13 @@ file at the root of that directory.`
|
|
|
3637
3640
|
name: "resource",
|
|
3638
3641
|
type: "object",
|
|
3639
3642
|
required: true,
|
|
3640
|
-
description: "Resource to grant."
|
|
3643
|
+
description: "Resource to grant. Each (type, id) may be granted once per Worker; duplicates return GRANT_CONFLICT (409)."
|
|
3644
|
+
},
|
|
3645
|
+
{
|
|
3646
|
+
name: "alias",
|
|
3647
|
+
type: "string",
|
|
3648
|
+
required: false,
|
|
3649
|
+
description: "Optional name, unique within this Worker. Available for reuse after the grant is deleted."
|
|
3641
3650
|
},
|
|
3642
3651
|
{
|
|
3643
3652
|
name: "access",
|
|
@@ -3647,7 +3656,7 @@ file at the root of that directory.`
|
|
|
3647
3656
|
"read_write"
|
|
3648
3657
|
],
|
|
3649
3658
|
required: true,
|
|
3650
|
-
description: "Access level."
|
|
3659
|
+
description: "Access level; models accepts read only."
|
|
3651
3660
|
}
|
|
3652
3661
|
]
|
|
3653
3662
|
}
|
|
@@ -6413,7 +6422,7 @@ file at the root of that directory.`
|
|
|
6413
6422
|
resource: "automation.workflows",
|
|
6414
6423
|
method: "create",
|
|
6415
6424
|
summary: "Create a workflow",
|
|
6416
|
-
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.',
|
|
6425
|
+
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. To pause for a person, call praxis/approval (it opens a human task; the step output is the decision); agents answer with praxis.automation.humanTasks.respond on behalf of their user. Guide: /docs/developers/automation/guides/approvals 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.',
|
|
6417
6426
|
http: "POST",
|
|
6418
6427
|
path: "/automation/v1/workflows",
|
|
6419
6428
|
streaming: "no",
|
|
@@ -7396,6 +7405,220 @@ file at the root of that directory.`
|
|
|
7396
7405
|
]
|
|
7397
7406
|
}
|
|
7398
7407
|
},
|
|
7408
|
+
{
|
|
7409
|
+
resource: "canvas.canvases",
|
|
7410
|
+
method: "list",
|
|
7411
|
+
summary: "List canvases",
|
|
7412
|
+
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.",
|
|
7413
|
+
http: "GET",
|
|
7414
|
+
path: "/canvas/v1/canvases",
|
|
7415
|
+
streaming: "no",
|
|
7416
|
+
pagination: true,
|
|
7417
|
+
pathParams: [],
|
|
7418
|
+
query: [
|
|
7419
|
+
{
|
|
7420
|
+
name: "limit",
|
|
7421
|
+
type: "integer",
|
|
7422
|
+
required: false,
|
|
7423
|
+
description: "Maximum canvases to return per page, from 1 to 100; defaults to 50 when omitted."
|
|
7424
|
+
},
|
|
7425
|
+
{
|
|
7426
|
+
name: "cursor",
|
|
7427
|
+
type: "string",
|
|
7428
|
+
required: false,
|
|
7429
|
+
description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
|
|
7430
|
+
}
|
|
7431
|
+
]
|
|
7432
|
+
},
|
|
7433
|
+
{
|
|
7434
|
+
resource: "canvas.canvases",
|
|
7435
|
+
method: "create",
|
|
7436
|
+
summary: "Create canvas",
|
|
7437
|
+
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.",
|
|
7438
|
+
http: "POST",
|
|
7439
|
+
path: "/canvas/v1/canvases",
|
|
7440
|
+
streaming: "no",
|
|
7441
|
+
pagination: false,
|
|
7442
|
+
pathParams: [],
|
|
7443
|
+
query: [],
|
|
7444
|
+
body: {
|
|
7445
|
+
required: false,
|
|
7446
|
+
fields: [
|
|
7447
|
+
{
|
|
7448
|
+
name: "name",
|
|
7449
|
+
type: "string",
|
|
7450
|
+
required: false,
|
|
7451
|
+
description: "Display name for the new canvas, at most 200 characters; omission uses Untitled."
|
|
7452
|
+
}
|
|
7453
|
+
]
|
|
7454
|
+
}
|
|
7455
|
+
},
|
|
7456
|
+
{
|
|
7457
|
+
resource: "canvas.canvases",
|
|
7458
|
+
method: "delete",
|
|
7459
|
+
summary: "Delete canvas",
|
|
7460
|
+
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.",
|
|
7461
|
+
http: "DELETE",
|
|
7462
|
+
path: "/canvas/v1/canvases/{canvas_id}",
|
|
7463
|
+
streaming: "no",
|
|
7464
|
+
pagination: false,
|
|
7465
|
+
pathParams: [
|
|
7466
|
+
{
|
|
7467
|
+
name: "canvas_id",
|
|
7468
|
+
sdkName: "canvas_id",
|
|
7469
|
+
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."
|
|
7470
|
+
}
|
|
7471
|
+
],
|
|
7472
|
+
query: []
|
|
7473
|
+
},
|
|
7474
|
+
{
|
|
7475
|
+
resource: "canvas.canvases",
|
|
7476
|
+
method: "retrieve",
|
|
7477
|
+
summary: "Retrieve canvas",
|
|
7478
|
+
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.",
|
|
7479
|
+
http: "GET",
|
|
7480
|
+
path: "/canvas/v1/canvases/{canvas_id}",
|
|
7481
|
+
streaming: "no",
|
|
7482
|
+
pagination: false,
|
|
7483
|
+
pathParams: [
|
|
7484
|
+
{
|
|
7485
|
+
name: "canvas_id",
|
|
7486
|
+
sdkName: "canvas_id",
|
|
7487
|
+
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."
|
|
7488
|
+
}
|
|
7489
|
+
],
|
|
7490
|
+
query: []
|
|
7491
|
+
},
|
|
7492
|
+
{
|
|
7493
|
+
resource: "canvas.canvases.images",
|
|
7494
|
+
method: "list",
|
|
7495
|
+
summary: "Render canvas nodes",
|
|
7496
|
+
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.",
|
|
7497
|
+
http: "GET",
|
|
7498
|
+
path: "/canvas/v1/canvases/{canvas_id}/images",
|
|
7499
|
+
streaming: "no",
|
|
7500
|
+
pagination: false,
|
|
7501
|
+
pathParams: [
|
|
7502
|
+
{
|
|
7503
|
+
name: "canvas_id",
|
|
7504
|
+
sdkName: "canvas_id",
|
|
7505
|
+
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."
|
|
7506
|
+
}
|
|
7507
|
+
],
|
|
7508
|
+
query: [
|
|
7509
|
+
{
|
|
7510
|
+
name: "ids",
|
|
7511
|
+
type: "string",
|
|
7512
|
+
required: true,
|
|
7513
|
+
description: "Comma-separated list of 1–4 node ids to render, from retrieve, execute.created or execute.screenshots."
|
|
7514
|
+
},
|
|
7515
|
+
{
|
|
7516
|
+
name: "scale",
|
|
7517
|
+
type: "number",
|
|
7518
|
+
required: false,
|
|
7519
|
+
description: "Output pixel scale relative to canvas dimensions, from 0.25 to 4 inclusive; defaults to 1 when omitted."
|
|
7520
|
+
},
|
|
7521
|
+
{
|
|
7522
|
+
name: "format",
|
|
7523
|
+
type: "string",
|
|
7524
|
+
enum: [
|
|
7525
|
+
"png"
|
|
7526
|
+
],
|
|
7527
|
+
required: false,
|
|
7528
|
+
description: "Image encoding; png produces a PNG data URL and is the only supported value. Omit to use png."
|
|
7529
|
+
}
|
|
7530
|
+
]
|
|
7531
|
+
},
|
|
7532
|
+
{
|
|
7533
|
+
resource: "canvas.canvases.nodes",
|
|
7534
|
+
method: "list",
|
|
7535
|
+
summary: "Read canvas nodes",
|
|
7536
|
+
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.",
|
|
7537
|
+
http: "GET",
|
|
7538
|
+
path: "/canvas/v1/canvases/{canvas_id}/nodes",
|
|
7539
|
+
streaming: "no",
|
|
7540
|
+
pagination: false,
|
|
7541
|
+
pathParams: [
|
|
7542
|
+
{
|
|
7543
|
+
name: "canvas_id",
|
|
7544
|
+
sdkName: "canvas_id",
|
|
7545
|
+
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."
|
|
7546
|
+
}
|
|
7547
|
+
],
|
|
7548
|
+
query: [
|
|
7549
|
+
{
|
|
7550
|
+
name: "ids",
|
|
7551
|
+
type: "string",
|
|
7552
|
+
required: true,
|
|
7553
|
+
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."
|
|
7554
|
+
},
|
|
7555
|
+
{
|
|
7556
|
+
name: "depth",
|
|
7557
|
+
type: "integer",
|
|
7558
|
+
required: false,
|
|
7559
|
+
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."
|
|
7560
|
+
}
|
|
7561
|
+
]
|
|
7562
|
+
},
|
|
7563
|
+
{
|
|
7564
|
+
resource: "canvas.canvases",
|
|
7565
|
+
method: "execute",
|
|
7566
|
+
summary: "Execute canvas script",
|
|
7567
|
+
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.
|
|
7568
|
+
|
|
7569
|
+
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:
|
|
7570
|
+
|
|
7571
|
+
\`\`\`js
|
|
7572
|
+
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)
|
|
7573
|
+
\`\`\`
|
|
7574
|
+
|
|
7575
|
+
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 [Canvas node reference](https://deepraxis.com/en/docs/developers/canvas/nodes) for node content.
|
|
7576
|
+
|
|
7577
|
+
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.
|
|
7578
|
+
`,
|
|
7579
|
+
http: "POST",
|
|
7580
|
+
path: "/canvas/v1/canvases/{canvas_id}:execute",
|
|
7581
|
+
streaming: "no",
|
|
7582
|
+
pagination: false,
|
|
7583
|
+
pathParams: [
|
|
7584
|
+
{
|
|
7585
|
+
name: "canvas_id",
|
|
7586
|
+
sdkName: "canvas_id",
|
|
7587
|
+
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."
|
|
7588
|
+
}
|
|
7589
|
+
],
|
|
7590
|
+
query: [],
|
|
7591
|
+
body: {
|
|
7592
|
+
required: true,
|
|
7593
|
+
fields: [
|
|
7594
|
+
{
|
|
7595
|
+
name: "script",
|
|
7596
|
+
type: "string",
|
|
7597
|
+
required: false,
|
|
7598
|
+
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."
|
|
7599
|
+
},
|
|
7600
|
+
{
|
|
7601
|
+
name: "edit_id",
|
|
7602
|
+
type: "string",
|
|
7603
|
+
required: false,
|
|
7604
|
+
description: "Saved failed-script identifier from error.details.edit_id; use with edits instead of script within ten minutes of the failure."
|
|
7605
|
+
},
|
|
7606
|
+
{
|
|
7607
|
+
name: "edits",
|
|
7608
|
+
type: "array",
|
|
7609
|
+
itemType: "object",
|
|
7610
|
+
required: false,
|
|
7611
|
+
description: "Text replacements applied to the source identified by edit_id before rerunning; use error line, column or rejection to choose the correction."
|
|
7612
|
+
},
|
|
7613
|
+
{
|
|
7614
|
+
name: "expected_version",
|
|
7615
|
+
type: "string",
|
|
7616
|
+
required: false,
|
|
7617
|
+
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."
|
|
7618
|
+
}
|
|
7619
|
+
]
|
|
7620
|
+
}
|
|
7621
|
+
},
|
|
7399
7622
|
{
|
|
7400
7623
|
resource: "database.databases",
|
|
7401
7624
|
method: "list",
|
|
@@ -12128,7 +12351,8 @@ for more details.`
|
|
|
12128
12351
|
"openai.images.edits",
|
|
12129
12352
|
"openai.images.generations",
|
|
12130
12353
|
"openai.responses",
|
|
12131
|
-
"openai.videos"
|
|
12354
|
+
"openai.videos",
|
|
12355
|
+
"typesafe.systemone"
|
|
12132
12356
|
],
|
|
12133
12357
|
required: false,
|
|
12134
12358
|
description: "Match any comma-separated declared protocol ID; omitted or empty includes all models. Combined with type and output_modalities using AND. Invalid IDs return 400 with all legal values."
|
|
@@ -12703,6 +12927,47 @@ for more details.`
|
|
|
12703
12927
|
],
|
|
12704
12928
|
query: []
|
|
12705
12929
|
},
|
|
12930
|
+
{
|
|
12931
|
+
resource: "model.systemone",
|
|
12932
|
+
method: "create",
|
|
12933
|
+
summary: "Ask structured decision questions",
|
|
12934
|
+
description: "Ask typed questions about a state and get calibrated probabilities instead of generated text. Same request and response as TypeSafe System One. Use model ids from model.models.list declaring typesafe.systemone. Send one or more noul, choice or score questions; answers use the same question ids. Input tokens are charged at the catalog input price; output tokens are free. usage.cost and X-Praxis-Cost-Usd expose the same customer charge in USD. box questions and assets are unsupported and return 400: images are not supported. Unknown top-level fields pass unchanged to the native upstream.",
|
|
12935
|
+
http: "POST",
|
|
12936
|
+
path: "/model/v1/systemone",
|
|
12937
|
+
streaming: "no",
|
|
12938
|
+
pagination: false,
|
|
12939
|
+
pathParams: [],
|
|
12940
|
+
query: [],
|
|
12941
|
+
body: {
|
|
12942
|
+
required: true,
|
|
12943
|
+
fields: [
|
|
12944
|
+
{
|
|
12945
|
+
name: "model",
|
|
12946
|
+
type: "string",
|
|
12947
|
+
required: true,
|
|
12948
|
+
description: "Published model id from model.models.list with supported_apis containing typesafe.systemone; returned unchanged in the response."
|
|
12949
|
+
},
|
|
12950
|
+
{
|
|
12951
|
+
name: "state",
|
|
12952
|
+
type: "object",
|
|
12953
|
+
required: true,
|
|
12954
|
+
description: "Shared content evaluated by every question, supplied as text, a JSON object or an array."
|
|
12955
|
+
},
|
|
12956
|
+
{
|
|
12957
|
+
name: "questions",
|
|
12958
|
+
type: "object",
|
|
12959
|
+
required: true,
|
|
12960
|
+
description: "Non-empty map of caller-chosen question ids to typed questions; answers preserve these ids. noul evaluates yes/no, choice selects a named option, score rates ordered levels. box is unsupported."
|
|
12961
|
+
},
|
|
12962
|
+
{
|
|
12963
|
+
name: "assets",
|
|
12964
|
+
type: "object",
|
|
12965
|
+
required: false,
|
|
12966
|
+
description: "Unsupported image assets. Supplying this field, including null or an empty collection, returns 400: images are not supported."
|
|
12967
|
+
}
|
|
12968
|
+
]
|
|
12969
|
+
}
|
|
12970
|
+
},
|
|
12706
12971
|
{
|
|
12707
12972
|
resource: "model.videos",
|
|
12708
12973
|
method: "list",
|
|
@@ -19231,6 +19496,23 @@ var remixVideo = (options) => (options.client ?? client).post({
|
|
|
19231
19496
|
url: "/model/v1/videos/{video_id}/remix",
|
|
19232
19497
|
...options
|
|
19233
19498
|
});
|
|
19499
|
+
var createSystemone = (options) => (options.client ?? client).post({
|
|
19500
|
+
security: [{
|
|
19501
|
+
key: "BearerAuth",
|
|
19502
|
+
scheme: "bearer",
|
|
19503
|
+
type: "http"
|
|
19504
|
+
}, {
|
|
19505
|
+
key: "ApiKeyAuth",
|
|
19506
|
+
name: "X-API-Key",
|
|
19507
|
+
type: "apiKey"
|
|
19508
|
+
}],
|
|
19509
|
+
url: "/model/v1/systemone",
|
|
19510
|
+
...options,
|
|
19511
|
+
headers: {
|
|
19512
|
+
"Content-Type": "application/json",
|
|
19513
|
+
...options.headers
|
|
19514
|
+
}
|
|
19515
|
+
});
|
|
19234
19516
|
var createAudioTranscription = (options) => (options.client ?? client).post({
|
|
19235
19517
|
...formDataBodySerializer,
|
|
19236
19518
|
security: [{
|
|
@@ -22017,6 +22299,77 @@ var automationHumanTasksDelegate = (options) => (options.client ?? client).post(
|
|
|
22017
22299
|
...options.headers
|
|
22018
22300
|
}
|
|
22019
22301
|
});
|
|
22302
|
+
var canvasListCanvases = (options) => (options?.client ?? client).get({
|
|
22303
|
+
security: [{
|
|
22304
|
+
key: "canvas-bearerAuth",
|
|
22305
|
+
scheme: "bearer",
|
|
22306
|
+
type: "http"
|
|
22307
|
+
}],
|
|
22308
|
+
url: "/canvas/v1/canvases",
|
|
22309
|
+
...options
|
|
22310
|
+
});
|
|
22311
|
+
var canvasCreateCanvas = (options) => (options?.client ?? client).post({
|
|
22312
|
+
security: [{
|
|
22313
|
+
key: "canvas-bearerAuth",
|
|
22314
|
+
scheme: "bearer",
|
|
22315
|
+
type: "http"
|
|
22316
|
+
}],
|
|
22317
|
+
url: "/canvas/v1/canvases",
|
|
22318
|
+
...options,
|
|
22319
|
+
headers: {
|
|
22320
|
+
"Content-Type": "application/json",
|
|
22321
|
+
...options?.headers
|
|
22322
|
+
}
|
|
22323
|
+
});
|
|
22324
|
+
var canvasDeleteCanvas = (options) => (options.client ?? client).delete({
|
|
22325
|
+
security: [{
|
|
22326
|
+
key: "canvas-bearerAuth",
|
|
22327
|
+
scheme: "bearer",
|
|
22328
|
+
type: "http"
|
|
22329
|
+
}],
|
|
22330
|
+
url: "/canvas/v1/canvases/{canvas_id}",
|
|
22331
|
+
...options
|
|
22332
|
+
});
|
|
22333
|
+
var canvasRetrieveCanvas = (options) => (options.client ?? client).get({
|
|
22334
|
+
security: [{
|
|
22335
|
+
key: "canvas-bearerAuth",
|
|
22336
|
+
scheme: "bearer",
|
|
22337
|
+
type: "http"
|
|
22338
|
+
}],
|
|
22339
|
+
url: "/canvas/v1/canvases/{canvas_id}",
|
|
22340
|
+
...options
|
|
22341
|
+
});
|
|
22342
|
+
var canvasListNodes = (options) => (options.client ?? client).get({
|
|
22343
|
+
security: [{
|
|
22344
|
+
key: "canvas-bearerAuth",
|
|
22345
|
+
scheme: "bearer",
|
|
22346
|
+
type: "http"
|
|
22347
|
+
}],
|
|
22348
|
+
url: "/canvas/v1/canvases/{canvas_id}/nodes",
|
|
22349
|
+
...options
|
|
22350
|
+
});
|
|
22351
|
+
var canvasListImages = (options) => (options.client ?? client).get({
|
|
22352
|
+
security: [{
|
|
22353
|
+
key: "canvas-bearerAuth",
|
|
22354
|
+
scheme: "bearer",
|
|
22355
|
+
type: "http"
|
|
22356
|
+
}],
|
|
22357
|
+
url: "/canvas/v1/canvases/{canvas_id}/images",
|
|
22358
|
+
...options
|
|
22359
|
+
});
|
|
22360
|
+
var canvasExecute = (options) => (options.client ?? client).post({
|
|
22361
|
+
security: [{
|
|
22362
|
+
key: "canvas-bearerAuth",
|
|
22363
|
+
scheme: "bearer",
|
|
22364
|
+
type: "http"
|
|
22365
|
+
}],
|
|
22366
|
+
url: "/canvas/v1/canvases/{canvas_id}:execute",
|
|
22367
|
+
...options,
|
|
22368
|
+
headers: {
|
|
22369
|
+
"Content-Type": "application/json",
|
|
22370
|
+
...options.headers
|
|
22371
|
+
}
|
|
22372
|
+
});
|
|
22020
22373
|
var databaseListDatabases = (options) => (options?.client ?? client).get({
|
|
22021
22374
|
security: [{
|
|
22022
22375
|
key: "database-bearerAuth",
|
|
@@ -24623,6 +24976,23 @@ function createBrowser(transport) {
|
|
|
24623
24976
|
}
|
|
24624
24977
|
};
|
|
24625
24978
|
}
|
|
24979
|
+
function createCanvas(transport) {
|
|
24980
|
+
return {
|
|
24981
|
+
canvases: {
|
|
24982
|
+
create: bind(transport, canvasCreateCanvas),
|
|
24983
|
+
delete: bind(transport, canvasDeleteCanvas),
|
|
24984
|
+
execute: bind(transport, canvasExecute),
|
|
24985
|
+
images: {
|
|
24986
|
+
list: bind(transport, canvasListImages)
|
|
24987
|
+
},
|
|
24988
|
+
list: bindPage(transport, canvasListCanvases),
|
|
24989
|
+
nodes: {
|
|
24990
|
+
list: bind(transport, canvasListNodes)
|
|
24991
|
+
},
|
|
24992
|
+
retrieve: bind(transport, canvasRetrieveCanvas)
|
|
24993
|
+
}
|
|
24994
|
+
};
|
|
24995
|
+
}
|
|
24626
24996
|
function createDatabase(transport) {
|
|
24627
24997
|
return {
|
|
24628
24998
|
databases: {
|
|
@@ -24865,6 +25235,9 @@ function createModel(transport) {
|
|
|
24865
25235
|
},
|
|
24866
25236
|
retrieve: bind(transport, retrieveResponse)
|
|
24867
25237
|
},
|
|
25238
|
+
systemone: {
|
|
25239
|
+
create: bind(transport, createSystemone)
|
|
25240
|
+
},
|
|
24868
25241
|
videos: {
|
|
24869
25242
|
create: bind(transport, (options) => createVideo({ ...options, bodySerializer: multipartBodySerializer, headers: { "Content-Type": null, ...options.headers } })),
|
|
24870
25243
|
delete: bind(transport, deleteVideo),
|
|
@@ -25112,6 +25485,7 @@ var resourceFactories = {
|
|
|
25112
25485
|
application: createApplication,
|
|
25113
25486
|
automation: createAutomation,
|
|
25114
25487
|
browser: createBrowser,
|
|
25488
|
+
canvas: createCanvas,
|
|
25115
25489
|
database: createDatabase,
|
|
25116
25490
|
file: createFile,
|
|
25117
25491
|
knowledge: createKnowledge,
|
|
@@ -28025,7 +28399,7 @@ function startProgress(ctx, write = (text) => writeOutput({ stderr: text })) {
|
|
|
28025
28399
|
}
|
|
28026
28400
|
|
|
28027
28401
|
// src/main.ts
|
|
28028
|
-
var version = "0.2.0-dev.
|
|
28402
|
+
var version = "0.2.0-dev.349f88a";
|
|
28029
28403
|
var commands = commandTree(operations);
|
|
28030
28404
|
var manual = [...workflows.map((w) => w.words), [API_WORD]];
|
|
28031
28405
|
function route(argv) {
|