@deepraxis/sdk 0.1.1-dev.d775f1e → 0.1.1-dev.ea4a5dd
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +118 -1
- package/README.md +1 -1
- package/dist/automation.d.ts +7 -0
- package/dist/core/client.d.ts +5 -1
- package/dist/core/client.js +10 -0
- package/dist/core/transport.js +1 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +259 -20
- package/dist/generated/sdk.gen.js +707 -19
- package/dist/generated/types.gen.d.ts +11016 -6421
- package/dist/helpers/application-build.d.ts +10 -0
- package/dist/helpers/application-build.js +98 -0
- package/dist/helpers/application-publish.d.ts +8 -0
- package/dist/helpers/application-publish.js +26 -9
- package/dist/helpers/browser-connect.d.ts +78 -0
- package/dist/helpers/browser-connect.js +161 -0
- package/dist/helpers/browser-decisions.d.ts +44 -0
- package/dist/helpers/browser-decisions.js +84 -0
- package/dist/helpers/browser-documentation.d.ts +2 -0
- package/dist/helpers/browser-documentation.js +47 -0
- package/dist/helpers/file-upload.d.ts +2 -2
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +1110 -152
- package/dist/operations.generated.js +1343 -159
- package/dist/resources.generated.d.ts +220 -38
- package/dist/resources.generated.js +77 -0
- package/package.json +1 -1
|
@@ -2,7 +2,7 @@ export declare const operations: readonly [{
|
|
|
2
2
|
readonly resource: "agent.agents";
|
|
3
3
|
readonly method: "list";
|
|
4
4
|
readonly summary: "List agents";
|
|
5
|
-
readonly 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
|
|
5
|
+
readonly 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.";
|
|
6
6
|
readonly http: "GET";
|
|
7
7
|
readonly path: "/agent/v1/agents";
|
|
8
8
|
readonly streaming: "no";
|
|
@@ -37,7 +37,7 @@ export declare const operations: readonly [{
|
|
|
37
37
|
}, {
|
|
38
38
|
readonly name: "kind";
|
|
39
39
|
readonly type: "string";
|
|
40
|
-
readonly enum: readonly ["personal", "service"];
|
|
40
|
+
readonly enum: readonly ["general", "personal", "service", "assume"];
|
|
41
41
|
readonly required: false;
|
|
42
42
|
readonly description: "Filter agents by their immutable kind, including agents created before kind was recorded.";
|
|
43
43
|
}];
|
|
@@ -45,7 +45,7 @@ export declare const operations: readonly [{
|
|
|
45
45
|
readonly resource: "agent.agents";
|
|
46
46
|
readonly method: "create";
|
|
47
47
|
readonly summary: "Create agent";
|
|
48
|
-
readonly 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\"}]}.";
|
|
48
|
+
readonly 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.";
|
|
49
49
|
readonly http: "POST";
|
|
50
50
|
readonly path: "/agent/v1/agents";
|
|
51
51
|
readonly streaming: "no";
|
|
@@ -57,8 +57,8 @@ export declare const operations: readonly [{
|
|
|
57
57
|
readonly fields: readonly [{
|
|
58
58
|
readonly name: "model";
|
|
59
59
|
readonly type: "object";
|
|
60
|
-
readonly required:
|
|
61
|
-
readonly 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.";
|
|
60
|
+
readonly required: false;
|
|
61
|
+
readonly 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.";
|
|
62
62
|
}, {
|
|
63
63
|
readonly name: "name";
|
|
64
64
|
readonly type: "string";
|
|
@@ -107,13 +107,13 @@ export declare const operations: readonly [{
|
|
|
107
107
|
readonly type: "array";
|
|
108
108
|
readonly itemType: "object";
|
|
109
109
|
readonly required: false;
|
|
110
|
-
readonly 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.";
|
|
110
|
+
readonly 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.";
|
|
111
111
|
}, {
|
|
112
112
|
readonly name: "kind";
|
|
113
113
|
readonly type: "string";
|
|
114
|
-
readonly enum: readonly ["personal", "service"];
|
|
114
|
+
readonly enum: readonly ["general", "personal", "service", "assume"];
|
|
115
115
|
readonly required: false;
|
|
116
|
-
readonly description: "Immutable agent kind. personal
|
|
116
|
+
readonly 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.";
|
|
117
117
|
}, {
|
|
118
118
|
readonly name: "computer_id";
|
|
119
119
|
readonly type: "string";
|
|
@@ -155,7 +155,7 @@ export declare const operations: readonly [{
|
|
|
155
155
|
readonly name: "avatar";
|
|
156
156
|
readonly type: "string";
|
|
157
157
|
readonly required: false;
|
|
158
|
-
readonly 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.
|
|
158
|
+
readonly 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.";
|
|
159
159
|
}, {
|
|
160
160
|
readonly name: "environment_id";
|
|
161
161
|
readonly type: "string";
|
|
@@ -187,7 +187,7 @@ export declare const operations: readonly [{
|
|
|
187
187
|
readonly pathParams: readonly [{
|
|
188
188
|
readonly name: "agent_id";
|
|
189
189
|
readonly sdkName: "agent_id";
|
|
190
|
-
readonly 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.";
|
|
190
|
+
readonly 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_….";
|
|
191
191
|
}];
|
|
192
192
|
readonly query: readonly [{
|
|
193
193
|
readonly name: "version";
|
|
@@ -199,7 +199,7 @@ export declare const operations: readonly [{
|
|
|
199
199
|
readonly resource: "agent.agents";
|
|
200
200
|
readonly method: "update";
|
|
201
201
|
readonly summary: "Update agent";
|
|
202
|
-
readonly 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.";
|
|
202
|
+
readonly 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.";
|
|
203
203
|
readonly http: "POST";
|
|
204
204
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
205
205
|
readonly streaming: "no";
|
|
@@ -207,7 +207,7 @@ export declare const operations: readonly [{
|
|
|
207
207
|
readonly pathParams: readonly [{
|
|
208
208
|
readonly name: "agent_id";
|
|
209
209
|
readonly sdkName: "agent_id";
|
|
210
|
-
readonly 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.";
|
|
210
|
+
readonly 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_….";
|
|
211
211
|
}];
|
|
212
212
|
readonly query: readonly [];
|
|
213
213
|
readonly body: {
|
|
@@ -232,7 +232,7 @@ export declare const operations: readonly [{
|
|
|
232
232
|
readonly name: "model";
|
|
233
233
|
readonly type: "object";
|
|
234
234
|
readonly required: false;
|
|
235
|
-
readonly 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.";
|
|
235
|
+
readonly 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.";
|
|
236
236
|
}, {
|
|
237
237
|
readonly name: "multiagent";
|
|
238
238
|
readonly type: "object";
|
|
@@ -284,9 +284,9 @@ export declare const operations: readonly [{
|
|
|
284
284
|
}, {
|
|
285
285
|
readonly name: "kind";
|
|
286
286
|
readonly type: "string";
|
|
287
|
-
readonly enum: readonly ["personal", "service"];
|
|
287
|
+
readonly enum: readonly ["general", "personal", "service", "assume"];
|
|
288
288
|
readonly required: false;
|
|
289
|
-
readonly description: "Immutable agent kind. personal
|
|
289
|
+
readonly 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.";
|
|
290
290
|
}, {
|
|
291
291
|
readonly name: "computer_id";
|
|
292
292
|
readonly type: "string";
|
|
@@ -328,7 +328,7 @@ export declare const operations: readonly [{
|
|
|
328
328
|
readonly name: "avatar";
|
|
329
329
|
readonly type: "string";
|
|
330
330
|
readonly required: false;
|
|
331
|
-
readonly 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.
|
|
331
|
+
readonly 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.";
|
|
332
332
|
}, {
|
|
333
333
|
readonly name: "environment_id";
|
|
334
334
|
readonly type: "string";
|
|
@@ -360,7 +360,7 @@ export declare const operations: readonly [{
|
|
|
360
360
|
readonly pathParams: readonly [{
|
|
361
361
|
readonly name: "agent_id";
|
|
362
362
|
readonly sdkName: "agent_id";
|
|
363
|
-
readonly description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.";
|
|
363
|
+
readonly 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_….";
|
|
364
364
|
}];
|
|
365
365
|
readonly query: readonly [];
|
|
366
366
|
}, {
|
|
@@ -375,7 +375,7 @@ export declare const operations: readonly [{
|
|
|
375
375
|
readonly pathParams: readonly [{
|
|
376
376
|
readonly name: "agent_id";
|
|
377
377
|
readonly sdkName: "agent_id";
|
|
378
|
-
readonly 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.";
|
|
378
|
+
readonly 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_….";
|
|
379
379
|
}];
|
|
380
380
|
readonly query: readonly [];
|
|
381
381
|
}, {
|
|
@@ -390,7 +390,7 @@ export declare const operations: readonly [{
|
|
|
390
390
|
readonly pathParams: readonly [{
|
|
391
391
|
readonly name: "agent_id";
|
|
392
392
|
readonly sdkName: "agent_id";
|
|
393
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
393
|
+
readonly 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_….";
|
|
394
394
|
}];
|
|
395
395
|
readonly query: readonly [{
|
|
396
396
|
readonly name: "limit";
|
|
@@ -431,7 +431,7 @@ export declare const operations: readonly [{
|
|
|
431
431
|
readonly pathParams: readonly [{
|
|
432
432
|
readonly name: "agent_id";
|
|
433
433
|
readonly sdkName: "agent_id";
|
|
434
|
-
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
|
|
434
|
+
readonly 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_….";
|
|
435
435
|
}];
|
|
436
436
|
readonly query: readonly [];
|
|
437
437
|
readonly body: {
|
|
@@ -450,7 +450,7 @@ export declare const operations: readonly [{
|
|
|
450
450
|
readonly pathParams: readonly [{
|
|
451
451
|
readonly name: "agent_id";
|
|
452
452
|
readonly sdkName: "agent_id";
|
|
453
|
-
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
|
|
453
|
+
readonly 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_….";
|
|
454
454
|
}];
|
|
455
455
|
readonly query: readonly [];
|
|
456
456
|
}, {
|
|
@@ -465,7 +465,7 @@ export declare const operations: readonly [{
|
|
|
465
465
|
readonly pathParams: readonly [{
|
|
466
466
|
readonly name: "agent_id";
|
|
467
467
|
readonly sdkName: "agent_id";
|
|
468
|
-
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
|
|
468
|
+
readonly 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_….";
|
|
469
469
|
}];
|
|
470
470
|
readonly query: readonly [];
|
|
471
471
|
}, {
|
|
@@ -480,7 +480,7 @@ export declare const operations: readonly [{
|
|
|
480
480
|
readonly pathParams: readonly [{
|
|
481
481
|
readonly name: "agent_id";
|
|
482
482
|
readonly sdkName: "agent_id";
|
|
483
|
-
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
|
|
483
|
+
readonly 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_….";
|
|
484
484
|
}];
|
|
485
485
|
readonly query: readonly [];
|
|
486
486
|
readonly body: {
|
|
@@ -555,7 +555,7 @@ export declare const operations: readonly [{
|
|
|
555
555
|
readonly pathParams: readonly [{
|
|
556
556
|
readonly name: "agent_id";
|
|
557
557
|
readonly sdkName: "agent_id";
|
|
558
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
558
|
+
readonly 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_….";
|
|
559
559
|
}, {
|
|
560
560
|
readonly name: "customer_id";
|
|
561
561
|
readonly sdkName: "customer_id";
|
|
@@ -579,7 +579,7 @@ export declare const operations: readonly [{
|
|
|
579
579
|
readonly pathParams: readonly [{
|
|
580
580
|
readonly name: "agent_id";
|
|
581
581
|
readonly sdkName: "agent_id";
|
|
582
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
582
|
+
readonly 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_….";
|
|
583
583
|
}, {
|
|
584
584
|
readonly name: "customer_id";
|
|
585
585
|
readonly sdkName: "customer_id";
|
|
@@ -598,7 +598,7 @@ export declare const operations: readonly [{
|
|
|
598
598
|
readonly pathParams: readonly [{
|
|
599
599
|
readonly name: "agent_id";
|
|
600
600
|
readonly sdkName: "agent_id";
|
|
601
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
601
|
+
readonly 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_….";
|
|
602
602
|
}, {
|
|
603
603
|
readonly name: "customer_id";
|
|
604
604
|
readonly sdkName: "customer_id";
|
|
@@ -617,7 +617,7 @@ export declare const operations: readonly [{
|
|
|
617
617
|
readonly pathParams: readonly [{
|
|
618
618
|
readonly name: "agent_id";
|
|
619
619
|
readonly sdkName: "agent_id";
|
|
620
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
620
|
+
readonly 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_….";
|
|
621
621
|
}, {
|
|
622
622
|
readonly name: "customer_id";
|
|
623
623
|
readonly sdkName: "customer_id";
|
|
@@ -636,7 +636,7 @@ export declare const operations: readonly [{
|
|
|
636
636
|
readonly pathParams: readonly [{
|
|
637
637
|
readonly name: "agent_id";
|
|
638
638
|
readonly sdkName: "agent_id";
|
|
639
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
639
|
+
readonly 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_….";
|
|
640
640
|
}, {
|
|
641
641
|
readonly name: "customer_id";
|
|
642
642
|
readonly sdkName: "customer_id";
|
|
@@ -655,7 +655,7 @@ export declare const operations: readonly [{
|
|
|
655
655
|
readonly pathParams: readonly [{
|
|
656
656
|
readonly name: "agent_id";
|
|
657
657
|
readonly sdkName: "agent_id";
|
|
658
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
658
|
+
readonly 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_….";
|
|
659
659
|
}, {
|
|
660
660
|
readonly name: "customer_id";
|
|
661
661
|
readonly sdkName: "customer_id";
|
|
@@ -674,7 +674,7 @@ export declare const operations: readonly [{
|
|
|
674
674
|
readonly pathParams: readonly [{
|
|
675
675
|
readonly name: "agent_id";
|
|
676
676
|
readonly sdkName: "agent_id";
|
|
677
|
-
readonly description: "Agent id from creation or listing.";
|
|
677
|
+
readonly 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_….";
|
|
678
678
|
}];
|
|
679
679
|
readonly query: readonly [];
|
|
680
680
|
}, {
|
|
@@ -689,7 +689,7 @@ export declare const operations: readonly [{
|
|
|
689
689
|
readonly pathParams: readonly [{
|
|
690
690
|
readonly name: "agent_id";
|
|
691
691
|
readonly sdkName: "agent_id";
|
|
692
|
-
readonly 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.";
|
|
692
|
+
readonly 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_….";
|
|
693
693
|
}];
|
|
694
694
|
readonly query: readonly [{
|
|
695
695
|
readonly name: "limit";
|
|
@@ -714,7 +714,7 @@ export declare const operations: readonly [{
|
|
|
714
714
|
readonly pathParams: readonly [{
|
|
715
715
|
readonly name: "agent_id";
|
|
716
716
|
readonly sdkName: "agent_id";
|
|
717
|
-
readonly description: "Agent identifier from agents.create or agents.list.";
|
|
717
|
+
readonly 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_….";
|
|
718
718
|
}, {
|
|
719
719
|
readonly name: "version";
|
|
720
720
|
readonly sdkName: "version";
|
|
@@ -747,7 +747,7 @@ export declare const operations: readonly [{
|
|
|
747
747
|
readonly resource: "agent.computers";
|
|
748
748
|
readonly method: "create";
|
|
749
749
|
readonly summary: "Create Computer";
|
|
750
|
-
readonly description: "Create a durable computer: a named machine whose files outlive sessions, for personal agents.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
|
|
750
|
+
readonly description: "Create a durable computer: a named machine whose files outlive sessions, for general and personal agents.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
|
|
751
751
|
readonly http: "POST";
|
|
752
752
|
readonly path: "/agent/v1/computers";
|
|
753
753
|
readonly streaming: "no";
|
|
@@ -1089,7 +1089,7 @@ export declare const operations: readonly [{
|
|
|
1089
1089
|
readonly resource: "agent.deployments";
|
|
1090
1090
|
readonly method: "create";
|
|
1091
1091
|
readonly summary: "Create deployment";
|
|
1092
|
-
readonly 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.";
|
|
1092
|
+
readonly 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.";
|
|
1093
1093
|
readonly http: "POST";
|
|
1094
1094
|
readonly path: "/agent/v1/deployments";
|
|
1095
1095
|
readonly streaming: "no";
|
|
@@ -1155,7 +1155,7 @@ export declare const operations: readonly [{
|
|
|
1155
1155
|
readonly name: "target";
|
|
1156
1156
|
readonly type: "object";
|
|
1157
1157
|
readonly required: false;
|
|
1158
|
-
readonly 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.";
|
|
1158
|
+
readonly 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.";
|
|
1159
1159
|
}];
|
|
1160
1160
|
};
|
|
1161
1161
|
}, {
|
|
@@ -1247,7 +1247,7 @@ export declare const operations: readonly [{
|
|
|
1247
1247
|
readonly name: "target";
|
|
1248
1248
|
readonly type: "object";
|
|
1249
1249
|
readonly required: false;
|
|
1250
|
-
readonly 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.";
|
|
1250
|
+
readonly 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.";
|
|
1251
1251
|
}];
|
|
1252
1252
|
};
|
|
1253
1253
|
}, {
|
|
@@ -1536,7 +1536,7 @@ export declare const operations: readonly [{
|
|
|
1536
1536
|
readonly resource: "agent.sessions";
|
|
1537
1537
|
readonly method: "create";
|
|
1538
1538
|
readonly summary: "Create session";
|
|
1539
|
-
readonly 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
|
|
1539
|
+
readonly 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.";
|
|
1540
1540
|
readonly http: "POST";
|
|
1541
1541
|
readonly path: "/agent/v1/sessions";
|
|
1542
1542
|
readonly streaming: "no";
|
|
@@ -1777,7 +1777,7 @@ export declare const operations: readonly [{
|
|
|
1777
1777
|
readonly resource: "agent.sessions";
|
|
1778
1778
|
readonly method: "compact";
|
|
1779
1779
|
readonly summary: "Compact Session (Extension)";
|
|
1780
|
-
readonly description: "Request session context compaction and retrieve an operation receipt.\n\nAvailable only on /agent/v1. The body may be omitted or {}. Optional instructions must be a string and is forwarded unchanged. Idempotency-Key is forwarded unchanged; a UUID is generated when absent. Returns { type: session_compaction, id, status, reason? }, where id is the operation ID. queued/running return 202; skipped/succeeded/failed return 200. Non-string instructions return 400 invalid_request_error. Missing or inaccessible managed sessions return 404 not_found_error.";
|
|
1780
|
+
readonly description: "Request session context compaction and retrieve an operation receipt.\n\nAvailable only on /agent/v1. The body may be omitted or {}. Optional instructions must be a string and is forwarded unchanged. Idempotency-Key is forwarded unchanged; a UUID is generated when absent. Returns { type: session_compaction, id, status, reason? }, where id is the operation ID. queued/running return 202; skipped/succeeded/failed/cancelled return 200. Non-string instructions return 400 invalid_request_error. Missing or inaccessible managed sessions return 404 not_found_error.";
|
|
1781
1781
|
readonly http: "POST";
|
|
1782
1782
|
readonly path: "/agent/v1/sessions/{session_id}/compact";
|
|
1783
1783
|
readonly streaming: "no";
|
|
@@ -1820,7 +1820,7 @@ export declare const operations: readonly [{
|
|
|
1820
1820
|
readonly resource: "agent.sessions.compactions";
|
|
1821
1821
|
readonly method: "list";
|
|
1822
1822
|
readonly summary: "List Session Compactions (Extension)";
|
|
1823
|
-
readonly description: "Read session compaction history and summaries.\n\nAvailable only on /agent/v1. Returns { data: [...] }. Each entry contains type, id, event_id, trigger, status, model, compacted_message_count, input_tokens_before, input_tokens_after, summary, error and created_at, as recorded by the service. Missing or inaccessible managed sessions return 404 not_found_error.";
|
|
1823
|
+
readonly description: "Read session compaction history and summaries.\n\nAvailable only on /agent/v1. Returns { data: [...], active }. active is the queued or running compaction ({ type: session_compaction, id, status, trigger: manual|auto|idle }), or null when none; manual work takes precedence. Each data entry contains type, id, event_id, trigger, status, model, compacted_message_count, input_tokens_before, input_tokens_after, summary, error and created_at, as recorded by the service. Missing or inaccessible managed sessions return 404 not_found_error.";
|
|
1824
1824
|
readonly http: "GET";
|
|
1825
1825
|
readonly path: "/agent/v1/sessions/{session_id}/compactions";
|
|
1826
1826
|
readonly streaming: "no";
|
|
@@ -1990,9 +1990,9 @@ export declare const operations: readonly [{
|
|
|
1990
1990
|
}];
|
|
1991
1991
|
readonly query: readonly [{
|
|
1992
1992
|
readonly name: "limit";
|
|
1993
|
-
readonly type: "
|
|
1993
|
+
readonly type: "integer";
|
|
1994
1994
|
readonly required: false;
|
|
1995
|
-
readonly description: "Number of
|
|
1995
|
+
readonly description: "Number of resources per page, from 1 to 100; defaults to 100.";
|
|
1996
1996
|
}, {
|
|
1997
1997
|
readonly name: "page";
|
|
1998
1998
|
readonly type: "string";
|
|
@@ -2852,7 +2852,7 @@ export declare const operations: readonly [{
|
|
|
2852
2852
|
readonly resource: "application.workers.grants";
|
|
2853
2853
|
readonly method: "create";
|
|
2854
2854
|
readonly summary: "Create grant";
|
|
2855
|
-
readonly description: "
|
|
2855
|
+
readonly 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).";
|
|
2856
2856
|
readonly http: "POST";
|
|
2857
2857
|
readonly path: "/application/v1/workers/{worker_id}/grants";
|
|
2858
2858
|
readonly streaming: "no";
|
|
@@ -2869,13 +2869,18 @@ export declare const operations: readonly [{
|
|
|
2869
2869
|
readonly name: "resource";
|
|
2870
2870
|
readonly type: "object";
|
|
2871
2871
|
readonly required: true;
|
|
2872
|
-
readonly description: "Resource to grant.";
|
|
2872
|
+
readonly description: "Resource to grant. Each (type, id) may be granted once per Worker; duplicates return GRANT_CONFLICT (409).";
|
|
2873
|
+
}, {
|
|
2874
|
+
readonly name: "alias";
|
|
2875
|
+
readonly type: "string";
|
|
2876
|
+
readonly required: false;
|
|
2877
|
+
readonly description: "Optional name, unique within this Worker. Available for reuse after the grant is deleted.";
|
|
2873
2878
|
}, {
|
|
2874
2879
|
readonly name: "access";
|
|
2875
2880
|
readonly type: "string";
|
|
2876
2881
|
readonly enum: readonly ["read", "read_write"];
|
|
2877
2882
|
readonly required: true;
|
|
2878
|
-
readonly description: "Access level.";
|
|
2883
|
+
readonly description: "Access level; models accepts read only.";
|
|
2879
2884
|
}];
|
|
2880
2885
|
};
|
|
2881
2886
|
}, {
|
|
@@ -3108,7 +3113,7 @@ export declare const operations: readonly [{
|
|
|
3108
3113
|
readonly resource: "automation.actions";
|
|
3109
3114
|
readonly method: "list";
|
|
3110
3115
|
readonly summary: "List actions";
|
|
3111
|
-
readonly description: "Discover callable Actions and their ns/name references without executing them. Combine each returned namespace and name as ns/name; Action calls use the current revision and do not accept @version or @tag. Filter by name or description; results include seven-day statistics and revision summaries without implementation source. Archived actions are excluded by default.";
|
|
3116
|
+
readonly description: "Discover callable Actions and their ns/name references without executing them. Combine each returned namespace and name as ns/name; Action calls use the current revision and do not accept @version or @tag. Filter by name or description; results include seven-day statistics and revision summaries without implementation source. Archived actions are excluded by default. List items carry no input contract: get the action and read current_revision.input_schema. Call it with call(\"ns/name\", input) in a script or call: ns/name with with: in a workflow.";
|
|
3112
3117
|
readonly http: "GET";
|
|
3113
3118
|
readonly path: "/automation/v1/actions";
|
|
3114
3119
|
readonly streaming: "no";
|
|
@@ -3245,7 +3250,7 @@ export declare const operations: readonly [{
|
|
|
3245
3250
|
readonly resource: "automation.actions";
|
|
3246
3251
|
readonly method: "retrieve";
|
|
3247
3252
|
readonly summary: "Get an Action with its current input and output JSON Schemas";
|
|
3248
|
-
readonly description: "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input). The response ETag is the current revision ID for conditional updates.";
|
|
3253
|
+
readonly description: "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input) or in a workflow step with call: ocr and with:. Input that breaks the contract returns INPUT_INVALID, with the fields in errors[]. The response ETag is the current revision ID for conditional updates.";
|
|
3249
3254
|
readonly http: "GET";
|
|
3250
3255
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
3251
3256
|
readonly streaming: "no";
|
|
@@ -3580,6 +3585,142 @@ export declare const operations: readonly [{
|
|
|
3580
3585
|
readonly required: false;
|
|
3581
3586
|
readonly fields: readonly [];
|
|
3582
3587
|
};
|
|
3588
|
+
}, {
|
|
3589
|
+
readonly resource: "automation.humanTasks";
|
|
3590
|
+
readonly method: "list";
|
|
3591
|
+
readonly summary: "List human tasks";
|
|
3592
|
+
readonly description: "List the human tasks that praxis/approval workflow steps opened, newest first. By default it returns only open tasks assigned to the caller: their approval inbox. scope=all lists every task of the organization, and status and run_id narrow the list. Use a returned id with retrieve for details and respond to decide. Read-only: listing never changes a task.";
|
|
3593
|
+
readonly http: "GET";
|
|
3594
|
+
readonly path: "/automation/v1/human-tasks";
|
|
3595
|
+
readonly streaming: "no";
|
|
3596
|
+
readonly pagination: true;
|
|
3597
|
+
readonly pathParams: readonly [];
|
|
3598
|
+
readonly query: readonly [{
|
|
3599
|
+
readonly name: "limit";
|
|
3600
|
+
readonly type: "integer";
|
|
3601
|
+
readonly required: false;
|
|
3602
|
+
readonly description: "Page size, 1–100, default 50.";
|
|
3603
|
+
}, {
|
|
3604
|
+
readonly name: "cursor";
|
|
3605
|
+
readonly type: "string";
|
|
3606
|
+
readonly required: false;
|
|
3607
|
+
readonly description: "The next_cursor of the previous page; omit for the first page.";
|
|
3608
|
+
}, {
|
|
3609
|
+
readonly name: "status";
|
|
3610
|
+
readonly type: "array";
|
|
3611
|
+
readonly itemType: "string";
|
|
3612
|
+
readonly enum: readonly ["open", "completed", "expired", "cancelled"];
|
|
3613
|
+
readonly required: false;
|
|
3614
|
+
readonly description: "Filter by status, comma-separated: open, completed, expired, cancelled. Defaults to open.";
|
|
3615
|
+
}, {
|
|
3616
|
+
readonly name: "run_id";
|
|
3617
|
+
readonly type: "string";
|
|
3618
|
+
readonly required: false;
|
|
3619
|
+
readonly description: "Only tasks opened by this run (run_).";
|
|
3620
|
+
}, {
|
|
3621
|
+
readonly name: "scope";
|
|
3622
|
+
readonly type: "string";
|
|
3623
|
+
readonly enum: readonly ["assigned", "all"];
|
|
3624
|
+
readonly required: false;
|
|
3625
|
+
readonly description: "assigned (default) lists only tasks assigned to the caller; all lists every task of the organization.";
|
|
3626
|
+
}];
|
|
3627
|
+
}, {
|
|
3628
|
+
readonly resource: "automation.humanTasks";
|
|
3629
|
+
readonly method: "retrieve";
|
|
3630
|
+
readonly summary: "Retrieve a human task";
|
|
3631
|
+
readonly description: "Read one human task - title, Markdown body, context, actions, form, assignees, mode, due time, responses and outcome - so an assignee can choose an action and fill the form. Read-only; the Console approval page /automation/tasks/{id} reads the same resource.";
|
|
3632
|
+
readonly http: "GET";
|
|
3633
|
+
readonly path: "/automation/v1/human-tasks/{id}";
|
|
3634
|
+
readonly streaming: "no";
|
|
3635
|
+
readonly pagination: false;
|
|
3636
|
+
readonly pathParams: readonly [{
|
|
3637
|
+
readonly name: "id";
|
|
3638
|
+
readonly sdkName: "id";
|
|
3639
|
+
readonly description: "Human task ID (htask_), from the list or the run's waits.";
|
|
3640
|
+
}];
|
|
3641
|
+
readonly query: readonly [];
|
|
3642
|
+
}, {
|
|
3643
|
+
readonly resource: "automation.humanTasks";
|
|
3644
|
+
readonly method: "cancel";
|
|
3645
|
+
readonly summary: "Cancel a human task";
|
|
3646
|
+
readonly description: "Cancel an open human task; only the person who started the run or an organization API key may cancel. The task becomes cancelled and the waiting workflow step raises a runtime error with code HUMAN_TASK_CANCELLED, which try/catch can catch. Open tasks are cancelled automatically when their run ends, so this call is not needed then.";
|
|
3647
|
+
readonly http: "POST";
|
|
3648
|
+
readonly path: "/automation/v1/human-tasks/{id}/cancel";
|
|
3649
|
+
readonly streaming: "no";
|
|
3650
|
+
readonly pagination: false;
|
|
3651
|
+
readonly pathParams: readonly [{
|
|
3652
|
+
readonly name: "id";
|
|
3653
|
+
readonly sdkName: "id";
|
|
3654
|
+
readonly description: "Human task ID (htask_).";
|
|
3655
|
+
}];
|
|
3656
|
+
readonly query: readonly [];
|
|
3657
|
+
readonly body: {
|
|
3658
|
+
readonly required: false;
|
|
3659
|
+
readonly fields: readonly [{
|
|
3660
|
+
readonly name: "reason";
|
|
3661
|
+
readonly type: "string";
|
|
3662
|
+
readonly required: false;
|
|
3663
|
+
readonly description: "Optional cancellation reason, at most 500 characters.";
|
|
3664
|
+
}];
|
|
3665
|
+
};
|
|
3666
|
+
}, {
|
|
3667
|
+
readonly resource: "automation.humanTasks";
|
|
3668
|
+
readonly method: "delegate";
|
|
3669
|
+
readonly summary: "Delegate a human task";
|
|
3670
|
+
readonly description: "An assignee who has not responded hands their place to another user (to_user), replacing their entry in assignees.users in place, so sequential order is kept. The new user cannot already be an assignee, nor the initiator unless self-approval is allowed. The task must still be open.";
|
|
3671
|
+
readonly http: "POST";
|
|
3672
|
+
readonly path: "/automation/v1/human-tasks/{id}/delegate";
|
|
3673
|
+
readonly streaming: "no";
|
|
3674
|
+
readonly pagination: false;
|
|
3675
|
+
readonly pathParams: readonly [{
|
|
3676
|
+
readonly name: "id";
|
|
3677
|
+
readonly sdkName: "id";
|
|
3678
|
+
readonly description: "Human task ID (htask_).";
|
|
3679
|
+
}];
|
|
3680
|
+
readonly query: readonly [];
|
|
3681
|
+
readonly body: {
|
|
3682
|
+
readonly required: true;
|
|
3683
|
+
readonly fields: readonly [{
|
|
3684
|
+
readonly name: "to_user";
|
|
3685
|
+
readonly type: "string";
|
|
3686
|
+
readonly required: true;
|
|
3687
|
+
readonly description: "User ID taking over; cannot already be an assignee, nor the initiator unless self-approval is allowed.";
|
|
3688
|
+
}];
|
|
3689
|
+
};
|
|
3690
|
+
}, {
|
|
3691
|
+
readonly resource: "automation.humanTasks";
|
|
3692
|
+
readonly method: "respond";
|
|
3693
|
+
readonly summary: "Respond to a human task";
|
|
3694
|
+
readonly description: "Submit an action (action_id), form values (values) and a comment as the calling user. Depending on the task's mode the response either decides it (status becomes completed, outcome is set, and the waiting workflow resumes with outcome as the step output) or is recorded while other assignees are awaited. When two assignees respond at once, exactly one decides and the other gets TASK_CLOSED. An agent may respond only if the workflow set allow_agent_decision. Send an Idempotency-Key to retry safely.";
|
|
3695
|
+
readonly http: "POST";
|
|
3696
|
+
readonly path: "/automation/v1/human-tasks/{id}/respond";
|
|
3697
|
+
readonly streaming: "no";
|
|
3698
|
+
readonly pagination: false;
|
|
3699
|
+
readonly pathParams: readonly [{
|
|
3700
|
+
readonly name: "id";
|
|
3701
|
+
readonly sdkName: "id";
|
|
3702
|
+
readonly description: "Human task ID (htask_).";
|
|
3703
|
+
}];
|
|
3704
|
+
readonly query: readonly [];
|
|
3705
|
+
readonly body: {
|
|
3706
|
+
readonly required: true;
|
|
3707
|
+
readonly fields: readonly [{
|
|
3708
|
+
readonly name: "action_id";
|
|
3709
|
+
readonly type: "string";
|
|
3710
|
+
readonly required: true;
|
|
3711
|
+
readonly description: "The chosen action ID from the task's actions, for example approve.";
|
|
3712
|
+
}, {
|
|
3713
|
+
readonly name: "values";
|
|
3714
|
+
readonly type: "object";
|
|
3715
|
+
readonly required: false;
|
|
3716
|
+
readonly description: "Any JSON object whose keys are strings and whose values are any JSON value.";
|
|
3717
|
+
}, {
|
|
3718
|
+
readonly name: "comment";
|
|
3719
|
+
readonly type: "string";
|
|
3720
|
+
readonly required: false;
|
|
3721
|
+
readonly description: "Comment of at most 4000 characters; required when the action has require_comment true.";
|
|
3722
|
+
}];
|
|
3723
|
+
};
|
|
3583
3724
|
}, {
|
|
3584
3725
|
readonly resource: "automation.resolve";
|
|
3585
3726
|
readonly method: "retrieve";
|
|
@@ -3711,7 +3852,7 @@ export declare const operations: readonly [{
|
|
|
3711
3852
|
readonly resource: "automation.runs";
|
|
3712
3853
|
readonly method: "create";
|
|
3713
3854
|
readonly summary: "Run a published target or execute draft source";
|
|
3714
|
-
readonly description: "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to
|
|
3855
|
+
readonly description: "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 30 days. Each run can start at most 100 child runs, with at most 20 active at once; nesting depth is limited to 10. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. With language=yaml, source is a workflow YAML: the run input is . in the first step, and the shape is described in create workflow. Error details are in errors[] (pointer, detail, hint). New non-deterministic run IDs contain 78 characters, compared with 46 for legacy random IDs; treat IDs as opaque strings. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed.";
|
|
3715
3856
|
readonly http: "POST";
|
|
3716
3857
|
readonly path: "/automation/v1/runs";
|
|
3717
3858
|
readonly streaming: "no";
|
|
@@ -4108,7 +4249,7 @@ export declare const operations: readonly [{
|
|
|
4108
4249
|
readonly resource: "automation.scripts";
|
|
4109
4250
|
readonly method: "create";
|
|
4110
4251
|
readonly summary: "Create a script";
|
|
4111
|
-
readonly description: "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.";
|
|
4252
|
+
readonly description: "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. The return value is limited to 1 MiB: write large results to a file with call(\"write-file\", ...) and return the file ID. A call error carries errors[] (pointer, detail, hint); String(e) is only the summary. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.";
|
|
4112
4253
|
readonly http: "POST";
|
|
4113
4254
|
readonly path: "/automation/v1/scripts";
|
|
4114
4255
|
readonly streaming: "no";
|
|
@@ -4873,7 +5014,7 @@ export declare const operations: readonly [{
|
|
|
4873
5014
|
readonly resource: "automation.validate";
|
|
4874
5015
|
readonly method: "create";
|
|
4875
5016
|
readonly summary: "Validate a definition";
|
|
4876
|
-
readonly 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.";
|
|
5017
|
+
readonly 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.";
|
|
4877
5018
|
readonly http: "POST";
|
|
4878
5019
|
readonly path: "/automation/v1/validate";
|
|
4879
5020
|
readonly streaming: "no";
|
|
@@ -4958,7 +5099,7 @@ export declare const operations: readonly [{
|
|
|
4958
5099
|
readonly resource: "automation.workflows";
|
|
4959
5100
|
readonly method: "create";
|
|
4960
5101
|
readonly summary: "Create a workflow";
|
|
4961
|
-
readonly description: "Save a YAML workflow as an editable draft
|
|
5102
|
+
readonly 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.";
|
|
4962
5103
|
readonly http: "POST";
|
|
4963
5104
|
readonly path: "/automation/v1/workflows";
|
|
4964
5105
|
readonly streaming: "no";
|
|
@@ -5017,7 +5158,7 @@ export declare const operations: readonly [{
|
|
|
5017
5158
|
readonly resource: "automation.workflows";
|
|
5018
5159
|
readonly method: "update";
|
|
5019
5160
|
readonly summary: "Update a workflow draft";
|
|
5020
|
-
readonly description: "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.";
|
|
5161
|
+
readonly 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.";
|
|
5021
5162
|
readonly http: "PATCH";
|
|
5022
5163
|
readonly path: "/automation/v1/workflows/{ns}/{name}";
|
|
5023
5164
|
readonly streaming: "no";
|
|
@@ -5211,7 +5352,7 @@ export declare const operations: readonly [{
|
|
|
5211
5352
|
readonly method: "create";
|
|
5212
5353
|
readonly aliases: readonly ["publish"];
|
|
5213
5354
|
readonly summary: "Publish a workflow version";
|
|
5214
|
-
readonly description: "Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. String and object run.workflow/run.script references share version resolution and dependency locking. Publishing removes +build metadata from the version number.";
|
|
5355
|
+
readonly description: "Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. String and object run.workflow/run.script references share version resolution and dependency locking. Publishing removes +build metadata from the version number. For a workflow, document namespace, name and version must equal the publish target, otherwise DEFINITION_IDENTITY_MISMATCH; where a DEFINITION_INVALID failure sits is listed in errors[] (pointer, detail, hint).";
|
|
5215
5356
|
readonly http: "POST";
|
|
5216
5357
|
readonly path: "/automation/v1/workflows/{ns}/{name}/versions";
|
|
5217
5358
|
readonly streaming: "no";
|
|
@@ -5767,171 +5908,909 @@ export declare const operations: readonly [{
|
|
|
5767
5908
|
}];
|
|
5768
5909
|
};
|
|
5769
5910
|
}, {
|
|
5770
|
-
readonly resource: "
|
|
5911
|
+
readonly resource: "canvas.canvases";
|
|
5771
5912
|
readonly method: "list";
|
|
5772
|
-
readonly summary: "List
|
|
5773
|
-
readonly description: "
|
|
5913
|
+
readonly summary: "List canvases";
|
|
5914
|
+
readonly 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.";
|
|
5774
5915
|
readonly http: "GET";
|
|
5775
|
-
readonly path: "/
|
|
5916
|
+
readonly path: "/canvas/v1/canvases";
|
|
5776
5917
|
readonly streaming: "no";
|
|
5777
5918
|
readonly pagination: true;
|
|
5778
5919
|
readonly pathParams: readonly [];
|
|
5779
5920
|
readonly query: readonly [{
|
|
5780
|
-
readonly name: "cursor";
|
|
5781
|
-
readonly type: "string";
|
|
5782
|
-
readonly required: false;
|
|
5783
|
-
readonly description: "Opaque next_cursor from the previous page.";
|
|
5784
|
-
}, {
|
|
5785
5921
|
readonly name: "limit";
|
|
5786
5922
|
readonly type: "integer";
|
|
5787
5923
|
readonly required: false;
|
|
5788
|
-
readonly description: "
|
|
5789
|
-
}, {
|
|
5790
|
-
readonly name: "labels";
|
|
5791
|
-
readonly type: "object";
|
|
5792
|
-
readonly required: false;
|
|
5793
|
-
readonly description: "Exact label match, encoded as labels[purpose]=docs.";
|
|
5924
|
+
readonly description: "Maximum canvases to return per page, from 1 to 100; defaults to 50 when omitted.";
|
|
5794
5925
|
}, {
|
|
5795
|
-
readonly name: "
|
|
5926
|
+
readonly name: "cursor";
|
|
5796
5927
|
readonly type: "string";
|
|
5797
|
-
readonly enum: readonly ["active", "deleting"];
|
|
5798
5928
|
readonly required: false;
|
|
5799
|
-
readonly description: "
|
|
5929
|
+
readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
|
|
5800
5930
|
}];
|
|
5801
5931
|
}, {
|
|
5802
|
-
readonly resource: "
|
|
5932
|
+
readonly resource: "canvas.canvases";
|
|
5803
5933
|
readonly method: "create";
|
|
5804
|
-
readonly summary: "Create
|
|
5805
|
-
readonly description: "
|
|
5934
|
+
readonly summary: "Create canvas";
|
|
5935
|
+
readonly 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.";
|
|
5806
5936
|
readonly http: "POST";
|
|
5807
|
-
readonly path: "/
|
|
5937
|
+
readonly path: "/canvas/v1/canvases";
|
|
5808
5938
|
readonly streaming: "no";
|
|
5809
5939
|
readonly pagination: false;
|
|
5810
5940
|
readonly pathParams: readonly [];
|
|
5811
5941
|
readonly query: readonly [];
|
|
5812
5942
|
readonly body: {
|
|
5813
|
-
readonly required:
|
|
5943
|
+
readonly required: false;
|
|
5814
5944
|
readonly fields: readonly [{
|
|
5815
5945
|
readonly name: "name";
|
|
5816
5946
|
readonly type: "string";
|
|
5817
|
-
readonly required: true;
|
|
5818
|
-
readonly description: "Display name for the database: 1–64 visible characters after trimming; control characters are rejected. It is not an identifier, so later calls still use the returned id.";
|
|
5819
|
-
}, {
|
|
5820
|
-
readonly name: "labels";
|
|
5821
|
-
readonly type: "object";
|
|
5822
5947
|
readonly required: false;
|
|
5823
|
-
readonly description: "
|
|
5948
|
+
readonly description: "Display name for the new canvas, at most 200 characters; omission uses Untitled.";
|
|
5824
5949
|
}];
|
|
5825
5950
|
};
|
|
5826
5951
|
}, {
|
|
5827
|
-
readonly resource: "
|
|
5952
|
+
readonly resource: "canvas.canvases";
|
|
5828
5953
|
readonly method: "delete";
|
|
5829
|
-
readonly summary: "Delete
|
|
5830
|
-
readonly description: "
|
|
5954
|
+
readonly summary: "Delete canvas";
|
|
5955
|
+
readonly 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.";
|
|
5831
5956
|
readonly http: "DELETE";
|
|
5832
|
-
readonly path: "/
|
|
5957
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}";
|
|
5833
5958
|
readonly streaming: "no";
|
|
5834
5959
|
readonly pagination: false;
|
|
5835
5960
|
readonly pathParams: readonly [{
|
|
5836
|
-
readonly name: "
|
|
5837
|
-
readonly sdkName: "
|
|
5838
|
-
readonly description: "
|
|
5961
|
+
readonly name: "canvas_id";
|
|
5962
|
+
readonly sdkName: "canvas_id";
|
|
5963
|
+
readonly 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.";
|
|
5839
5964
|
}];
|
|
5840
5965
|
readonly query: readonly [];
|
|
5841
5966
|
}, {
|
|
5842
|
-
readonly resource: "
|
|
5967
|
+
readonly resource: "canvas.canvases";
|
|
5843
5968
|
readonly method: "retrieve";
|
|
5844
|
-
readonly summary: "
|
|
5845
|
-
readonly description: "
|
|
5969
|
+
readonly summary: "Retrieve canvas";
|
|
5970
|
+
readonly 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.";
|
|
5846
5971
|
readonly http: "GET";
|
|
5847
|
-
readonly path: "/
|
|
5972
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}";
|
|
5848
5973
|
readonly streaming: "no";
|
|
5849
5974
|
readonly pagination: false;
|
|
5850
5975
|
readonly pathParams: readonly [{
|
|
5851
|
-
readonly name: "
|
|
5852
|
-
readonly sdkName: "
|
|
5853
|
-
readonly description: "
|
|
5976
|
+
readonly name: "canvas_id";
|
|
5977
|
+
readonly sdkName: "canvas_id";
|
|
5978
|
+
readonly 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.";
|
|
5854
5979
|
}];
|
|
5855
5980
|
readonly query: readonly [];
|
|
5856
5981
|
}, {
|
|
5857
|
-
readonly resource: "
|
|
5858
|
-
readonly method: "
|
|
5859
|
-
readonly summary: "
|
|
5860
|
-
readonly description: "
|
|
5861
|
-
readonly http: "
|
|
5862
|
-
readonly path: "/
|
|
5982
|
+
readonly resource: "canvas.canvases.images";
|
|
5983
|
+
readonly method: "list";
|
|
5984
|
+
readonly summary: "Render canvas nodes";
|
|
5985
|
+
readonly 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.";
|
|
5986
|
+
readonly http: "GET";
|
|
5987
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}/images";
|
|
5863
5988
|
readonly streaming: "no";
|
|
5864
5989
|
readonly pagination: false;
|
|
5865
5990
|
readonly pathParams: readonly [{
|
|
5866
|
-
readonly name: "
|
|
5867
|
-
readonly sdkName: "
|
|
5868
|
-
readonly description: "
|
|
5991
|
+
readonly name: "canvas_id";
|
|
5992
|
+
readonly sdkName: "canvas_id";
|
|
5993
|
+
readonly 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.";
|
|
5994
|
+
}];
|
|
5995
|
+
readonly query: readonly [{
|
|
5996
|
+
readonly name: "ids";
|
|
5997
|
+
readonly type: "string";
|
|
5998
|
+
readonly required: true;
|
|
5999
|
+
readonly description: "Comma-separated list of 1–4 node ids to render, from retrieve, execute.created or execute.screenshots.";
|
|
6000
|
+
}, {
|
|
6001
|
+
readonly name: "scale";
|
|
6002
|
+
readonly type: "number";
|
|
6003
|
+
readonly required: false;
|
|
6004
|
+
readonly description: "Output pixel scale relative to canvas dimensions, from 0.25 to 4 inclusive; defaults to 1 when omitted.";
|
|
6005
|
+
}, {
|
|
6006
|
+
readonly name: "format";
|
|
6007
|
+
readonly type: "string";
|
|
6008
|
+
readonly enum: readonly ["png"];
|
|
6009
|
+
readonly required: false;
|
|
6010
|
+
readonly description: "Image encoding; png produces a PNG data URL and is the only supported value. Omit to use png.";
|
|
6011
|
+
}];
|
|
6012
|
+
}, {
|
|
6013
|
+
readonly resource: "canvas.canvases.nodes";
|
|
6014
|
+
readonly method: "list";
|
|
6015
|
+
readonly summary: "Read canvas nodes";
|
|
6016
|
+
readonly 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.";
|
|
6017
|
+
readonly http: "GET";
|
|
6018
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}/nodes";
|
|
6019
|
+
readonly streaming: "no";
|
|
6020
|
+
readonly pagination: false;
|
|
6021
|
+
readonly pathParams: readonly [{
|
|
6022
|
+
readonly name: "canvas_id";
|
|
6023
|
+
readonly sdkName: "canvas_id";
|
|
6024
|
+
readonly 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.";
|
|
6025
|
+
}];
|
|
6026
|
+
readonly query: readonly [{
|
|
6027
|
+
readonly name: "ids";
|
|
6028
|
+
readonly type: "string";
|
|
6029
|
+
readonly required: true;
|
|
6030
|
+
readonly 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.";
|
|
6031
|
+
}, {
|
|
6032
|
+
readonly name: "depth";
|
|
6033
|
+
readonly type: "integer";
|
|
6034
|
+
readonly required: false;
|
|
6035
|
+
readonly 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.";
|
|
6036
|
+
}];
|
|
6037
|
+
}, {
|
|
6038
|
+
readonly resource: "canvas.canvases";
|
|
6039
|
+
readonly method: "execute";
|
|
6040
|
+
readonly summary: "Execute canvas script";
|
|
6041
|
+
readonly 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.\n\nThe 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:\n\n```js\nconst 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)\n```\n\nUse 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.\n\nA 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.\n";
|
|
6042
|
+
readonly http: "POST";
|
|
6043
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}:execute";
|
|
6044
|
+
readonly streaming: "no";
|
|
6045
|
+
readonly pagination: false;
|
|
6046
|
+
readonly pathParams: readonly [{
|
|
6047
|
+
readonly name: "canvas_id";
|
|
6048
|
+
readonly sdkName: "canvas_id";
|
|
6049
|
+
readonly 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.";
|
|
5869
6050
|
}];
|
|
5870
6051
|
readonly query: readonly [];
|
|
5871
6052
|
readonly body: {
|
|
5872
6053
|
readonly required: true;
|
|
5873
6054
|
readonly fields: readonly [{
|
|
5874
|
-
readonly name: "
|
|
6055
|
+
readonly name: "script";
|
|
5875
6056
|
readonly type: "string";
|
|
5876
6057
|
readonly required: false;
|
|
5877
|
-
readonly description: "New
|
|
6058
|
+
readonly 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.";
|
|
5878
6059
|
}, {
|
|
5879
|
-
readonly name: "
|
|
5880
|
-
readonly type: "
|
|
6060
|
+
readonly name: "edit_id";
|
|
6061
|
+
readonly type: "string";
|
|
5881
6062
|
readonly required: false;
|
|
5882
|
-
readonly description: "
|
|
6063
|
+
readonly description: "Saved failed-script identifier from error.details.edit_id; use with edits instead of script within ten minutes of the failure.";
|
|
6064
|
+
}, {
|
|
6065
|
+
readonly name: "edits";
|
|
6066
|
+
readonly type: "array";
|
|
6067
|
+
readonly itemType: "object";
|
|
6068
|
+
readonly required: false;
|
|
6069
|
+
readonly description: "Text replacements applied to the source identified by edit_id before rerunning; use error line, column or rejection to choose the correction.";
|
|
6070
|
+
}, {
|
|
6071
|
+
readonly name: "expected_version";
|
|
6072
|
+
readonly type: "string";
|
|
6073
|
+
readonly required: false;
|
|
6074
|
+
readonly 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.";
|
|
5883
6075
|
}];
|
|
5884
6076
|
};
|
|
5885
6077
|
}, {
|
|
5886
|
-
readonly resource: "
|
|
5887
|
-
readonly method: "
|
|
5888
|
-
readonly summary: "
|
|
5889
|
-
readonly description: "
|
|
6078
|
+
readonly resource: "cut.exports";
|
|
6079
|
+
readonly method: "retrieve";
|
|
6080
|
+
readonly summary: "Retrieve video export";
|
|
6081
|
+
readonly description: "Poll an export id returned by projects.exports.create or list to observe render progress. queued, fetching, rendering, stitching and saving are in progress; done provides asset in the target library, failed provides error, and canceled means the job stopped. Only done confirms a usable output asset.";
|
|
5890
6082
|
readonly http: "GET";
|
|
5891
|
-
readonly path: "/
|
|
6083
|
+
readonly path: "/cut/v1/exports/{export_id}";
|
|
5892
6084
|
readonly streaming: "no";
|
|
5893
6085
|
readonly pagination: false;
|
|
5894
6086
|
readonly pathParams: readonly [{
|
|
5895
|
-
readonly name: "
|
|
5896
|
-
readonly sdkName: "
|
|
5897
|
-
readonly description: "
|
|
6087
|
+
readonly name: "export_id";
|
|
6088
|
+
readonly sdkName: "export_id";
|
|
6089
|
+
readonly description: "Export identifier returned by its create or list operation; use the id, not a display name.";
|
|
6090
|
+
}];
|
|
6091
|
+
readonly query: readonly [];
|
|
6092
|
+
}, {
|
|
6093
|
+
readonly resource: "cut.exports";
|
|
6094
|
+
readonly method: "cancel";
|
|
6095
|
+
readonly summary: "Cancel video export";
|
|
6096
|
+
readonly description: "Request cancellation of an export obtained from projects.exports.create or list when its output is no longer needed. Read the returned job status and retrieve it to confirm the terminal outcome; do not interpret a cancellation request as successful rendering.";
|
|
6097
|
+
readonly http: "POST";
|
|
6098
|
+
readonly path: "/cut/v1/exports/{export_id}:cancel";
|
|
6099
|
+
readonly streaming: "no";
|
|
6100
|
+
readonly pagination: false;
|
|
6101
|
+
readonly pathParams: readonly [{
|
|
6102
|
+
readonly name: "export_id";
|
|
6103
|
+
readonly sdkName: "export_id";
|
|
6104
|
+
readonly description: "Export identifier returned by its create or list operation; use the id, not a display name.";
|
|
5898
6105
|
}];
|
|
6106
|
+
readonly query: readonly [];
|
|
6107
|
+
}, {
|
|
6108
|
+
readonly resource: "cut.projects";
|
|
6109
|
+
readonly method: "list";
|
|
6110
|
+
readonly summary: "List projects";
|
|
6111
|
+
readonly description: "Discover projects owned by the API key organization and obtain project_id values. Results default to active projects ordered by updateTime descending; use filter state = \"deleted\" to find retained deleted projects for undelete. Continue with next_page_token as page_token until the token is absent.";
|
|
6112
|
+
readonly http: "GET";
|
|
6113
|
+
readonly path: "/cut/v1/projects";
|
|
6114
|
+
readonly streaming: "no";
|
|
6115
|
+
readonly pagination: false;
|
|
6116
|
+
readonly pathParams: readonly [];
|
|
5899
6117
|
readonly query: readonly [{
|
|
5900
|
-
readonly name: "
|
|
6118
|
+
readonly name: "page_size";
|
|
5901
6119
|
readonly type: "integer";
|
|
5902
6120
|
readonly required: false;
|
|
5903
|
-
readonly description: "
|
|
6121
|
+
readonly description: "Maximum resources in one page, from 1 to 100; defaults to 50.";
|
|
5904
6122
|
}, {
|
|
5905
|
-
readonly name: "
|
|
5906
|
-
readonly type: "
|
|
6123
|
+
readonly name: "page_token";
|
|
6124
|
+
readonly type: "string";
|
|
5907
6125
|
readonly required: false;
|
|
5908
|
-
readonly description: "
|
|
6126
|
+
readonly description: "Opaque next_page_token from the preceding page; omit on the first request.";
|
|
5909
6127
|
}, {
|
|
5910
|
-
readonly name: "
|
|
6128
|
+
readonly name: "filter";
|
|
5911
6129
|
readonly type: "string";
|
|
5912
|
-
readonly enum: readonly ["asc", "desc"];
|
|
5913
6130
|
readonly required: false;
|
|
5914
|
-
readonly description: "
|
|
6131
|
+
readonly description: "Optional resource filter; projects supports state = \"active\" or state = \"deleted\".";
|
|
5915
6132
|
}, {
|
|
5916
|
-
readonly name: "
|
|
5917
|
-
readonly type: "
|
|
6133
|
+
readonly name: "order_by";
|
|
6134
|
+
readonly type: "string";
|
|
5918
6135
|
readonly required: false;
|
|
5919
|
-
readonly description: "
|
|
6136
|
+
readonly description: "Optional ordering expression; projects supports updateTime desc.";
|
|
5920
6137
|
}];
|
|
5921
6138
|
}, {
|
|
5922
|
-
readonly resource: "
|
|
6139
|
+
readonly resource: "cut.projects";
|
|
5923
6140
|
readonly method: "create";
|
|
5924
|
-
readonly summary: "
|
|
5925
|
-
readonly description: "
|
|
6141
|
+
readonly summary: "Create project";
|
|
6142
|
+
readonly description: "Create a blank editing project in the API key organization before writing a script. First obtain accessible library ids from praxis.media; bindings must include exactly one read_write library with default_upload true. Each call creates a new project and returns HTTP 201; save its id for execute, state and timeline calls. All editing positions use seconds.";
|
|
5926
6143
|
readonly http: "POST";
|
|
5927
|
-
readonly path: "/
|
|
6144
|
+
readonly path: "/cut/v1/projects";
|
|
5928
6145
|
readonly streaming: "no";
|
|
5929
6146
|
readonly pagination: false;
|
|
5930
|
-
readonly pathParams: readonly [
|
|
5931
|
-
|
|
5932
|
-
|
|
5933
|
-
readonly
|
|
5934
|
-
|
|
6147
|
+
readonly pathParams: readonly [];
|
|
6148
|
+
readonly query: readonly [];
|
|
6149
|
+
readonly body: {
|
|
6150
|
+
readonly required: true;
|
|
6151
|
+
readonly fields: readonly [{
|
|
6152
|
+
readonly name: "name";
|
|
6153
|
+
readonly type: "string";
|
|
6154
|
+
readonly required: true;
|
|
6155
|
+
readonly description: "Human-readable project name; required and must contain non-whitespace text.";
|
|
6156
|
+
}, {
|
|
6157
|
+
readonly name: "labels";
|
|
6158
|
+
readonly type: "object";
|
|
6159
|
+
readonly required: false;
|
|
6160
|
+
readonly description: "User-defined string labels for organizing projects; label keys retain their original spelling.";
|
|
6161
|
+
}, {
|
|
6162
|
+
readonly name: "settings";
|
|
6163
|
+
readonly type: "object";
|
|
6164
|
+
readonly required: true;
|
|
6165
|
+
readonly description: "Dimensions and frame rate for a new editing project.";
|
|
6166
|
+
}, {
|
|
6167
|
+
readonly name: "bindings";
|
|
6168
|
+
readonly type: "array";
|
|
6169
|
+
readonly itemType: "object";
|
|
6170
|
+
readonly required: true;
|
|
6171
|
+
readonly description: "Accessible library bindings; exactly one read_write entry must have default_upload true.";
|
|
6172
|
+
}];
|
|
6173
|
+
};
|
|
6174
|
+
}, {
|
|
6175
|
+
readonly resource: "cut.projects";
|
|
6176
|
+
readonly method: "delete";
|
|
6177
|
+
readonly summary: "Delete project";
|
|
6178
|
+
readonly description: "Soft-delete a project selected from projects.list. The project is retained for seven days until purge_time and can be restored with undelete before that deadline. Deleted projects cannot be edited; list with filter state = \"deleted\" to locate retained projects.";
|
|
6179
|
+
readonly http: "DELETE";
|
|
6180
|
+
readonly path: "/cut/v1/projects/{project_id}";
|
|
6181
|
+
readonly streaming: "no";
|
|
6182
|
+
readonly pagination: false;
|
|
6183
|
+
readonly pathParams: readonly [{
|
|
6184
|
+
readonly name: "project_id";
|
|
6185
|
+
readonly sdkName: "project_id";
|
|
6186
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6187
|
+
}];
|
|
6188
|
+
readonly query: readonly [];
|
|
6189
|
+
}, {
|
|
6190
|
+
readonly resource: "cut.projects";
|
|
6191
|
+
readonly method: "retrieve";
|
|
6192
|
+
readonly summary: "Retrieve project";
|
|
6193
|
+
readonly description: "Inspect project metadata, settings and library bindings before editing. Copy id from projects.create or list; expand=timeline,exports,versions includes selected related resources. The expanded timeline uses seconds and the returned revision can guard a later execute call with expected_revision.";
|
|
6194
|
+
readonly http: "GET";
|
|
6195
|
+
readonly path: "/cut/v1/projects/{project_id}";
|
|
6196
|
+
readonly streaming: "no";
|
|
6197
|
+
readonly pagination: false;
|
|
6198
|
+
readonly pathParams: readonly [{
|
|
6199
|
+
readonly name: "project_id";
|
|
6200
|
+
readonly sdkName: "project_id";
|
|
6201
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6202
|
+
}];
|
|
6203
|
+
readonly query: readonly [{
|
|
6204
|
+
readonly name: "expand";
|
|
6205
|
+
readonly type: "string";
|
|
6206
|
+
readonly required: false;
|
|
6207
|
+
readonly description: "Comma-separated expansions: timeline includes clips, exports includes render jobs, versions includes saved snapshots.";
|
|
6208
|
+
}];
|
|
6209
|
+
}, {
|
|
6210
|
+
readonly resource: "cut.projects";
|
|
6211
|
+
readonly method: "update";
|
|
6212
|
+
readonly summary: "Update project metadata";
|
|
6213
|
+
readonly description: "Change the project display name or replace its labels by naming those fields in update_mask. Use execute for clip or track edits. Each successful update commits a new revision; labels are replaced as a whole when selected, so read and merge existing labels before overwriting them.";
|
|
6214
|
+
readonly http: "PATCH";
|
|
6215
|
+
readonly path: "/cut/v1/projects/{project_id}";
|
|
6216
|
+
readonly streaming: "no";
|
|
6217
|
+
readonly pagination: false;
|
|
6218
|
+
readonly pathParams: readonly [{
|
|
6219
|
+
readonly name: "project_id";
|
|
6220
|
+
readonly sdkName: "project_id";
|
|
6221
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6222
|
+
}];
|
|
6223
|
+
readonly query: readonly [];
|
|
6224
|
+
readonly body: {
|
|
6225
|
+
readonly required: true;
|
|
6226
|
+
readonly fields: readonly [{
|
|
6227
|
+
readonly name: "name";
|
|
6228
|
+
readonly type: "string";
|
|
6229
|
+
readonly required: false;
|
|
6230
|
+
readonly description: "Replacement display name when update_mask includes name.";
|
|
6231
|
+
}, {
|
|
6232
|
+
readonly name: "labels";
|
|
6233
|
+
readonly type: "object";
|
|
6234
|
+
readonly required: false;
|
|
6235
|
+
readonly description: "User-defined string labels for organizing projects; label keys retain their original spelling.";
|
|
6236
|
+
}, {
|
|
6237
|
+
readonly name: "update_mask";
|
|
6238
|
+
readonly type: "array";
|
|
6239
|
+
readonly itemType: "string";
|
|
6240
|
+
readonly enum: readonly ["name", "labels"];
|
|
6241
|
+
readonly required: true;
|
|
6242
|
+
readonly description: "Metadata fields to replace; name changes the display name and labels replaces all labels.";
|
|
6243
|
+
}];
|
|
6244
|
+
};
|
|
6245
|
+
}, {
|
|
6246
|
+
readonly resource: "cut.projects.analysis";
|
|
6247
|
+
readonly method: "create";
|
|
6248
|
+
readonly summary: "Analyze project media";
|
|
6249
|
+
readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.";
|
|
6250
|
+
readonly http: "POST";
|
|
6251
|
+
readonly path: "/cut/v1/projects/{project_id}/analysis";
|
|
6252
|
+
readonly streaming: "no";
|
|
6253
|
+
readonly pagination: false;
|
|
6254
|
+
readonly pathParams: readonly [{
|
|
6255
|
+
readonly name: "project_id";
|
|
6256
|
+
readonly sdkName: "project_id";
|
|
6257
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6258
|
+
}];
|
|
6259
|
+
readonly query: readonly [];
|
|
6260
|
+
readonly body: {
|
|
6261
|
+
readonly required: true;
|
|
6262
|
+
readonly fields: readonly [{
|
|
6263
|
+
readonly name: "media";
|
|
6264
|
+
readonly type: "array";
|
|
6265
|
+
readonly itemType: "object";
|
|
6266
|
+
readonly required: false;
|
|
6267
|
+
readonly description: "Bound-library assets to analyze; omission selects project media.";
|
|
6268
|
+
}, {
|
|
6269
|
+
readonly name: "kinds";
|
|
6270
|
+
readonly type: "array";
|
|
6271
|
+
readonly itemType: "string";
|
|
6272
|
+
readonly enum: readonly ["silence", "filler", "scenes"];
|
|
6273
|
+
readonly required: true;
|
|
6274
|
+
readonly description: "Analysis types to request for the selected source assets.";
|
|
6275
|
+
}];
|
|
6276
|
+
};
|
|
6277
|
+
}, {
|
|
6278
|
+
readonly resource: "cut.projects.bindings";
|
|
6279
|
+
readonly method: "list";
|
|
6280
|
+
readonly summary: "List library bindings";
|
|
6281
|
+
readonly description: "Discover the named media libraries available to this project before selecting source assets or an import/export destination. read bindings supply source assets; read_write bindings also accept uploads. Exactly one writable binding supplies the default upload destination.";
|
|
6282
|
+
readonly http: "GET";
|
|
6283
|
+
readonly path: "/cut/v1/projects/{project_id}/bindings";
|
|
6284
|
+
readonly streaming: "no";
|
|
6285
|
+
readonly pagination: false;
|
|
6286
|
+
readonly pathParams: readonly [{
|
|
6287
|
+
readonly name: "project_id";
|
|
6288
|
+
readonly sdkName: "project_id";
|
|
6289
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6290
|
+
}];
|
|
6291
|
+
readonly query: readonly [];
|
|
6292
|
+
}, {
|
|
6293
|
+
readonly resource: "cut.projects.bindings";
|
|
6294
|
+
readonly method: "create";
|
|
6295
|
+
readonly summary: "Bind media library";
|
|
6296
|
+
readonly description: "Attach an accessible media library to an existing project under a unique name. Obtain library_id from praxis.media and choose read for source-only access or read_write for imports and exports. The project must retain exactly one read_write binding with default_upload true after the change.";
|
|
6297
|
+
readonly http: "POST";
|
|
6298
|
+
readonly path: "/cut/v1/projects/{project_id}/bindings";
|
|
6299
|
+
readonly streaming: "no";
|
|
6300
|
+
readonly pagination: false;
|
|
6301
|
+
readonly pathParams: readonly [{
|
|
6302
|
+
readonly name: "project_id";
|
|
6303
|
+
readonly sdkName: "project_id";
|
|
6304
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6305
|
+
}];
|
|
6306
|
+
readonly query: readonly [];
|
|
6307
|
+
readonly body: {
|
|
6308
|
+
readonly required: true;
|
|
6309
|
+
readonly fields: readonly [{
|
|
6310
|
+
readonly name: "binding";
|
|
6311
|
+
readonly type: "object";
|
|
6312
|
+
readonly required: true;
|
|
6313
|
+
readonly description: "A named project link to a media library. Exactly one read_write binding must be default_upload.";
|
|
6314
|
+
}];
|
|
6315
|
+
};
|
|
6316
|
+
}, {
|
|
6317
|
+
readonly resource: "cut.projects.bindings";
|
|
6318
|
+
readonly method: "delete";
|
|
6319
|
+
readonly summary: "Remove library binding";
|
|
6320
|
+
readonly description: "Detach a library alias obtained from bindings.list after removing all timeline clips that reference its library. BINDING_IN_USE returns 409 while references remain; inspect timeline and edit those clips first. Removal must preserve the one writable default upload binding.";
|
|
6321
|
+
readonly http: "DELETE";
|
|
6322
|
+
readonly path: "/cut/v1/projects/{project_id}/bindings/{name}";
|
|
6323
|
+
readonly streaming: "no";
|
|
6324
|
+
readonly pagination: false;
|
|
6325
|
+
readonly pathParams: readonly [{
|
|
6326
|
+
readonly name: "project_id";
|
|
6327
|
+
readonly sdkName: "project_id";
|
|
6328
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6329
|
+
}, {
|
|
6330
|
+
readonly name: "name";
|
|
6331
|
+
readonly sdkName: "name";
|
|
6332
|
+
readonly description: "Project-local binding alias from bindings.list; detach only after removing all clips that reference its library.";
|
|
6333
|
+
}];
|
|
6334
|
+
readonly query: readonly [];
|
|
6335
|
+
}, {
|
|
6336
|
+
readonly resource: "cut.projects.exports";
|
|
6337
|
+
readonly method: "list";
|
|
6338
|
+
readonly summary: "List project exports";
|
|
6339
|
+
readonly description: "Find export jobs associated with this project before polling or canceling a render. Copy an export id into praxis.cut.exports.retrieve or cancel. Continue with next_page_token as page_token when present; queued or in-progress jobs have not produced a final media asset.";
|
|
6340
|
+
readonly http: "GET";
|
|
6341
|
+
readonly path: "/cut/v1/projects/{project_id}/exports";
|
|
6342
|
+
readonly streaming: "no";
|
|
6343
|
+
readonly pagination: false;
|
|
6344
|
+
readonly pathParams: readonly [{
|
|
6345
|
+
readonly name: "project_id";
|
|
6346
|
+
readonly sdkName: "project_id";
|
|
6347
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6348
|
+
}];
|
|
6349
|
+
readonly query: readonly [{
|
|
6350
|
+
readonly name: "page_size";
|
|
6351
|
+
readonly type: "integer";
|
|
6352
|
+
readonly required: false;
|
|
6353
|
+
readonly description: "Maximum resources in one page, from 1 to 100; defaults to 50.";
|
|
6354
|
+
}, {
|
|
6355
|
+
readonly name: "page_token";
|
|
6356
|
+
readonly type: "string";
|
|
6357
|
+
readonly required: false;
|
|
6358
|
+
readonly description: "Opaque next_page_token from the preceding page; omit on the first request.";
|
|
6359
|
+
}, {
|
|
6360
|
+
readonly name: "filter";
|
|
6361
|
+
readonly type: "string";
|
|
6362
|
+
readonly required: false;
|
|
6363
|
+
readonly description: "Optional resource filter; projects supports state = \"active\" or state = \"deleted\".";
|
|
6364
|
+
}, {
|
|
6365
|
+
readonly name: "order_by";
|
|
6366
|
+
readonly type: "string";
|
|
6367
|
+
readonly required: false;
|
|
6368
|
+
readonly description: "Optional ordering expression; projects supports updateTime desc.";
|
|
6369
|
+
}];
|
|
6370
|
+
}, {
|
|
6371
|
+
readonly resource: "cut.projects.exports";
|
|
6372
|
+
readonly method: "create";
|
|
6373
|
+
readonly summary: "Create video export";
|
|
6374
|
+
readonly description: "Start an asynchronous video export from the project into a writable bound media library. Choose binding from bindings.list or omit it for default_upload, and optionally select revision and output settings. HTTP 202 only accepts the job; poll praxis.cut.exports.retrieve using the returned id until status is done, failed or canceled. On done, asset identifies the video written back to praxis.media. Each call starts a job, so retrieve a known job before retrying a submission.";
|
|
6375
|
+
readonly http: "POST";
|
|
6376
|
+
readonly path: "/cut/v1/projects/{project_id}/exports";
|
|
6377
|
+
readonly streaming: "no";
|
|
6378
|
+
readonly pagination: false;
|
|
6379
|
+
readonly pathParams: readonly [{
|
|
6380
|
+
readonly name: "project_id";
|
|
6381
|
+
readonly sdkName: "project_id";
|
|
6382
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6383
|
+
}];
|
|
6384
|
+
readonly query: readonly [];
|
|
6385
|
+
readonly body: {
|
|
6386
|
+
readonly required: true;
|
|
6387
|
+
readonly fields: readonly [{
|
|
6388
|
+
readonly name: "output";
|
|
6389
|
+
readonly type: "object";
|
|
6390
|
+
readonly required: false;
|
|
6391
|
+
readonly description: "Rendering options for an exported video.";
|
|
6392
|
+
}, {
|
|
6393
|
+
readonly name: "binding";
|
|
6394
|
+
readonly type: "string";
|
|
6395
|
+
readonly required: false;
|
|
6396
|
+
readonly description: "Writable binding name used as the export destination; omission uses default_upload.";
|
|
6397
|
+
}, {
|
|
6398
|
+
readonly name: "revision";
|
|
6399
|
+
readonly type: "integer";
|
|
6400
|
+
readonly required: false;
|
|
6401
|
+
readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
|
|
6402
|
+
}];
|
|
6403
|
+
};
|
|
6404
|
+
}, {
|
|
6405
|
+
readonly resource: "cut.projects.frames";
|
|
6406
|
+
readonly method: "list";
|
|
6407
|
+
readonly summary: "Render preview frames";
|
|
6408
|
+
readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Fetch the returned image URLs before expires_at; render again when they expire.";
|
|
6409
|
+
readonly http: "GET";
|
|
6410
|
+
readonly path: "/cut/v1/projects/{project_id}/frames";
|
|
6411
|
+
readonly streaming: "no";
|
|
6412
|
+
readonly pagination: false;
|
|
6413
|
+
readonly pathParams: readonly [{
|
|
6414
|
+
readonly name: "project_id";
|
|
6415
|
+
readonly sdkName: "project_id";
|
|
6416
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6417
|
+
}];
|
|
6418
|
+
readonly query: readonly [{
|
|
6419
|
+
readonly name: "at";
|
|
6420
|
+
readonly type: "string";
|
|
6421
|
+
readonly required: true;
|
|
6422
|
+
readonly description: "Required comma-separated non-negative project times in seconds, for example 12,15.5.";
|
|
6423
|
+
}, {
|
|
6424
|
+
readonly name: "scale";
|
|
6425
|
+
readonly type: "number";
|
|
6426
|
+
readonly required: false;
|
|
6427
|
+
readonly description: "Positive image size multiplier; 0.5 renders at half the project dimensions.";
|
|
6428
|
+
}, {
|
|
6429
|
+
readonly name: "revision";
|
|
6430
|
+
readonly type: "integer";
|
|
6431
|
+
readonly required: false;
|
|
6432
|
+
readonly description: "Optional committed project revision from state or execute; omission selects the current revision.";
|
|
6433
|
+
}];
|
|
6434
|
+
}, {
|
|
6435
|
+
readonly resource: "cut.projects.media";
|
|
6436
|
+
readonly method: "import";
|
|
6437
|
+
readonly summary: "Import project media";
|
|
6438
|
+
readonly description: "Import a URL, data URI or existing file into a writable project media library. Select binding from bindings.list or omit it to use default_upload. Save library_id and asset_id from the result and use them as libraryId and assetId inside execute script media references; overwrites follow the source asset latest version.";
|
|
6439
|
+
readonly http: "POST";
|
|
6440
|
+
readonly path: "/cut/v1/projects/{project_id}/media:import";
|
|
6441
|
+
readonly streaming: "no";
|
|
6442
|
+
readonly pagination: false;
|
|
6443
|
+
readonly pathParams: readonly [{
|
|
6444
|
+
readonly name: "project_id";
|
|
6445
|
+
readonly sdkName: "project_id";
|
|
6446
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6447
|
+
}];
|
|
6448
|
+
readonly query: readonly [];
|
|
6449
|
+
readonly body: {
|
|
6450
|
+
readonly required: true;
|
|
6451
|
+
readonly fields: readonly [{
|
|
6452
|
+
readonly name: "binding";
|
|
6453
|
+
readonly type: "string";
|
|
6454
|
+
readonly required: false;
|
|
6455
|
+
readonly description: "Writable binding name from project bindings; omission uses default_upload.";
|
|
6456
|
+
}, {
|
|
6457
|
+
readonly name: "source";
|
|
6458
|
+
readonly type: "object";
|
|
6459
|
+
readonly required: true;
|
|
6460
|
+
readonly description: "Exactly one input source for the imported asset.";
|
|
6461
|
+
}, {
|
|
6462
|
+
readonly name: "display_name";
|
|
6463
|
+
readonly type: "string";
|
|
6464
|
+
readonly required: false;
|
|
6465
|
+
readonly description: "Optional human-readable display name for the new media asset.";
|
|
6466
|
+
}];
|
|
6467
|
+
};
|
|
6468
|
+
}, {
|
|
6469
|
+
readonly resource: "cut.projects";
|
|
6470
|
+
readonly method: "retrieveState";
|
|
6471
|
+
readonly summary: "Read editing state";
|
|
6472
|
+
readonly description: "Read lightweight project context before composing an execute script. Returns current revision, rendering settings, track counts, library bindings and offline media count without individual clips. For complete clip documents or a selected time range, read timeline instead.";
|
|
6473
|
+
readonly http: "GET";
|
|
6474
|
+
readonly path: "/cut/v1/projects/{project_id}/state";
|
|
6475
|
+
readonly streaming: "no";
|
|
6476
|
+
readonly pagination: false;
|
|
6477
|
+
readonly pathParams: readonly [{
|
|
6478
|
+
readonly name: "project_id";
|
|
6479
|
+
readonly sdkName: "project_id";
|
|
6480
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6481
|
+
}];
|
|
6482
|
+
readonly query: readonly [];
|
|
6483
|
+
}, {
|
|
6484
|
+
readonly resource: "cut.projects";
|
|
6485
|
+
readonly method: "retrieveTimeline";
|
|
6486
|
+
readonly summary: "Read project timeline";
|
|
6487
|
+
readonly description: "Inspect clips and markers in a selected project range before editing. view=full returns structured tracks with all timeline positions in seconds; view=compact returns compact text for script context. from and to are seconds and tracks limits the selection to comma-separated track ids from state. Concurrent changes while preparing a full timeline return 409; retrieve the latest state and try the read again.";
|
|
6488
|
+
readonly http: "GET";
|
|
6489
|
+
readonly path: "/cut/v1/projects/{project_id}/timeline";
|
|
6490
|
+
readonly streaming: "no";
|
|
6491
|
+
readonly pagination: false;
|
|
6492
|
+
readonly pathParams: readonly [{
|
|
6493
|
+
readonly name: "project_id";
|
|
6494
|
+
readonly sdkName: "project_id";
|
|
6495
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6496
|
+
}];
|
|
6497
|
+
readonly query: readonly [{
|
|
6498
|
+
readonly name: "view";
|
|
6499
|
+
readonly type: "string";
|
|
6500
|
+
readonly enum: readonly ["full", "compact"];
|
|
6501
|
+
readonly required: false;
|
|
6502
|
+
readonly description: "full returns structured clips; compact returns compact textual editing context.";
|
|
6503
|
+
}, {
|
|
6504
|
+
readonly name: "from";
|
|
6505
|
+
readonly type: "number";
|
|
6506
|
+
readonly required: false;
|
|
6507
|
+
readonly description: "Optional start of the selected project range in seconds; omit for the beginning.";
|
|
6508
|
+
}, {
|
|
6509
|
+
readonly name: "to";
|
|
6510
|
+
readonly type: "number";
|
|
6511
|
+
readonly required: false;
|
|
6512
|
+
readonly description: "Optional end of the selected project range in seconds; omit for the end.";
|
|
6513
|
+
}, {
|
|
6514
|
+
readonly name: "tracks";
|
|
6515
|
+
readonly type: "string";
|
|
6516
|
+
readonly required: false;
|
|
6517
|
+
readonly description: "Comma-separated track ids from state to include; omit to include every track.";
|
|
6518
|
+
}];
|
|
6519
|
+
}, {
|
|
6520
|
+
readonly resource: "cut.projects.versions";
|
|
6521
|
+
readonly method: "list";
|
|
6522
|
+
readonly summary: "List saved versions";
|
|
6523
|
+
readonly description: "Find saved timeline snapshots for this project and obtain version_id values for restore. A saved version records its original revision; restoring it creates a new current revision rather than rewinding the revision counter. Continue with next_page_token as page_token until absent.";
|
|
6524
|
+
readonly http: "GET";
|
|
6525
|
+
readonly path: "/cut/v1/projects/{project_id}/versions";
|
|
6526
|
+
readonly streaming: "no";
|
|
6527
|
+
readonly pagination: false;
|
|
6528
|
+
readonly pathParams: readonly [{
|
|
6529
|
+
readonly name: "project_id";
|
|
6530
|
+
readonly sdkName: "project_id";
|
|
6531
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6532
|
+
}];
|
|
6533
|
+
readonly query: readonly [{
|
|
6534
|
+
readonly name: "page_size";
|
|
6535
|
+
readonly type: "integer";
|
|
6536
|
+
readonly required: false;
|
|
6537
|
+
readonly description: "Maximum resources in one page, from 1 to 100; defaults to 50.";
|
|
6538
|
+
}, {
|
|
6539
|
+
readonly name: "page_token";
|
|
6540
|
+
readonly type: "string";
|
|
6541
|
+
readonly required: false;
|
|
6542
|
+
readonly description: "Opaque next_page_token from the preceding page; omit on the first request.";
|
|
6543
|
+
}, {
|
|
6544
|
+
readonly name: "filter";
|
|
6545
|
+
readonly type: "string";
|
|
6546
|
+
readonly required: false;
|
|
6547
|
+
readonly description: "Optional resource filter; projects supports state = \"active\" or state = \"deleted\".";
|
|
6548
|
+
}, {
|
|
6549
|
+
readonly name: "order_by";
|
|
6550
|
+
readonly type: "string";
|
|
6551
|
+
readonly required: false;
|
|
6552
|
+
readonly description: "Optional ordering expression; projects supports updateTime desc.";
|
|
6553
|
+
}];
|
|
6554
|
+
}, {
|
|
6555
|
+
readonly resource: "cut.projects.versions";
|
|
6556
|
+
readonly method: "create";
|
|
6557
|
+
readonly summary: "Save project version";
|
|
6558
|
+
readonly description: "Save the current project timeline as a named recovery point before a substantial edit. Supply an optional label or send an empty object; keep the returned version id for versions.restore. Saving a version does not publish a rendered asset; use projects.exports.create for video output.";
|
|
6559
|
+
readonly http: "POST";
|
|
6560
|
+
readonly path: "/cut/v1/projects/{project_id}/versions";
|
|
6561
|
+
readonly streaming: "no";
|
|
6562
|
+
readonly pagination: false;
|
|
6563
|
+
readonly pathParams: readonly [{
|
|
6564
|
+
readonly name: "project_id";
|
|
6565
|
+
readonly sdkName: "project_id";
|
|
6566
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6567
|
+
}];
|
|
6568
|
+
readonly query: readonly [];
|
|
6569
|
+
readonly body: {
|
|
6570
|
+
readonly required: true;
|
|
6571
|
+
readonly fields: readonly [{
|
|
6572
|
+
readonly name: "label";
|
|
6573
|
+
readonly type: "string";
|
|
6574
|
+
readonly required: false;
|
|
6575
|
+
readonly description: "Human-readable snapshot label, such as Before captions.";
|
|
6576
|
+
}];
|
|
6577
|
+
};
|
|
6578
|
+
}, {
|
|
6579
|
+
readonly resource: "cut.projects";
|
|
6580
|
+
readonly method: "execute";
|
|
6581
|
+
readonly summary: "Execute editing script";
|
|
6582
|
+
readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Use AddTrack, Insert, Update, Delete, Split, Trim, Move, RippleDeleteRange, UpdateTrack, DeleteTrack, SetSettings, AddCaptionsFromTranscript and SetMarker for writes; GetTimeline, GetItem, FindItems, GetMedia, GetTranscript and GetAnalysis read editing context; Print emits text and Preview requests frame previews. All script times are seconds; script object fields use camelCase, for example `media: {libraryId, assetId}`. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project:\n\n```js\nconst t = AddTrack(\"video\");\nInsert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3});\nPrint(t);\n```";
|
|
6583
|
+
readonly http: "POST";
|
|
6584
|
+
readonly path: "/cut/v1/projects/{project_id}:execute";
|
|
6585
|
+
readonly streaming: "no";
|
|
6586
|
+
readonly pagination: false;
|
|
6587
|
+
readonly pathParams: readonly [{
|
|
6588
|
+
readonly name: "project_id";
|
|
6589
|
+
readonly sdkName: "project_id";
|
|
6590
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6591
|
+
}];
|
|
6592
|
+
readonly query: readonly [];
|
|
6593
|
+
readonly body: {
|
|
6594
|
+
readonly required: true;
|
|
6595
|
+
readonly fields: readonly [{
|
|
6596
|
+
readonly name: "script";
|
|
6597
|
+
readonly type: "string";
|
|
6598
|
+
readonly required: false;
|
|
6599
|
+
readonly description: "Synchronous editing source using Cut execute functions; submit this or edit_id, never both. Script source is opaque: function names and object fields inside JavaScript use their documented camelCase spelling.";
|
|
6600
|
+
}, {
|
|
6601
|
+
readonly name: "edit_id";
|
|
6602
|
+
readonly type: "string";
|
|
6603
|
+
readonly required: false;
|
|
6604
|
+
readonly description: "Saved failed script identifier from error.details.edit_id; valid for ten minutes.";
|
|
6605
|
+
}, {
|
|
6606
|
+
readonly name: "edits";
|
|
6607
|
+
readonly type: "array";
|
|
6608
|
+
readonly itemType: "object";
|
|
6609
|
+
readonly required: false;
|
|
6610
|
+
readonly description: "Literal replacements applied to the saved source before rerunning.";
|
|
6611
|
+
}, {
|
|
6612
|
+
readonly name: "expected_revision";
|
|
6613
|
+
readonly type: "integer";
|
|
6614
|
+
readonly required: false;
|
|
6615
|
+
readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
|
|
6616
|
+
}];
|
|
6617
|
+
};
|
|
6618
|
+
}, {
|
|
6619
|
+
readonly resource: "cut.projects";
|
|
6620
|
+
readonly method: "undelete";
|
|
6621
|
+
readonly summary: "Restore deleted project";
|
|
6622
|
+
readonly description: "Return a retained deleted project to active state before its purge_time. Obtain project_id from projects.list filtered to deleted projects. This restores the project, not an older timeline revision; use versions.restore when reverting editing content.";
|
|
6623
|
+
readonly http: "POST";
|
|
6624
|
+
readonly path: "/cut/v1/projects/{project_id}:undelete";
|
|
6625
|
+
readonly streaming: "no";
|
|
6626
|
+
readonly pagination: false;
|
|
6627
|
+
readonly pathParams: readonly [{
|
|
6628
|
+
readonly name: "project_id";
|
|
6629
|
+
readonly sdkName: "project_id";
|
|
6630
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
6631
|
+
}];
|
|
6632
|
+
readonly query: readonly [];
|
|
6633
|
+
}, {
|
|
6634
|
+
readonly resource: "cut.versions";
|
|
6635
|
+
readonly method: "restore";
|
|
6636
|
+
readonly summary: "Restore saved version";
|
|
6637
|
+
readonly description: "Replace current editing content with a saved project snapshot selected from projects.versions.list. The restore commits a new transaction and revision while preserving the saved version for future use. Inspect the returned summary and timeline before further editing; a response revision conflict can follow a committed restore, so retrieve current state before retrying.";
|
|
6638
|
+
readonly http: "POST";
|
|
6639
|
+
readonly path: "/cut/v1/versions/{version_id}:restore";
|
|
6640
|
+
readonly streaming: "no";
|
|
6641
|
+
readonly pagination: false;
|
|
6642
|
+
readonly pathParams: readonly [{
|
|
6643
|
+
readonly name: "version_id";
|
|
6644
|
+
readonly sdkName: "version_id";
|
|
6645
|
+
readonly description: "Version identifier returned by its create or list operation; use the id, not a display name.";
|
|
6646
|
+
}];
|
|
6647
|
+
readonly query: readonly [];
|
|
6648
|
+
}, {
|
|
6649
|
+
readonly resource: "database.databases";
|
|
6650
|
+
readonly method: "list";
|
|
6651
|
+
readonly summary: "List databases";
|
|
6652
|
+
readonly description: "Find databases owned by your tenant and obtain their ids for schema or row operations. Excludes deleting by default. status=active or status=deleting selects that state; invalid values return 400 INVALID_PARAMS.";
|
|
6653
|
+
readonly http: "GET";
|
|
6654
|
+
readonly path: "/database/v1/databases";
|
|
6655
|
+
readonly streaming: "no";
|
|
6656
|
+
readonly pagination: true;
|
|
6657
|
+
readonly pathParams: readonly [];
|
|
6658
|
+
readonly query: readonly [{
|
|
6659
|
+
readonly name: "cursor";
|
|
6660
|
+
readonly type: "string";
|
|
6661
|
+
readonly required: false;
|
|
6662
|
+
readonly description: "Opaque next_cursor from the previous page.";
|
|
6663
|
+
}, {
|
|
6664
|
+
readonly name: "limit";
|
|
6665
|
+
readonly type: "integer";
|
|
6666
|
+
readonly required: false;
|
|
6667
|
+
readonly description: "Page size.";
|
|
6668
|
+
}, {
|
|
6669
|
+
readonly name: "labels";
|
|
6670
|
+
readonly type: "object";
|
|
6671
|
+
readonly required: false;
|
|
6672
|
+
readonly description: "Exact label match, encoded as labels[purpose]=docs.";
|
|
6673
|
+
}, {
|
|
6674
|
+
readonly name: "status";
|
|
6675
|
+
readonly type: "string";
|
|
6676
|
+
readonly enum: readonly ["active", "deleting"];
|
|
6677
|
+
readonly required: false;
|
|
6678
|
+
readonly description: "Filter by lifecycle state. active (the default when omitted) lists usable databases; deleting lists databases that were deleted and are still inside the seven-day restore window. Any other value returns 400 INVALID_PARAMS.";
|
|
6679
|
+
}];
|
|
6680
|
+
}, {
|
|
6681
|
+
readonly resource: "database.databases";
|
|
6682
|
+
readonly method: "create";
|
|
6683
|
+
readonly summary: "Create database";
|
|
6684
|
+
readonly description: "Creates an empty database for the caller and returns it with status active (HTTP 201); add tables next with praxis.database.databases.tables.create. name is required and is 1–64 visible characters after trimming. labels are optional string tags (at most 64; each key starts with a lowercase letter and uses up to 63 characters of a-z 0-9 _ -; each value is up to 63 characters of a-z 0-9 _ -) that databaseListDatabases can filter on. If initialization fails the call returns 503 CAPACITY and the half-created database is left with status failed; retry by calling create again, which makes a new database. Unlike Supabase, this creates a SQLite-backed database without a PostgreSQL connection or SQL execution endpoint. Use a Praxis credential; access is scoped to its tenant, not to Supabase Auth users or RLS policies.";
|
|
6685
|
+
readonly http: "POST";
|
|
6686
|
+
readonly path: "/database/v1/databases";
|
|
6687
|
+
readonly streaming: "no";
|
|
6688
|
+
readonly pagination: false;
|
|
6689
|
+
readonly pathParams: readonly [];
|
|
6690
|
+
readonly query: readonly [];
|
|
6691
|
+
readonly body: {
|
|
6692
|
+
readonly required: true;
|
|
6693
|
+
readonly fields: readonly [{
|
|
6694
|
+
readonly name: "name";
|
|
6695
|
+
readonly type: "string";
|
|
6696
|
+
readonly required: true;
|
|
6697
|
+
readonly description: "Display name for the database: 1–64 visible characters after trimming; control characters are rejected. It is not an identifier, so later calls still use the returned id.";
|
|
6698
|
+
}, {
|
|
6699
|
+
readonly name: "labels";
|
|
6700
|
+
readonly type: "object";
|
|
6701
|
+
readonly required: false;
|
|
6702
|
+
readonly description: "Optional string tags to attach, at most 64. Each key starts with a lowercase letter and may use up to 63 characters of a-z 0-9 _ -; each value is up to 63 characters of a-z 0-9 _ -. List calls filter on exact key and value pairs.";
|
|
6703
|
+
}];
|
|
6704
|
+
};
|
|
6705
|
+
}, {
|
|
6706
|
+
readonly resource: "database.databases";
|
|
6707
|
+
readonly method: "delete";
|
|
6708
|
+
readonly summary: "Delete database";
|
|
6709
|
+
readonly description: "Soft-delete a database when it should stop accepting schema and row operations. Idempotently enters deleting with a seven-day purge_at. GET remains available; child operations return 409 until restored.";
|
|
6710
|
+
readonly http: "DELETE";
|
|
6711
|
+
readonly path: "/database/v1/databases/{database_id}";
|
|
6712
|
+
readonly streaming: "no";
|
|
6713
|
+
readonly pagination: false;
|
|
6714
|
+
readonly pathParams: readonly [{
|
|
6715
|
+
readonly name: "database_id";
|
|
6716
|
+
readonly sdkName: "database_id";
|
|
6717
|
+
readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
|
|
6718
|
+
}];
|
|
6719
|
+
readonly query: readonly [];
|
|
6720
|
+
}, {
|
|
6721
|
+
readonly resource: "database.databases";
|
|
6722
|
+
readonly method: "retrieve";
|
|
6723
|
+
readonly summary: "Get database";
|
|
6724
|
+
readonly description: "Returns one database by id, including a database in the deleting state (purge_at then shows when it will be permanently removed). Call it before table or row operations to confirm status is active: schema and row calls on a deleting database return 409 DATABASE_INVALID_STATE. size_bytes is refreshed from live storage at most once every five seconds. A purged or unknown id returns 404 DATABASE_NOT_FOUND.";
|
|
6725
|
+
readonly http: "GET";
|
|
6726
|
+
readonly path: "/database/v1/databases/{database_id}";
|
|
6727
|
+
readonly streaming: "no";
|
|
6728
|
+
readonly pagination: false;
|
|
6729
|
+
readonly pathParams: readonly [{
|
|
6730
|
+
readonly name: "database_id";
|
|
6731
|
+
readonly sdkName: "database_id";
|
|
6732
|
+
readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
|
|
6733
|
+
}];
|
|
6734
|
+
readonly query: readonly [];
|
|
6735
|
+
}, {
|
|
6736
|
+
readonly resource: "database.databases";
|
|
6737
|
+
readonly method: "update";
|
|
6738
|
+
readonly summary: "Update database";
|
|
6739
|
+
readonly description: "Renames an active database and/or replaces its labels; send only the keys you want to change. labels is replaced as a whole, not merged, so include every label you want to keep. A body without name or labels, or with values equal to the current ones, changes nothing and leaves updated_at as is. A database in the deleting state returns 409 DATABASE_INVALID_STATE; restore it first with databaseRestoreDatabase.";
|
|
6740
|
+
readonly http: "PATCH";
|
|
6741
|
+
readonly path: "/database/v1/databases/{database_id}";
|
|
6742
|
+
readonly streaming: "no";
|
|
6743
|
+
readonly pagination: false;
|
|
6744
|
+
readonly pathParams: readonly [{
|
|
6745
|
+
readonly name: "database_id";
|
|
6746
|
+
readonly sdkName: "database_id";
|
|
6747
|
+
readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
|
|
6748
|
+
}];
|
|
6749
|
+
readonly query: readonly [];
|
|
6750
|
+
readonly body: {
|
|
6751
|
+
readonly required: true;
|
|
6752
|
+
readonly fields: readonly [{
|
|
6753
|
+
readonly name: "name";
|
|
6754
|
+
readonly type: "string";
|
|
6755
|
+
readonly required: false;
|
|
6756
|
+
readonly description: "New display name, 1–64 visible characters after trimming. Omit it to keep the current name.";
|
|
6757
|
+
}, {
|
|
6758
|
+
readonly name: "labels";
|
|
6759
|
+
readonly type: "object";
|
|
6760
|
+
readonly required: false;
|
|
6761
|
+
readonly description: "Complete replacement label set, not a merge: labels not listed here are removed. Same limits as at creation (at most 64; keys a-z 0-9 _ - starting with a letter; values up to 63 characters of a-z 0-9 _ -). Omit it to keep the current labels.";
|
|
6762
|
+
}];
|
|
6763
|
+
};
|
|
6764
|
+
}, {
|
|
6765
|
+
readonly resource: "database.databases.events";
|
|
6766
|
+
readonly method: "list";
|
|
6767
|
+
readonly summary: "List events";
|
|
6768
|
+
readonly description: "Read lifecycle and schema events, including while the database is deleting. next_cursor is an opaque string cursor (do not do arithmetic on it): pass it as after_seq for asc or before_seq for desc. Supplying both cursors returns 400 INVALID_PARAMS. Unlike Supabase Realtime, this is paged lifecycle and schema history, not a subscription or a row-change feed; row inserts, updates and deletes do not appear here.";
|
|
6769
|
+
readonly http: "GET";
|
|
6770
|
+
readonly path: "/database/v1/databases/{database_id}/events";
|
|
6771
|
+
readonly streaming: "no";
|
|
6772
|
+
readonly pagination: false;
|
|
6773
|
+
readonly pathParams: readonly [{
|
|
6774
|
+
readonly name: "database_id";
|
|
6775
|
+
readonly sdkName: "database_id";
|
|
6776
|
+
readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
|
|
6777
|
+
}];
|
|
6778
|
+
readonly query: readonly [{
|
|
6779
|
+
readonly name: "after_seq";
|
|
6780
|
+
readonly type: "integer";
|
|
6781
|
+
readonly required: false;
|
|
6782
|
+
readonly description: "With order=asc, return only events with seq greater than this value. Cannot be combined with before_seq.";
|
|
6783
|
+
}, {
|
|
6784
|
+
readonly name: "limit";
|
|
6785
|
+
readonly type: "integer";
|
|
6786
|
+
readonly required: false;
|
|
6787
|
+
readonly description: "Page size.";
|
|
6788
|
+
}, {
|
|
6789
|
+
readonly name: "order";
|
|
6790
|
+
readonly type: "string";
|
|
6791
|
+
readonly enum: readonly ["asc", "desc"];
|
|
6792
|
+
readonly required: false;
|
|
6793
|
+
readonly description: "Sequence order: asc or desc (newest first). Defaults to asc, or to desc when before_seq is supplied.";
|
|
6794
|
+
}, {
|
|
6795
|
+
readonly name: "before_seq";
|
|
6796
|
+
readonly type: "integer";
|
|
6797
|
+
readonly required: false;
|
|
6798
|
+
readonly description: "Return only events with seq less than this value, newest first; implies order=desc when order is omitted. Cannot be combined with after_seq or order=asc.";
|
|
6799
|
+
}];
|
|
6800
|
+
}, {
|
|
6801
|
+
readonly resource: "database.databases.purge";
|
|
6802
|
+
readonly method: "create";
|
|
6803
|
+
readonly summary: "Permanently purge database";
|
|
6804
|
+
readonly description: "Immediately and irreversibly purges a deleting database. Active databases return 409; absent or already purged databases return 404.";
|
|
6805
|
+
readonly http: "POST";
|
|
6806
|
+
readonly path: "/database/v1/databases/{database_id}/purge";
|
|
6807
|
+
readonly streaming: "no";
|
|
6808
|
+
readonly pagination: false;
|
|
6809
|
+
readonly pathParams: readonly [{
|
|
6810
|
+
readonly name: "database_id";
|
|
6811
|
+
readonly sdkName: "database_id";
|
|
6812
|
+
readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
|
|
6813
|
+
}];
|
|
5935
6814
|
readonly query: readonly [];
|
|
5936
6815
|
}, {
|
|
5937
6816
|
readonly resource: "database.databases.rest";
|
|
@@ -6596,7 +7475,7 @@ export declare const operations: readonly [{
|
|
|
6596
7475
|
readonly resource: "file.files";
|
|
6597
7476
|
readonly method: "create";
|
|
6598
7477
|
readonly summary: "Upload file";
|
|
6599
|
-
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data
|
|
7478
|
+
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.";
|
|
6600
7479
|
readonly http: "POST";
|
|
6601
7480
|
readonly path: "/file/v1/files";
|
|
6602
7481
|
readonly streaming: "no";
|
|
@@ -6614,19 +7493,14 @@ export declare const operations: readonly [{
|
|
|
6614
7493
|
}, {
|
|
6615
7494
|
readonly name: "purpose";
|
|
6616
7495
|
readonly type: "string";
|
|
6617
|
-
readonly enum: readonly ["user_data", "
|
|
7496
|
+
readonly enum: readonly ["user_data", "vision"];
|
|
6618
7497
|
readonly required: true;
|
|
6619
|
-
readonly description: "Purpose label stored with the file: user_data
|
|
7498
|
+
readonly description: "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
|
|
6620
7499
|
}, {
|
|
6621
7500
|
readonly name: "expires_after";
|
|
6622
7501
|
readonly type: "object";
|
|
6623
7502
|
readonly required: false;
|
|
6624
7503
|
readonly description: "Optional expiry relative to created_at. Files without an expiry persist until deleted.";
|
|
6625
|
-
}, {
|
|
6626
|
-
readonly name: "praxis";
|
|
6627
|
-
readonly type: "object";
|
|
6628
|
-
readonly required: false;
|
|
6629
|
-
readonly description: "Own-face extensions. Use at most one expiry setting.";
|
|
6630
7504
|
}];
|
|
6631
7505
|
};
|
|
6632
7506
|
}, {
|
|
@@ -6678,7 +7552,7 @@ export declare const operations: readonly [{
|
|
|
6678
7552
|
readonly resource: "file.uploads";
|
|
6679
7553
|
readonly method: "create";
|
|
6680
7554
|
readonly summary: "Create an upload";
|
|
6681
|
-
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data
|
|
7555
|
+
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
|
|
6682
7556
|
readonly http: "POST";
|
|
6683
7557
|
readonly path: "/file/v1/uploads";
|
|
6684
7558
|
readonly streaming: "no";
|
|
@@ -6705,9 +7579,9 @@ export declare const operations: readonly [{
|
|
|
6705
7579
|
}, {
|
|
6706
7580
|
readonly name: "purpose";
|
|
6707
7581
|
readonly type: "string";
|
|
6708
|
-
readonly enum: readonly ["user_data", "
|
|
7582
|
+
readonly enum: readonly ["user_data", "vision"];
|
|
6709
7583
|
readonly required: true;
|
|
6710
|
-
readonly description: "Use user_data for conversation attachments,
|
|
7584
|
+
readonly description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images.";
|
|
6711
7585
|
}, {
|
|
6712
7586
|
readonly name: "expires_after";
|
|
6713
7587
|
readonly type: "object";
|
|
@@ -7657,7 +8531,7 @@ export declare const operations: readonly [{
|
|
|
7657
8531
|
readonly name: "overwrite";
|
|
7658
8532
|
readonly type: "boolean";
|
|
7659
8533
|
readonly required: false;
|
|
7660
|
-
readonly description: "Allow replacing an existing public_id, preserving its asset_id and increasing its version. False returns the existing resource without replacing it; defaults to true.";
|
|
8534
|
+
readonly description: "Allow replacing an existing public_id, preserving its asset_id and increasing its version. Only the latest version is deliverable; old version URLs return 404. Create a new public_id to retain old deliveries. False returns the existing resource without replacing it; defaults to true.";
|
|
7661
8535
|
}, {
|
|
7662
8536
|
readonly name: "tags";
|
|
7663
8537
|
readonly type: "object";
|
|
@@ -7702,6 +8576,7 @@ export declare const operations: readonly [{
|
|
|
7702
8576
|
readonly name: "file_id";
|
|
7703
8577
|
readonly type: "string";
|
|
7704
8578
|
readonly required: true;
|
|
8579
|
+
readonly description: "File ID to copy into this library; passed as the upload source instead of file bytes. This creates an independent public copy readable without authentication. Deleting the source File does not delete this asset; do not import confidential content.";
|
|
7705
8580
|
}, {
|
|
7706
8581
|
readonly name: "public_id";
|
|
7707
8582
|
readonly type: "string";
|
|
@@ -7746,7 +8621,7 @@ export declare const operations: readonly [{
|
|
|
7746
8621
|
readonly name: "overwrite";
|
|
7747
8622
|
readonly type: "boolean";
|
|
7748
8623
|
readonly required: false;
|
|
7749
|
-
readonly description: "Allow replacing an existing public_id, preserving its asset_id and increasing its version. False returns the existing resource without replacing it; defaults to true.";
|
|
8624
|
+
readonly description: "Allow replacing an existing public_id, preserving its asset_id and increasing its version. Only the latest version is deliverable; old version URLs return 404. Create a new public_id to retain old deliveries. False returns the existing resource without replacing it; defaults to true.";
|
|
7750
8625
|
}, {
|
|
7751
8626
|
readonly name: "tags";
|
|
7752
8627
|
readonly type: "object";
|
|
@@ -8155,7 +9030,7 @@ export declare const operations: readonly [{
|
|
|
8155
9030
|
readonly name: "expression";
|
|
8156
9031
|
readonly type: "string";
|
|
8157
9032
|
readonly required: false;
|
|
8158
|
-
readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets.";
|
|
9033
|
+
readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: [\"context\"] to include context.";
|
|
8159
9034
|
}, {
|
|
8160
9035
|
readonly name: "sort_by";
|
|
8161
9036
|
readonly type: "array";
|
|
@@ -8267,6 +9142,54 @@ export declare const operations: readonly [{
|
|
|
8267
9142
|
readonly description: "Expression filter restricting eligible result assets.";
|
|
8268
9143
|
}];
|
|
8269
9144
|
};
|
|
9145
|
+
}, {
|
|
9146
|
+
readonly resource: "meta.docs";
|
|
9147
|
+
readonly method: "search";
|
|
9148
|
+
readonly summary: "Search platform documentation";
|
|
9149
|
+
readonly 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.";
|
|
9150
|
+
readonly http: "GET";
|
|
9151
|
+
readonly path: "/meta/v1/docs/search";
|
|
9152
|
+
readonly streaming: "no";
|
|
9153
|
+
readonly pagination: false;
|
|
9154
|
+
readonly pathParams: readonly [];
|
|
9155
|
+
readonly query: readonly [{
|
|
9156
|
+
readonly name: "q";
|
|
9157
|
+
readonly type: "string";
|
|
9158
|
+
readonly required: true;
|
|
9159
|
+
readonly description: "Keywords describing the syntax or guide needed, for example export or workflow.";
|
|
9160
|
+
}, {
|
|
9161
|
+
readonly name: "limit";
|
|
9162
|
+
readonly type: "integer";
|
|
9163
|
+
readonly required: false;
|
|
9164
|
+
readonly description: "Maximum number of matching pages returned; integer 1–50, default 20.";
|
|
9165
|
+
}, {
|
|
9166
|
+
readonly name: "lang";
|
|
9167
|
+
readonly type: "string";
|
|
9168
|
+
readonly enum: readonly ["zh", "en"];
|
|
9169
|
+
readonly required: false;
|
|
9170
|
+
readonly description: "Documentation language: zh for Chinese (default), en for English.";
|
|
9171
|
+
}];
|
|
9172
|
+
}, {
|
|
9173
|
+
readonly resource: "meta.docs";
|
|
9174
|
+
readonly method: "retrieve";
|
|
9175
|
+
readonly summary: "Read documentation Markdown";
|
|
9176
|
+
readonly 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.";
|
|
9177
|
+
readonly http: "GET";
|
|
9178
|
+
readonly path: "/meta/v1/docs/{path}";
|
|
9179
|
+
readonly streaming: "no";
|
|
9180
|
+
readonly pagination: false;
|
|
9181
|
+
readonly pathParams: readonly [{
|
|
9182
|
+
readonly name: "path";
|
|
9183
|
+
readonly sdkName: "path";
|
|
9184
|
+
readonly description: "Slash-separated documentation path from docs.search; optionally append #heading-id to select a section.";
|
|
9185
|
+
}];
|
|
9186
|
+
readonly query: readonly [{
|
|
9187
|
+
readonly name: "lang";
|
|
9188
|
+
readonly type: "string";
|
|
9189
|
+
readonly enum: readonly ["zh", "en"];
|
|
9190
|
+
readonly required: false;
|
|
9191
|
+
readonly description: "Documentation language: zh for Chinese (default), en for English.";
|
|
9192
|
+
}];
|
|
8270
9193
|
}, {
|
|
8271
9194
|
readonly resource: "meta.health";
|
|
8272
9195
|
readonly method: "retrieve";
|
|
@@ -9346,7 +10269,7 @@ export declare const operations: readonly [{
|
|
|
9346
10269
|
readonly name: "supported_api";
|
|
9347
10270
|
readonly type: "array";
|
|
9348
10271
|
readonly itemType: "string";
|
|
9349
|
-
readonly enum: readonly ["anthropic.messages", "cohere.rerank", "google.generateContent", "mistral.ocr", "openai.audio.speech", "openai.audio.transcriptions", "openai.chat.completions", "openai.embeddings", "openai.images.edits", "openai.images.generations", "openai.responses", "openai.videos"];
|
|
10272
|
+
readonly enum: readonly ["anthropic.messages", "cohere.rerank", "google.generateContent", "mistral.ocr", "openai.audio.speech", "openai.audio.transcriptions", "openai.chat.completions", "openai.embeddings", "openai.images.edits", "openai.images.generations", "openai.responses", "openai.videos", "typesafe.systemone"];
|
|
9350
10273
|
readonly required: false;
|
|
9351
10274
|
readonly 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.";
|
|
9352
10275
|
}, {
|
|
@@ -9804,6 +10727,41 @@ export declare const operations: readonly [{
|
|
|
9804
10727
|
readonly description: "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404.";
|
|
9805
10728
|
}];
|
|
9806
10729
|
readonly query: readonly [];
|
|
10730
|
+
}, {
|
|
10731
|
+
readonly resource: "model.systemone";
|
|
10732
|
+
readonly method: "create";
|
|
10733
|
+
readonly summary: "Ask structured decision questions";
|
|
10734
|
+
readonly 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.";
|
|
10735
|
+
readonly http: "POST";
|
|
10736
|
+
readonly path: "/model/v1/systemone";
|
|
10737
|
+
readonly streaming: "no";
|
|
10738
|
+
readonly pagination: false;
|
|
10739
|
+
readonly pathParams: readonly [];
|
|
10740
|
+
readonly query: readonly [];
|
|
10741
|
+
readonly body: {
|
|
10742
|
+
readonly required: true;
|
|
10743
|
+
readonly fields: readonly [{
|
|
10744
|
+
readonly name: "model";
|
|
10745
|
+
readonly type: "string";
|
|
10746
|
+
readonly required: true;
|
|
10747
|
+
readonly description: "Published model id from model.models.list with supported_apis containing typesafe.systemone; returned unchanged in the response.";
|
|
10748
|
+
}, {
|
|
10749
|
+
readonly name: "state";
|
|
10750
|
+
readonly type: "object";
|
|
10751
|
+
readonly required: true;
|
|
10752
|
+
readonly description: "Shared content evaluated by every question, supplied as text, a JSON object or an array.";
|
|
10753
|
+
}, {
|
|
10754
|
+
readonly name: "questions";
|
|
10755
|
+
readonly type: "object";
|
|
10756
|
+
readonly required: true;
|
|
10757
|
+
readonly 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.";
|
|
10758
|
+
}, {
|
|
10759
|
+
readonly name: "assets";
|
|
10760
|
+
readonly type: "object";
|
|
10761
|
+
readonly required: false;
|
|
10762
|
+
readonly description: "Unsupported image assets. Supplying this field, including null or an empty collection, returns 400: images are not supported.";
|
|
10763
|
+
}];
|
|
10764
|
+
};
|
|
9807
10765
|
}, {
|
|
9808
10766
|
readonly resource: "model.videos";
|
|
9809
10767
|
readonly method: "list";
|