@deepraxis/sdk 0.1.1-dev.ea219e1 → 0.1.1-dev.eb022f5

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.
@@ -4,7 +4,7 @@ export const operations = [
4
4
  "resource": "agent.agents",
5
5
  "method": "list",
6
6
  "summary": "List agents",
7
- "description": "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=general or kind=personal for durable-computer agents or kind=service for per-session environments. Pass next_page from the response as page to read the next page; a null next_page means the end.",
7
+ "description": "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=general or kind=personal for durable-computer agents, 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.",
8
8
  "http": "GET",
9
9
  "path": "/agent/v1/agents",
10
10
  "streaming": "no",
@@ -51,7 +51,8 @@ export const operations = [
51
51
  "enum": [
52
52
  "general",
53
53
  "personal",
54
- "service"
54
+ "service",
55
+ "assume"
55
56
  ],
56
57
  "required": false,
57
58
  "description": "Filter agents by their immutable kind, including agents created before kind was recorded."
@@ -62,7 +63,7 @@ export const operations = [
62
63
  "resource": "agent.agents",
63
64
  "method": "create",
64
65
  "summary": "Create agent",
65
- "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\"}]}.",
66
+ "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.",
66
67
  "http": "POST",
67
68
  "path": "/agent/v1/agents",
68
69
  "streaming": "no",
@@ -75,8 +76,8 @@ export const operations = [
75
76
  {
76
77
  "name": "model",
77
78
  "type": "object",
78
- "required": true,
79
- "description": "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected."
79
+ "required": false,
80
+ "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."
80
81
  },
81
82
  {
82
83
  "name": "name",
@@ -142,10 +143,11 @@ export const operations = [
142
143
  "enum": [
143
144
  "general",
144
145
  "personal",
145
- "service"
146
+ "service",
147
+ "assume"
146
148
  ],
147
149
  "required": false,
148
- "description": "Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error."
150
+ "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."
149
151
  },
150
152
  {
151
153
  "name": "computer_id",
@@ -183,7 +185,7 @@ export const operations = [
183
185
  "name": "settings",
184
186
  "type": "object",
185
187
  "required": false,
186
- "description": "Praxis extension: managed settings saved with the configuration revision. Omit to preserve; null clears. Configuration storage only; these switches and hooks are not applied to runtime yet. /agent/v1 only."
188
+ "description": "Agent runtime settings follow Claude Code managed settings. Praxis freezes output-style selection for each new session; inline output_styles extend file-based styles. Omit settings to keep saved settings; null clears them."
187
189
  },
188
190
  {
189
191
  "name": "models",
@@ -220,6 +222,13 @@ export const operations = [
220
222
  ],
221
223
  "required": false,
222
224
  "description": "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor."
225
+ },
226
+ {
227
+ "name": "output_styles",
228
+ "type": "array",
229
+ "itemType": "object",
230
+ "required": false,
231
+ "description": "Inline custom output styles, including for agents without a computer. Omit to keep the saved list; null or [] clears it. Same-name precedence is inline, project files, personal files, then plugins. Selection is settings.outputStyle; styles apply to main conversations and are frozen per session."
223
232
  }
224
233
  ]
225
234
  }
@@ -237,7 +246,7 @@ export const operations = [
237
246
  {
238
247
  "name": "agent_id",
239
248
  "sdkName": "agent_id",
240
- "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."
249
+ "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_…."
241
250
  }
242
251
  ],
243
252
  "query": [
@@ -253,7 +262,7 @@ export const operations = [
253
262
  "resource": "agent.agents",
254
263
  "method": "update",
255
264
  "summary": "Update agent",
256
- "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.",
265
+ "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.",
257
266
  "http": "POST",
258
267
  "path": "/agent/v1/agents/{agent_id}",
259
268
  "streaming": "no",
@@ -262,7 +271,7 @@ export const operations = [
262
271
  {
263
272
  "name": "agent_id",
264
273
  "sdkName": "agent_id",
265
- "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."
274
+ "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_…."
266
275
  }
267
276
  ],
268
277
  "query": [],
@@ -292,7 +301,7 @@ export const operations = [
292
301
  "name": "model",
293
302
  "type": "object",
294
303
  "required": false,
295
- "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."
304
+ "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."
296
305
  },
297
306
  {
298
307
  "name": "multiagent",
@@ -357,10 +366,11 @@ export const operations = [
357
366
  "enum": [
358
367
  "general",
359
368
  "personal",
360
- "service"
369
+ "service",
370
+ "assume"
361
371
  ],
362
372
  "required": false,
363
- "description": "Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error."
373
+ "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."
364
374
  },
365
375
  {
366
376
  "name": "computer_id",
@@ -398,7 +408,7 @@ export const operations = [
398
408
  "name": "settings",
399
409
  "type": "object",
400
410
  "required": false,
401
- "description": "Praxis extension: managed settings saved with the configuration revision. Omit to preserve; null clears. Configuration storage only; these switches and hooks are not applied to runtime yet. /agent/v1 only."
411
+ "description": "Agent runtime settings follow Claude Code managed settings. Praxis freezes output-style selection for each new session; inline output_styles extend file-based styles. Omit settings to keep saved settings; null clears them."
402
412
  },
403
413
  {
404
414
  "name": "models",
@@ -435,6 +445,13 @@ export const operations = [
435
445
  ],
436
446
  "required": false,
437
447
  "description": "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor."
448
+ },
449
+ {
450
+ "name": "output_styles",
451
+ "type": "array",
452
+ "itemType": "object",
453
+ "required": false,
454
+ "description": "Inline custom output styles, including for agents without a computer. Omit to keep the saved list; null or [] clears it. Same-name precedence is inline, project files, personal files, then plugins. Selection is settings.outputStyle; styles apply to main conversations and are frozen per session."
438
455
  }
439
456
  ]
440
457
  }
@@ -452,7 +469,7 @@ export const operations = [
452
469
  {
453
470
  "name": "agent_id",
454
471
  "sdkName": "agent_id",
455
- "description": "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for."
472
+ "description": "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
456
473
  }
457
474
  ],
458
475
  "query": []
@@ -470,7 +487,7 @@ export const operations = [
470
487
  {
471
488
  "name": "agent_id",
472
489
  "sdkName": "agent_id",
473
- "description": "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name."
490
+ "description": "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_…."
474
491
  }
475
492
  ],
476
493
  "query": []
@@ -488,7 +505,7 @@ export const operations = [
488
505
  {
489
506
  "name": "agent_id",
490
507
  "sdkName": "agent_id",
491
- "description": "Active service agent id from agent creation or listing."
508
+ "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_…."
492
509
  }
493
510
  ],
494
511
  "query": [
@@ -541,7 +558,7 @@ export const operations = [
541
558
  {
542
559
  "name": "agent_id",
543
560
  "sdkName": "agent_id",
544
- "description": "Service agent id (agent_…) or its short identity number, from agent creation or listing."
561
+ "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_…."
545
562
  }
546
563
  ],
547
564
  "query": [],
@@ -563,7 +580,7 @@ export const operations = [
563
580
  {
564
581
  "name": "agent_id",
565
582
  "sdkName": "agent_id",
566
- "description": "Service agent id (agent_…) or its short identity number, from agent creation or listing."
583
+ "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_…."
567
584
  }
568
585
  ],
569
586
  "query": []
@@ -581,7 +598,7 @@ export const operations = [
581
598
  {
582
599
  "name": "agent_id",
583
600
  "sdkName": "agent_id",
584
- "description": "Service agent id (agent_…) or its short identity number, from agent creation or listing."
601
+ "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_…."
585
602
  }
586
603
  ],
587
604
  "query": []
@@ -599,7 +616,7 @@ export const operations = [
599
616
  {
600
617
  "name": "agent_id",
601
618
  "sdkName": "agent_id",
602
- "description": "Service agent id (agent_…) or its short identity number, from agent creation or listing."
619
+ "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_…."
603
620
  }
604
621
  ],
605
622
  "query": [],
@@ -689,7 +706,7 @@ export const operations = [
689
706
  {
690
707
  "name": "agent_id",
691
708
  "sdkName": "agent_id",
692
- "description": "Active service agent id from agent creation or listing."
709
+ "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_…."
693
710
  },
694
711
  {
695
712
  "name": "customer_id",
@@ -719,7 +736,7 @@ export const operations = [
719
736
  {
720
737
  "name": "agent_id",
721
738
  "sdkName": "agent_id",
722
- "description": "Active service agent id from agent creation or listing."
739
+ "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_…."
723
740
  },
724
741
  {
725
742
  "name": "customer_id",
@@ -742,7 +759,7 @@ export const operations = [
742
759
  {
743
760
  "name": "agent_id",
744
761
  "sdkName": "agent_id",
745
- "description": "Active service agent id from agent creation or listing."
762
+ "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_…."
746
763
  },
747
764
  {
748
765
  "name": "customer_id",
@@ -765,7 +782,7 @@ export const operations = [
765
782
  {
766
783
  "name": "agent_id",
767
784
  "sdkName": "agent_id",
768
- "description": "Active service agent id from agent creation or listing."
785
+ "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_…."
769
786
  },
770
787
  {
771
788
  "name": "customer_id",
@@ -788,7 +805,7 @@ export const operations = [
788
805
  {
789
806
  "name": "agent_id",
790
807
  "sdkName": "agent_id",
791
- "description": "Active service agent id from agent creation or listing."
808
+ "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_…."
792
809
  },
793
810
  {
794
811
  "name": "customer_id",
@@ -811,7 +828,7 @@ export const operations = [
811
828
  {
812
829
  "name": "agent_id",
813
830
  "sdkName": "agent_id",
814
- "description": "Active service agent id from agent creation or listing."
831
+ "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_…."
815
832
  },
816
833
  {
817
834
  "name": "customer_id",
@@ -834,7 +851,7 @@ export const operations = [
834
851
  {
835
852
  "name": "agent_id",
836
853
  "sdkName": "agent_id",
837
- "description": "Agent id from creation or listing."
854
+ "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_…."
838
855
  }
839
856
  ],
840
857
  "query": []
@@ -852,7 +869,7 @@ export const operations = [
852
869
  {
853
870
  "name": "agent_id",
854
871
  "sdkName": "agent_id",
855
- "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."
872
+ "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_…."
856
873
  }
857
874
  ],
858
875
  "query": [
@@ -883,7 +900,7 @@ export const operations = [
883
900
  {
884
901
  "name": "agent_id",
885
902
  "sdkName": "agent_id",
886
- "description": "Agent identifier from agents.create or agents.list."
903
+ "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_…."
887
904
  },
888
905
  {
889
906
  "name": "version",
@@ -1901,7 +1918,7 @@ export const operations = [
1901
1918
  "resource": "agent.sessions",
1902
1919
  "method": "create",
1903
1920
  "summary": "Create session",
1904
- "description": "Create a session: one conversation with an agent. Pass agent as an agent id or {type:\"agent\", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:\"agent_with_overrides\", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:\"limit\", max_list_cost:{amount, currency:\"USD\"}} where amount is a positive decimal string of US dollars with at most 2 decimal places (\"20.00\" is USD 20.00); omitted budget defaults to \"20.00\" and null removes the limit. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.",
1921
+ "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.",
1905
1922
  "http": "POST",
1906
1923
  "path": "/agent/v1/sessions",
1907
1924
  "streaming": "no",
@@ -3504,7 +3521,7 @@ export const operations = [
3504
3521
  "resource": "application.workers.grants",
3505
3522
  "method": "create",
3506
3523
  "summary": "Create grant",
3507
- "description": "Let this Worker's platform token access one of your databases, folders or knowledge bases.",
3524
+ "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).",
3508
3525
  "http": "POST",
3509
3526
  "path": "/application/v1/workers/{worker_id}/grants",
3510
3527
  "streaming": "no",
@@ -3524,7 +3541,13 @@ export const operations = [
3524
3541
  "name": "resource",
3525
3542
  "type": "object",
3526
3543
  "required": true,
3527
- "description": "Resource to grant."
3544
+ "description": "Resource to grant. Each (type, id) may be granted once per Worker; duplicates return GRANT_CONFLICT (409)."
3545
+ },
3546
+ {
3547
+ "name": "alias",
3548
+ "type": "string",
3549
+ "required": false,
3550
+ "description": "Optional name, unique within this Worker. Available for reuse after the grant is deleted."
3528
3551
  },
3529
3552
  {
3530
3553
  "name": "access",
@@ -3534,7 +3557,7 @@ export const operations = [
3534
3557
  "read_write"
3535
3558
  ],
3536
3559
  "required": true,
3537
- "description": "Access level."
3560
+ "description": "Access level; models accepts read only."
3538
3561
  }
3539
3562
  ]
3540
3563
  }
@@ -3958,7 +3981,7 @@ export const operations = [
3958
3981
  "name": "timeout_ms",
3959
3982
  "type": "number",
3960
3983
  "required": false,
3961
- "description": "Positive integer milliseconds; code defaults to and is capped at 30,000. container/shell are not yet available."
3984
+ "description": "Positive integer milliseconds; code defaults to and is capped at 300,000. container/shell are not yet available."
3962
3985
  },
3963
3986
  {
3964
3987
  "name": "implementation",
@@ -4008,7 +4031,7 @@ export const operations = [
4008
4031
  "resource": "automation.actions",
4009
4032
  "method": "update",
4010
4033
  "summary": "Update an action",
4011
- "description": "Update after checking compatibility against the current and five recent revisions. Widening inputs and narrowing outputs are compatible, including length, item count, property count, type (integer/number), and multipleOf (the new input factor divides the old one; the reverse holds for outputs). dry_run=true returns only CompatResult and may omit If-Match; a supplied header is still checked, and * matches any existing representation. Normal updates require If-Match and return ActionDef with ETag; previews return no ETag. Omitted optional fields retain their existing values only for description and labels; when constructing a new revision, errors defaults to [], omitted annotations keys to false, timeout_ms to 30000, and message to null. Incompatible normal updates return 422 SCHEMA_INCOMPATIBLE with issues; unchanged contents retain the existing revision.",
4034
+ "description": "Update after checking compatibility against the current and five recent revisions. Widening inputs and narrowing outputs are compatible, including length, item count, property count, type (integer/number), and multipleOf (the new input factor divides the old one; the reverse holds for outputs). dry_run=true returns only CompatResult and may omit If-Match; a supplied header is still checked, and * matches any existing representation. Normal updates require If-Match and return ActionDef with ETag; previews return no ETag. Omitted optional fields retain their existing values only for description and labels; when constructing a new revision, errors defaults to [], omitted annotations keys to false, timeout_ms to 300000, and message to null. Incompatible normal updates return 422 SCHEMA_INCOMPATIBLE with issues; unchanged contents retain the existing revision.",
4012
4035
  "http": "PUT",
4013
4036
  "path": "/automation/v1/actions/{ns}/{name}",
4014
4037
  "streaming": "no",
@@ -4077,7 +4100,7 @@ export const operations = [
4077
4100
  "name": "timeout_ms",
4078
4101
  "type": "number",
4079
4102
  "required": false,
4080
- "description": "Positive integer milliseconds; code defaults to and is capped at 30,000. container/shell are not yet available."
4103
+ "description": "Positive integer milliseconds; code defaults to and is capped at 300,000. container/shell are not yet available."
4081
4104
  },
4082
4105
  {
4083
4106
  "name": "implementation",
@@ -4752,7 +4775,7 @@ export const operations = [
4752
4775
  "resource": "automation.runs",
4753
4776
  "method": "create",
4754
4777
  "summary": "Run a published target or execute draft source",
4755
- "description": "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 30 days. Each run can start at most 100 child runs, with at most 20 active at once; nesting depth is limited to 10. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. With language=yaml, source is a workflow YAML: the run input is . in the first step, and the shape is described in create workflow. Error details are in errors[] (pointer, detail, hint). New non-deterministic run IDs contain 78 characters, compared with 46 for legacy random IDs; treat IDs as opaque strings. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed.",
4778
+ "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 5 min (run-sandbox after 6 h); scripts have a 30 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 1,000 child runs, with at most 100 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.",
4756
4779
  "http": "POST",
4757
4780
  "path": "/automation/v1/runs",
4758
4781
  "streaming": "no",
@@ -5500,6 +5523,96 @@ export const operations = [
5500
5523
  "fields": []
5501
5524
  }
5502
5525
  },
5526
+ {
5527
+ "resource": "automation.scripts.vaults",
5528
+ "method": "list",
5529
+ "summary": "List script vault bindings",
5530
+ "description": "Inspect the whole vaults attached to a saved script, including archived definitions, without reading secret values. Obtain ns and name from automation.scripts.list. Bindings belong to the definition rather than a published version. When vault or secret metadata cannot be read, the binding remains visible with secrets: [] and secrets_unavailable: true.",
5531
+ "http": "GET",
5532
+ "path": "/automation/v1/scripts/{ns}/{name}/vaults",
5533
+ "streaming": "no",
5534
+ "pagination": false,
5535
+ "pathParams": [
5536
+ {
5537
+ "name": "ns",
5538
+ "sdkName": "ns",
5539
+ "description": "Namespace from automation.scripts.list or create; identifies the saved script, independently of versions."
5540
+ },
5541
+ {
5542
+ "name": "name",
5543
+ "sdkName": "name",
5544
+ "description": "Resource name from automation.scripts.list or create; combine with ns to identify the saved script."
5545
+ }
5546
+ ],
5547
+ "query": []
5548
+ },
5549
+ {
5550
+ "resource": "automation.scripts.vaults",
5551
+ "method": "delete",
5552
+ "summary": "Delete a script vault binding",
5553
+ "description": "Remove the vault assignment from this saved script without deleting the vault or its secrets. Obtain aliases from automation.scripts.vaults.list. Repeating deletion of an absent alias on an existing definition succeeds. Bindings also disappear when the definition is permanently deleted, while archival retains them.",
5554
+ "http": "DELETE",
5555
+ "path": "/automation/v1/scripts/{ns}/{name}/vaults/{alias}",
5556
+ "streaming": "no",
5557
+ "pagination": false,
5558
+ "pathParams": [
5559
+ {
5560
+ "name": "ns",
5561
+ "sdkName": "ns",
5562
+ "description": "Namespace from automation.scripts.list or create; identifies the saved script, independently of versions."
5563
+ },
5564
+ {
5565
+ "name": "name",
5566
+ "sdkName": "name",
5567
+ "description": "Resource name from automation.scripts.list or create; combine with ns to identify the saved script."
5568
+ },
5569
+ {
5570
+ "name": "alias",
5571
+ "sdkName": "alias",
5572
+ "description": "Binding alias chosen by the caller: 1–40 lowercase letters, digits or hyphens, beginning with a letter."
5573
+ }
5574
+ ],
5575
+ "query": []
5576
+ },
5577
+ {
5578
+ "resource": "automation.scripts.vaults",
5579
+ "method": "set",
5580
+ "summary": "Set a script vault binding",
5581
+ "description": "Attach an entire active vault in your organization to a saved script, or replace the vault at an existing alias. Obtain the vault ID or display name from praxis.vault.vaults.list; ambiguous names require an ID. Bindings are independent of published versions and survive archival. The same vault cannot be assigned to two aliases on one definition. Repeating the same assignment is idempotent. Example body: {\"vault\":\"Production\"}.",
5582
+ "http": "PUT",
5583
+ "path": "/automation/v1/scripts/{ns}/{name}/vaults/{alias}",
5584
+ "streaming": "no",
5585
+ "pagination": false,
5586
+ "pathParams": [
5587
+ {
5588
+ "name": "ns",
5589
+ "sdkName": "ns",
5590
+ "description": "Namespace from automation.scripts.list or create; identifies the saved script, independently of versions."
5591
+ },
5592
+ {
5593
+ "name": "name",
5594
+ "sdkName": "name",
5595
+ "description": "Resource name from automation.scripts.list or create; combine with ns to identify the saved script."
5596
+ },
5597
+ {
5598
+ "name": "alias",
5599
+ "sdkName": "alias",
5600
+ "description": "Binding alias chosen by the caller: 1–40 lowercase letters, digits or hyphens, beginning with a letter."
5601
+ }
5602
+ ],
5603
+ "query": [],
5604
+ "body": {
5605
+ "required": true,
5606
+ "fields": [
5607
+ {
5608
+ "name": "vault",
5609
+ "type": "string",
5610
+ "required": true,
5611
+ "description": "Active vault ID or exact display name from praxis.vault.vaults.list in your organization. Use an ID if display names are duplicated."
5612
+ }
5613
+ ]
5614
+ }
5615
+ },
5503
5616
  {
5504
5617
  "resource": "automation.scripts.versions",
5505
5618
  "method": "list",
@@ -6300,7 +6413,7 @@ export const operations = [
6300
6413
  "resource": "automation.workflows",
6301
6414
  "method": "create",
6302
6415
  "summary": "Create a workflow",
6303
- "description": "Workflow syntax reference: https://deepraxis.com/docs/developers/automation/reference/workflow-syntax. Save a YAML workflow as an editable draft; this does not validate, publish or run it, so check it with validate (kind=workflow) first. Minimal draft: document with dsl (\"1.0.3\"), namespace, name and version, plus a do list of steps, for example document: {dsl: \"1.0.3\", namespace: demo, name: add, version: \"1.0.0\"} and do: [{first: {call: demo/add-one, with: {n: \"${ .n }\"}}}]. call: <ns/name> calls an Action directly (bare name for built-ins such as ocr) and with is the Action input; the input contract is at current_revision.input_schema in the get-action response. run: starts a saved script or child workflow. The run input is . in the first step, and expressions are jq written as a whole ${ ... } string. Limits: Action 30 s (run-sandbox 10 min), workflow 24 h by default and 30 days at most, payload 1 MiB. Test the draft by sending its source and language=yaml to praxis.automation.runs.create. Guide: /docs/developers/automation/guides/write-workflow. Error details are in the errors[] of the response (pointer, detail, hint). Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. run.workflow accepts ns/name@range or {namespace, name, version, input}; run.script uses the same reference shape as a platform extension. Object namespace, name and version are required; version accepts an exact version, dist-tag or range, locked at publication. Object input defaults to {} and supports expressions; string references retain task-level with. run.await defaults to true and returns the child output. With false, the child uses detach and the task immediately returns {run_id}; parent cancellation does not cascade. Inline script.code returns DEFINITION_INVALID with a detail asking you to save a script and reference it first. raise.error retains its type URI, status, title and detail in the run error.",
6416
+ "description": "Workflow syntax reference: https://deepraxis.com/docs/developers/automation/reference/workflow-syntax. Save a YAML workflow as an editable draft; this does not validate, publish or run it, so check it with validate (kind=workflow) first. Minimal draft: document with dsl (\"1.0.3\"), namespace, name and version, plus a do list of steps, for example document: {dsl: \"1.0.3\", namespace: demo, name: add, version: \"1.0.0\"} and do: [{first: {call: demo/add-one, with: {n: \"${ .n }\"}}}]. call: <ns/name> calls an Action directly (bare name for built-ins such as ocr) and with is the Action input; the input contract is at current_revision.input_schema in the get-action response. run: starts a saved script or child workflow. The run input is . in the first step, and expressions are jq written as a whole ${ ... } string. Limits: Action 5 min (run-sandbox 6 h), 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.",
6304
6417
  "http": "POST",
6305
6418
  "path": "/automation/v1/workflows",
6306
6419
  "streaming": "no",
@@ -6556,6 +6669,96 @@ export const operations = [
6556
6669
  "fields": []
6557
6670
  }
6558
6671
  },
6672
+ {
6673
+ "resource": "automation.workflows.vaults",
6674
+ "method": "list",
6675
+ "summary": "List workflow vault bindings",
6676
+ "description": "Inspect the whole vaults attached to a saved workflow, including archived definitions, without reading secret values. Obtain ns and name from automation.workflows.list. Bindings belong to the definition rather than a published version. When vault or secret metadata cannot be read, the binding remains visible with secrets: [] and secrets_unavailable: true.",
6677
+ "http": "GET",
6678
+ "path": "/automation/v1/workflows/{ns}/{name}/vaults",
6679
+ "streaming": "no",
6680
+ "pagination": false,
6681
+ "pathParams": [
6682
+ {
6683
+ "name": "ns",
6684
+ "sdkName": "ns",
6685
+ "description": "Namespace from automation.workflows.list or create; identifies the saved workflow, independently of versions."
6686
+ },
6687
+ {
6688
+ "name": "name",
6689
+ "sdkName": "name",
6690
+ "description": "Resource name from automation.workflows.list or create; combine with ns to identify the saved workflow."
6691
+ }
6692
+ ],
6693
+ "query": []
6694
+ },
6695
+ {
6696
+ "resource": "automation.workflows.vaults",
6697
+ "method": "delete",
6698
+ "summary": "Delete a workflow vault binding",
6699
+ "description": "Remove the vault assignment from this saved workflow without deleting the vault or its secrets. Obtain aliases from automation.workflows.vaults.list. Repeating deletion of an absent alias on an existing definition succeeds. Bindings also disappear when the definition is permanently deleted, while archival retains them.",
6700
+ "http": "DELETE",
6701
+ "path": "/automation/v1/workflows/{ns}/{name}/vaults/{alias}",
6702
+ "streaming": "no",
6703
+ "pagination": false,
6704
+ "pathParams": [
6705
+ {
6706
+ "name": "ns",
6707
+ "sdkName": "ns",
6708
+ "description": "Namespace from automation.workflows.list or create; identifies the saved workflow, independently of versions."
6709
+ },
6710
+ {
6711
+ "name": "name",
6712
+ "sdkName": "name",
6713
+ "description": "Resource name from automation.workflows.list or create; combine with ns to identify the saved workflow."
6714
+ },
6715
+ {
6716
+ "name": "alias",
6717
+ "sdkName": "alias",
6718
+ "description": "Binding alias chosen by the caller: 1–40 lowercase letters, digits or hyphens, beginning with a letter."
6719
+ }
6720
+ ],
6721
+ "query": []
6722
+ },
6723
+ {
6724
+ "resource": "automation.workflows.vaults",
6725
+ "method": "set",
6726
+ "summary": "Set a workflow vault binding",
6727
+ "description": "Attach an entire active vault in your organization to a saved workflow, or replace the vault at an existing alias. Obtain the vault ID or display name from praxis.vault.vaults.list; ambiguous names require an ID. Bindings are independent of published versions and survive archival. The same vault cannot be assigned to two aliases on one definition. Repeating the same assignment is idempotent. Example body: {\"vault\":\"Production\"}.",
6728
+ "http": "PUT",
6729
+ "path": "/automation/v1/workflows/{ns}/{name}/vaults/{alias}",
6730
+ "streaming": "no",
6731
+ "pagination": false,
6732
+ "pathParams": [
6733
+ {
6734
+ "name": "ns",
6735
+ "sdkName": "ns",
6736
+ "description": "Namespace from automation.workflows.list or create; identifies the saved workflow, independently of versions."
6737
+ },
6738
+ {
6739
+ "name": "name",
6740
+ "sdkName": "name",
6741
+ "description": "Resource name from automation.workflows.list or create; combine with ns to identify the saved workflow."
6742
+ },
6743
+ {
6744
+ "name": "alias",
6745
+ "sdkName": "alias",
6746
+ "description": "Binding alias chosen by the caller: 1–40 lowercase letters, digits or hyphens, beginning with a letter."
6747
+ }
6748
+ ],
6749
+ "query": [],
6750
+ "body": {
6751
+ "required": true,
6752
+ "fields": [
6753
+ {
6754
+ "name": "vault",
6755
+ "type": "string",
6756
+ "required": true,
6757
+ "description": "Active vault ID or exact display name from praxis.vault.vaults.list in your organization. Use an ID if display names are duplicated."
6758
+ }
6759
+ ]
6760
+ }
6761
+ },
6559
6762
  {
6560
6763
  "resource": "automation.workflows.versions",
6561
6764
  "method": "list",
@@ -7284,125 +7487,109 @@ export const operations = [
7284
7487
  }
7285
7488
  },
7286
7489
  {
7287
- "resource": "database.databases",
7490
+ "resource": "canvas.canvases",
7288
7491
  "method": "list",
7289
- "summary": "List databases",
7290
- "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.",
7492
+ "summary": "List canvases",
7493
+ "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.",
7291
7494
  "http": "GET",
7292
- "path": "/database/v1/databases",
7495
+ "path": "/canvas/v1/canvases",
7293
7496
  "streaming": "no",
7294
7497
  "pagination": true,
7295
7498
  "pathParams": [],
7296
7499
  "query": [
7297
- {
7298
- "name": "cursor",
7299
- "type": "string",
7300
- "required": false,
7301
- "description": "Opaque next_cursor from the previous page."
7302
- },
7303
7500
  {
7304
7501
  "name": "limit",
7305
7502
  "type": "integer",
7306
7503
  "required": false,
7307
- "description": "Page size."
7504
+ "description": "Maximum canvases to return per page, from 1 to 100; defaults to 50 when omitted."
7308
7505
  },
7309
7506
  {
7310
- "name": "labels",
7311
- "type": "object",
7507
+ "name": "cursor",
7508
+ "type": "string",
7312
7509
  "required": false,
7313
- "description": "Exact label match, encoded as labels[purpose]=docs."
7510
+ "description": "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null."
7314
7511
  },
7315
7512
  {
7316
- "name": "status",
7513
+ "name": "collection_id",
7317
7514
  "type": "string",
7318
- "enum": [
7319
- "active",
7320
- "deleting"
7321
- ],
7322
7515
  "required": false,
7323
- "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."
7516
+ "description": "Filter to a collection id from collections.list, or the literal none for uncategorized canvases. Omit to list all canvases; keep the same filter when following next_cursor."
7324
7517
  }
7325
7518
  ]
7326
7519
  },
7327
7520
  {
7328
- "resource": "database.databases",
7521
+ "resource": "canvas.canvases",
7329
7522
  "method": "create",
7330
- "summary": "Create database",
7331
- "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.",
7523
+ "summary": "Create canvas",
7524
+ "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.",
7332
7525
  "http": "POST",
7333
- "path": "/database/v1/databases",
7526
+ "path": "/canvas/v1/canvases",
7334
7527
  "streaming": "no",
7335
7528
  "pagination": false,
7336
7529
  "pathParams": [],
7337
7530
  "query": [],
7338
7531
  "body": {
7339
- "required": true,
7532
+ "required": false,
7340
7533
  "fields": [
7341
7534
  {
7342
7535
  "name": "name",
7343
7536
  "type": "string",
7344
- "required": true,
7345
- "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."
7346
- },
7347
- {
7348
- "name": "labels",
7349
- "type": "object",
7350
7537
  "required": false,
7351
- "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."
7538
+ "description": "Display name for the new canvas, at most 200 characters; omission uses Untitled."
7352
7539
  }
7353
7540
  ]
7354
7541
  }
7355
7542
  },
7356
7543
  {
7357
- "resource": "database.databases",
7544
+ "resource": "canvas.canvases",
7358
7545
  "method": "delete",
7359
- "summary": "Delete database",
7360
- "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.",
7546
+ "summary": "Delete canvas",
7547
+ "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.",
7361
7548
  "http": "DELETE",
7362
- "path": "/database/v1/databases/{database_id}",
7549
+ "path": "/canvas/v1/canvases/{canvas_id}",
7363
7550
  "streaming": "no",
7364
7551
  "pagination": false,
7365
7552
  "pathParams": [
7366
7553
  {
7367
- "name": "database_id",
7368
- "sdkName": "database_id",
7369
- "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7554
+ "name": "canvas_id",
7555
+ "sdkName": "canvas_id",
7556
+ "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."
7370
7557
  }
7371
7558
  ],
7372
7559
  "query": []
7373
7560
  },
7374
7561
  {
7375
- "resource": "database.databases",
7562
+ "resource": "canvas.canvases",
7376
7563
  "method": "retrieve",
7377
- "summary": "Get database",
7378
- "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.",
7564
+ "summary": "Retrieve canvas",
7565
+ "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.",
7379
7566
  "http": "GET",
7380
- "path": "/database/v1/databases/{database_id}",
7567
+ "path": "/canvas/v1/canvases/{canvas_id}",
7381
7568
  "streaming": "no",
7382
7569
  "pagination": false,
7383
7570
  "pathParams": [
7384
7571
  {
7385
- "name": "database_id",
7386
- "sdkName": "database_id",
7387
- "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7572
+ "name": "canvas_id",
7573
+ "sdkName": "canvas_id",
7574
+ "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."
7388
7575
  }
7389
7576
  ],
7390
7577
  "query": []
7391
7578
  },
7392
7579
  {
7393
- "resource": "database.databases",
7580
+ "resource": "canvas.canvases",
7394
7581
  "method": "update",
7395
- "summary": "Update database",
7396
- "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.",
7582
+ "summary": "Update canvas",
7583
+ "description": "Rename a canvas or move it to a collection without editing its design content. Use a canvas id from canvases.list and a collection id from collections.list. Send collection_id=null to make it uncategorized; omit either field to preserve its current value. A canvas belongs to at most one collection. The destination must belong to your organization. Renaming keeps the canvas version unchanged.",
7397
7584
  "http": "PATCH",
7398
- "path": "/database/v1/databases/{database_id}",
7585
+ "path": "/canvas/v1/canvases/{canvas_id}",
7399
7586
  "streaming": "no",
7400
7587
  "pagination": false,
7401
7588
  "pathParams": [
7402
7589
  {
7403
- "name": "database_id",
7404
- "sdkName": "database_id",
7405
- "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7590
+ "name": "canvas_id",
7591
+ "sdkName": "canvas_id",
7592
+ "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."
7406
7593
  }
7407
7594
  ],
7408
7595
  "query": [],
@@ -7413,86 +7600,2934 @@ export const operations = [
7413
7600
  "name": "name",
7414
7601
  "type": "string",
7415
7602
  "required": false,
7416
- "description": "New display name, 1–64 visible characters after trimming. Omit it to keep the current name."
7603
+ "description": "New canvas display name; surrounding whitespace is trimmed, blank names use Untitled, and omission preserves the current name."
7417
7604
  },
7418
7605
  {
7419
- "name": "labels",
7420
- "type": "object",
7606
+ "name": "collection_id",
7607
+ "type": "string",
7421
7608
  "required": false,
7422
- "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."
7609
+ "description": "Move to this collection id from collections.list; null removes the canvas from its collection. Omission preserves the current assignment."
7423
7610
  }
7424
7611
  ]
7425
7612
  }
7426
7613
  },
7427
7614
  {
7428
- "resource": "database.databases.events",
7615
+ "resource": "canvas.canvases.images",
7429
7616
  "method": "list",
7430
- "summary": "List events",
7431
- "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.",
7617
+ "summary": "Render canvas nodes",
7618
+ "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.",
7432
7619
  "http": "GET",
7433
- "path": "/database/v1/databases/{database_id}/events",
7620
+ "path": "/canvas/v1/canvases/{canvas_id}/images",
7434
7621
  "streaming": "no",
7435
7622
  "pagination": false,
7436
7623
  "pathParams": [
7437
7624
  {
7438
- "name": "database_id",
7439
- "sdkName": "database_id",
7440
- "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7625
+ "name": "canvas_id",
7626
+ "sdkName": "canvas_id",
7627
+ "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."
7441
7628
  }
7442
7629
  ],
7443
7630
  "query": [
7444
7631
  {
7445
- "name": "after_seq",
7446
- "type": "integer",
7632
+ "name": "version",
7633
+ "type": "string",
7447
7634
  "required": false,
7448
- "description": "With order=asc, return only events with seq greater than this value. Cannot be combined with before_seq."
7635
+ "description": "Decimal version from versions.list, or its earliest_restorable_version, for a read-only historical snapshot; omit to read current state. Unavailable versions return VERSION_NOT_FOUND."
7449
7636
  },
7450
7637
  {
7451
- "name": "limit",
7452
- "type": "integer",
7638
+ "name": "ids",
7639
+ "type": "string",
7640
+ "required": true,
7641
+ "description": "Comma-separated list of 1–4 node ids to render, from retrieve, execute.created or execute.screenshots."
7642
+ },
7643
+ {
7644
+ "name": "scale",
7645
+ "type": "number",
7453
7646
  "required": false,
7454
- "description": "Page size."
7647
+ "description": "Output pixel scale relative to canvas dimensions, from 0.25 to 4 inclusive; defaults to 1 when omitted."
7455
7648
  },
7456
7649
  {
7457
- "name": "order",
7650
+ "name": "format",
7458
7651
  "type": "string",
7459
7652
  "enum": [
7460
- "asc",
7461
- "desc"
7653
+ "png"
7462
7654
  ],
7463
7655
  "required": false,
7464
- "description": "Sequence order: asc or desc (newest first). Defaults to asc, or to desc when before_seq is supplied."
7465
- },
7466
- {
7467
- "name": "before_seq",
7468
- "type": "integer",
7469
- "required": false,
7470
- "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."
7656
+ "description": "Image encoding; png produces a PNG data URL and is the only supported value. Omit to use png."
7471
7657
  }
7472
7658
  ]
7473
7659
  },
7474
7660
  {
7475
- "resource": "database.databases.purge",
7476
- "method": "create",
7477
- "summary": "Permanently purge database",
7478
- "description": "Immediately and irreversibly purges a deleting database. Active databases return 409; absent or already purged databases return 404.",
7479
- "http": "POST",
7480
- "path": "/database/v1/databases/{database_id}/purge",
7661
+ "resource": "canvas.canvases.nodes",
7662
+ "method": "list",
7663
+ "summary": "Read canvas nodes",
7664
+ "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.",
7665
+ "http": "GET",
7666
+ "path": "/canvas/v1/canvases/{canvas_id}/nodes",
7481
7667
  "streaming": "no",
7482
7668
  "pagination": false,
7483
7669
  "pathParams": [
7484
7670
  {
7485
- "name": "database_id",
7486
- "sdkName": "database_id",
7487
- "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
7671
+ "name": "canvas_id",
7672
+ "sdkName": "canvas_id",
7673
+ "description": "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted."
7488
7674
  }
7489
7675
  ],
7490
- "query": []
7491
- },
7492
- {
7493
- "resource": "database.databases.rest",
7494
- "method": "delete",
7495
- "summary": "Delete rows",
7676
+ "query": [
7677
+ {
7678
+ "name": "version",
7679
+ "type": "string",
7680
+ "required": false,
7681
+ "description": "Decimal version from versions.list, or its earliest_restorable_version, for a read-only historical snapshot; omit to read current state. Unavailable versions return VERSION_NOT_FOUND."
7682
+ },
7683
+ {
7684
+ "name": "ids",
7685
+ "type": "string",
7686
+ "required": true,
7687
+ "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."
7688
+ },
7689
+ {
7690
+ "name": "depth",
7691
+ "type": "integer",
7692
+ "required": false,
7693
+ "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."
7694
+ }
7695
+ ]
7696
+ },
7697
+ {
7698
+ "resource": "canvas.canvases.versions",
7699
+ "method": "list",
7700
+ "summary": "List canvas versions",
7701
+ "description": "Inspect retained edits before restoring a canvas or reading historical nodes and images. Supply a canvas_id from canvases.list or create. Results include successful execute, import and restore commits since history was enabled, newest first. limit is 1–100 and defaults to 30; pass next_cursor as cursor until it is null. All versions from the last 30 days are retained unless the 256 MiB history budget requires pruning; the newest 100 versions are always retained regardless of age or size. earliest_restorable_version is the oldest readable and restorable version, including the state immediately before the first retained commit; null means no history has been recorded. Listing does not change the canvas.",
7702
+ "http": "GET",
7703
+ "path": "/canvas/v1/canvases/{canvas_id}/versions",
7704
+ "streaming": "no",
7705
+ "pagination": false,
7706
+ "pathParams": [
7707
+ {
7708
+ "name": "canvas_id",
7709
+ "sdkName": "canvas_id",
7710
+ "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."
7711
+ }
7712
+ ],
7713
+ "query": [
7714
+ {
7715
+ "name": "limit",
7716
+ "type": "integer",
7717
+ "required": false,
7718
+ "description": "Maximum commits to return, from 1 to 100 inclusive; omission uses 30."
7719
+ },
7720
+ {
7721
+ "name": "cursor",
7722
+ "type": "string",
7723
+ "required": false,
7724
+ "description": "Copy next_cursor from the preceding page to continue toward older commits; omit for the first page."
7725
+ }
7726
+ ]
7727
+ },
7728
+ {
7729
+ "resource": "canvas.canvases",
7730
+ "method": "execute",
7731
+ "summary": "Execute canvas script",
7732
+ "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\nInsert/Copy return the new node id; read the copy with Get(id) — copied descendants get new ids, so change them through Copy's third argument `descendants` keyed by the source node ids. To copy a page and change its title in the same script:\n\n```js canvas-example=\"copy-page\"\nconst page = Insert(document, {type:\"frame\",name:\"Original\",width:320,height:160,layout:\"vertical\",padding:16});\nconst title = Insert(page, {type:\"text\",name:\"Title\",content:\"Original\",fontSize:24});\nconst copy = Copy(page, document, {name:\"Copy\",x:360,descendants:{[title]:{content:\"Updated\"}}});\nPrint(copy); Print(Get(copy).children[0].content);\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\nExecution errors include error.details.prints containing output printed before failure, with the same string-array shape and output limit as successful prints; rolled-back writes still create no version.\n",
7733
+ "http": "POST",
7734
+ "path": "/canvas/v1/canvases/{canvas_id}:execute",
7735
+ "streaming": "no",
7736
+ "pagination": false,
7737
+ "pathParams": [
7738
+ {
7739
+ "name": "canvas_id",
7740
+ "sdkName": "canvas_id",
7741
+ "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."
7742
+ }
7743
+ ],
7744
+ "query": [],
7745
+ "body": {
7746
+ "required": true,
7747
+ "fields": [
7748
+ {
7749
+ "name": "script",
7750
+ "type": "string",
7751
+ "required": false,
7752
+ "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."
7753
+ },
7754
+ {
7755
+ "name": "edit_id",
7756
+ "type": "string",
7757
+ "required": false,
7758
+ "description": "Saved failed-script identifier from error.details.edit_id; use with edits instead of script within ten minutes of the failure."
7759
+ },
7760
+ {
7761
+ "name": "edits",
7762
+ "type": "array",
7763
+ "itemType": "object",
7764
+ "required": false,
7765
+ "description": "Text replacements applied to the source identified by edit_id before rerunning; use error line, column or rejection to choose the correction."
7766
+ },
7767
+ {
7768
+ "name": "expected_version",
7769
+ "type": "string",
7770
+ "required": false,
7771
+ "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."
7772
+ }
7773
+ ]
7774
+ }
7775
+ },
7776
+ {
7777
+ "resource": "canvas.canvases",
7778
+ "method": "restore",
7779
+ "summary": "Restore canvas version",
7780
+ "description": "Recover a canvas after an unwanted edit by restoring a retained version from versions.list or its earliest_restorable_version. This replaces current nodes, variables and themes with the target state and creates one new version; history remains available, so restoring can itself be undone with another restore. Restoring the current version succeeds without creating a version. Optionally guard the write with expected_version from retrieve or nodes.list; if it is stale, inspect current state and retry with the new value. Repeating an unguarded request after another edit can create another restore version. Versions from before history was enabled or outside retention cannot be recovered. Connected viewers resync after a successful restore.",
7781
+ "http": "POST",
7782
+ "path": "/canvas/v1/canvases/{canvas_id}:restore",
7783
+ "streaming": "no",
7784
+ "pagination": false,
7785
+ "pathParams": [
7786
+ {
7787
+ "name": "canvas_id",
7788
+ "sdkName": "canvas_id",
7789
+ "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."
7790
+ }
7791
+ ],
7792
+ "query": [],
7793
+ "body": {
7794
+ "required": true,
7795
+ "fields": [
7796
+ {
7797
+ "name": "version",
7798
+ "type": "string",
7799
+ "required": true,
7800
+ "description": "Historical target from versions.list or earliest_restorable_version; restoring the current version creates no new commit."
7801
+ },
7802
+ {
7803
+ "name": "expected_version",
7804
+ "type": "string",
7805
+ "required": false,
7806
+ "description": "Current version from retrieve or nodes.list to guard against concurrent edits; omission applies the restore to whichever version is current."
7807
+ }
7808
+ ]
7809
+ }
7810
+ },
7811
+ {
7812
+ "resource": "canvas.collections",
7813
+ "method": "list",
7814
+ "summary": "List collections",
7815
+ "description": "Find collections and ids for filtering or moving canvases. All organization collections are returned in name order in one response; next_cursor is always null. canvas_count excludes deleted canvases. total_count counts all live canvases, rather than collections, and uncategorized_count counts live canvases without a collection. Use canvases.list with collection_id to read a collection or none to read uncategorized canvases.",
7816
+ "http": "GET",
7817
+ "path": "/canvas/v1/collections",
7818
+ "streaming": "no",
7819
+ "pagination": false,
7820
+ "pathParams": [],
7821
+ "query": []
7822
+ },
7823
+ {
7824
+ "resource": "canvas.collections",
7825
+ "method": "create",
7826
+ "summary": "Create collection",
7827
+ "description": "Organize canvases by creating a one-level collection in your organization. Send a name of 1–100 characters after trimming; duplicate names are allowed. Each call creates a new collection, initially containing no canvases. Use canvases.update with its id as collection_id to move existing canvases into it. Collections cannot be nested and an organization can have at most 200.",
7828
+ "http": "POST",
7829
+ "path": "/canvas/v1/collections",
7830
+ "streaming": "no",
7831
+ "pagination": false,
7832
+ "pathParams": [],
7833
+ "query": [],
7834
+ "body": {
7835
+ "required": true,
7836
+ "fields": [
7837
+ {
7838
+ "name": "name",
7839
+ "type": "string",
7840
+ "required": true,
7841
+ "description": "Collection display name, 1–100 characters after trimming surrounding whitespace; duplicate names within the organization are allowed."
7842
+ }
7843
+ ]
7844
+ }
7845
+ },
7846
+ {
7847
+ "resource": "canvas.collections",
7848
+ "method": "delete",
7849
+ "summary": "Delete collection",
7850
+ "description": "Remove a collection using an id from collections.list. All its canvases are preserved and become uncategorized, with collection_id set to null; read them using canvases.list with collection_id=none. The removed collection cannot be retrieved again, and repeating deletion returns COLLECTION_NOT_FOUND.",
7851
+ "http": "DELETE",
7852
+ "path": "/canvas/v1/collections/{collection_id}",
7853
+ "streaming": "no",
7854
+ "pagination": false,
7855
+ "pathParams": [
7856
+ {
7857
+ "name": "collection_id",
7858
+ "sdkName": "collection_id",
7859
+ "description": "Collection id from collections.create or collections.list, in the form col_ followed by 16 lowercase letters or digits; a display name is not an identifier."
7860
+ }
7861
+ ],
7862
+ "query": []
7863
+ },
7864
+ {
7865
+ "resource": "canvas.collections",
7866
+ "method": "retrieve",
7867
+ "summary": "Retrieve collection",
7868
+ "description": "Inspect one collection and its current live canvas count using an id from collections.list or collections.create. The collection must belong to the API key organization. To read its canvases, pass the same id as collection_id to canvases.list; this response contains collection metadata only.",
7869
+ "http": "GET",
7870
+ "path": "/canvas/v1/collections/{collection_id}",
7871
+ "streaming": "no",
7872
+ "pagination": false,
7873
+ "pathParams": [
7874
+ {
7875
+ "name": "collection_id",
7876
+ "sdkName": "collection_id",
7877
+ "description": "Collection id from collections.create or collections.list, in the form col_ followed by 16 lowercase letters or digits; a display name is not an identifier."
7878
+ }
7879
+ ],
7880
+ "query": []
7881
+ },
7882
+ {
7883
+ "resource": "canvas.collections",
7884
+ "method": "update",
7885
+ "summary": "Rename collection",
7886
+ "description": "Change the display name of a collection from collections.list without changing its id or canvas assignments. Names contain 1–100 characters after trimming and may match another collection name. This operation does not move canvases; use canvases.update with collection_id for that.",
7887
+ "http": "PATCH",
7888
+ "path": "/canvas/v1/collections/{collection_id}",
7889
+ "streaming": "no",
7890
+ "pagination": false,
7891
+ "pathParams": [
7892
+ {
7893
+ "name": "collection_id",
7894
+ "sdkName": "collection_id",
7895
+ "description": "Collection id from collections.create or collections.list, in the form col_ followed by 16 lowercase letters or digits; a display name is not an identifier."
7896
+ }
7897
+ ],
7898
+ "query": [],
7899
+ "body": {
7900
+ "required": true,
7901
+ "fields": [
7902
+ {
7903
+ "name": "name",
7904
+ "type": "string",
7905
+ "required": true,
7906
+ "description": "Collection display name, 1–100 characters after trimming surrounding whitespace; duplicate names within the organization are allowed."
7907
+ }
7908
+ ]
7909
+ }
7910
+ },
7911
+ {
7912
+ "resource": "crm.changes",
7913
+ "method": "revert",
7914
+ "summary": "Revert change set",
7915
+ "description": "Reverse property changes made by one earlier request. Unlike HubSpot, CRM exposes change-set reversal because agents need to undo a whole recorded action rather than manually reconstructing individual values. Supply the changeSetId recorded in property history. A later conflicting value prevents reversal with HTTP 409 CONFLICT; inspect current records before resolving the conflict. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
7916
+ "http": "POST",
7917
+ "path": "/crm/v1/changes/{changeSetId}:revert",
7918
+ "streaming": "no",
7919
+ "pagination": false,
7920
+ "pathParams": [
7921
+ {
7922
+ "name": "changeSetId",
7923
+ "sdkName": "changeSetId",
7924
+ "description": "Change-set identifier recorded for the original write in property history; one request forms one change set."
7925
+ }
7926
+ ],
7927
+ "query": []
7928
+ },
7929
+ {
7930
+ "resource": "crm.layouts",
7931
+ "method": "retrieve",
7932
+ "summary": "Retrieve record layout",
7933
+ "description": "Read the shared record-page layout for an object type from schemas.list. Unlike HubSpot, CRM exposes this presentation as an API resource so people and agents can share the same record layout instead of relying on interface-only settings. The response orders summary tiles, sidebar properties and main-column sections.",
7934
+ "http": "GET",
7935
+ "path": "/crm/v1/layouts/{objectType}",
7936
+ "streaming": "no",
7937
+ "pagination": false,
7938
+ "pathParams": [
7939
+ {
7940
+ "name": "objectType",
7941
+ "sdkName": "objectType",
7942
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
7943
+ }
7944
+ ],
7945
+ "query": []
7946
+ },
7947
+ {
7948
+ "resource": "crm.layouts",
7949
+ "method": "update",
7950
+ "summary": "Update record layout",
7951
+ "description": "Replace the shared record-page layout for an object type from schemas.list. Unlike HubSpot, CRM exposes this presentation as an API resource so agents can configure the same record view used by people. Send the complete layout with at most three summary tiles and property names from properties.list; omitted prior sections are removed. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
7952
+ "http": "PUT",
7953
+ "path": "/crm/v1/layouts/{objectType}",
7954
+ "streaming": "no",
7955
+ "pagination": false,
7956
+ "pathParams": [
7957
+ {
7958
+ "name": "objectType",
7959
+ "sdkName": "objectType",
7960
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
7961
+ }
7962
+ ],
7963
+ "query": [],
7964
+ "body": {
7965
+ "required": true,
7966
+ "fields": [
7967
+ {
7968
+ "name": "objectType",
7969
+ "type": "string",
7970
+ "required": true,
7971
+ "description": "Object type whose record page uses this layout, matching the path parameter."
7972
+ },
7973
+ {
7974
+ "name": "summary",
7975
+ "type": "array",
7976
+ "itemType": "object",
7977
+ "required": true,
7978
+ "description": "Ordered statistic tiles below the record header, with at most three tiles."
7979
+ },
7980
+ {
7981
+ "name": "sidebar",
7982
+ "type": "array",
7983
+ "itemType": "string",
7984
+ "required": true,
7985
+ "description": "Ordered internal property names shown in the record property sidebar."
7986
+ },
7987
+ {
7988
+ "name": "sections",
7989
+ "type": "array",
7990
+ "itemType": "string",
7991
+ "required": true,
7992
+ "description": "Ordered main-column sections for activity, relationships, tables and property groups."
7993
+ }
7994
+ ]
7995
+ }
7996
+ },
7997
+ {
7998
+ "resource": "crm.leads",
7999
+ "method": "qualify",
8000
+ "summary": "Qualify lead",
8001
+ "description": "Qualify a lead with explicit contact, company and optional deal choices in one operation. Unlike HubSpot, CRM exposes these decisions as a single action because qualification coordinates several related record edits rather than editing only the lead stage. Obtain leadId from objects.list for leads and qualifiedStageId from its pipeline; choose a won stage and satisfy its required properties. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
8002
+ "http": "POST",
8003
+ "path": "/crm/v1/leads/{leadId}:qualify",
8004
+ "streaming": "no",
8005
+ "pagination": false,
8006
+ "pathParams": [
8007
+ {
8008
+ "name": "leadId",
8009
+ "sdkName": "leadId",
8010
+ "description": "Lead record identifier from objects.list or objects.search with objectType=leads."
8011
+ }
8012
+ ],
8013
+ "query": [],
8014
+ "body": {
8015
+ "required": true,
8016
+ "fields": [
8017
+ {
8018
+ "name": "contact",
8019
+ "type": "object",
8020
+ "required": true,
8021
+ "description": "Keep the existing contact, or merge it into the chosen contact record."
8022
+ },
8023
+ {
8024
+ "name": "company",
8025
+ "type": "object",
8026
+ "required": true,
8027
+ "description": "Leave company unchanged, associate an existing company, or create one with explicit properties."
8028
+ },
8029
+ {
8030
+ "name": "deal",
8031
+ "type": "object",
8032
+ "required": false,
8033
+ "description": "Optional deal to create as part of qualification; omit to qualify without creating a deal."
8034
+ },
8035
+ {
8036
+ "name": "qualifiedStageId",
8037
+ "type": "string",
8038
+ "required": true,
8039
+ "description": "Lead stage id with praxis_category=won, obtained from the leads pipeline."
8040
+ }
8041
+ ]
8042
+ }
8043
+ },
8044
+ {
8045
+ "resource": "crm.objects",
8046
+ "method": "list",
8047
+ "summary": "List records",
8048
+ "description": "Browse records of one object type and obtain ids for retrieval or edits. Discover objectType with schemas.list; select properties by internal names from properties.list. Omit after for the first page, then copy paging.next.after until no next page is returned. archived defaults to false; use objects.search for property filters.",
8049
+ "http": "GET",
8050
+ "path": "/crm/v1/objects/{objectType}",
8051
+ "streaming": "no",
8052
+ "pagination": false,
8053
+ "pathParams": [
8054
+ {
8055
+ "name": "objectType",
8056
+ "sdkName": "objectType",
8057
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8058
+ }
8059
+ ],
8060
+ "query": [
8061
+ {
8062
+ "name": "after",
8063
+ "type": "string",
8064
+ "required": false,
8065
+ "description": "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results."
8066
+ },
8067
+ {
8068
+ "name": "archived",
8069
+ "type": "boolean",
8070
+ "required": false,
8071
+ "description": "Whether to return only results that have been archived."
8072
+ },
8073
+ {
8074
+ "name": "associations",
8075
+ "type": "array",
8076
+ "itemType": "string",
8077
+ "required": false,
8078
+ "description": "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored."
8079
+ },
8080
+ {
8081
+ "name": "limit",
8082
+ "type": "integer",
8083
+ "required": false,
8084
+ "description": "The maximum number of results to display per page."
8085
+ },
8086
+ {
8087
+ "name": "properties",
8088
+ "type": "array",
8089
+ "itemType": "string",
8090
+ "required": false,
8091
+ "description": "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored."
8092
+ },
8093
+ {
8094
+ "name": "propertiesWithHistory",
8095
+ "type": "array",
8096
+ "itemType": "string",
8097
+ "required": false,
8098
+ "description": "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request."
8099
+ }
8100
+ ]
8101
+ },
8102
+ {
8103
+ "resource": "crm.objects",
8104
+ "method": "create",
8105
+ "summary": "Create record",
8106
+ "description": "Create a customer record with property values and optional initial associations. Discover objectType with schemas.list and allowed property names with properties.list; save the returned id for subsequent calls. Each call creates a record. Example for contacts: {\"properties\":{\"email\":\"person@example.com\"}}. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
8107
+ "http": "POST",
8108
+ "path": "/crm/v1/objects/{objectType}",
8109
+ "streaming": "no",
8110
+ "pagination": false,
8111
+ "pathParams": [
8112
+ {
8113
+ "name": "objectType",
8114
+ "sdkName": "objectType",
8115
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8116
+ }
8117
+ ],
8118
+ "query": [],
8119
+ "body": {
8120
+ "required": true,
8121
+ "fields": [
8122
+ {
8123
+ "name": "associations",
8124
+ "type": "array",
8125
+ "itemType": "object",
8126
+ "required": true,
8127
+ "description": "Initial relationships to existing records; choose destination ids and association type ids before creating the record."
8128
+ },
8129
+ {
8130
+ "name": "properties",
8131
+ "type": "object",
8132
+ "required": true,
8133
+ "description": "Key-value pairs for setting properties for the new object."
8134
+ }
8135
+ ]
8136
+ }
8137
+ },
8138
+ {
8139
+ "resource": "crm.objects.batch",
8140
+ "method": "archive",
8141
+ "summary": "Batch archive records",
8142
+ "description": "Archive known records of one object type using inputs[].id from objects.list or objects.search. Archived records leave active lists but retain their history; confirm all ids before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.",
8143
+ "http": "POST",
8144
+ "path": "/crm/v1/objects/{objectType}/batch/archive",
8145
+ "streaming": "no",
8146
+ "pagination": false,
8147
+ "pathParams": [
8148
+ {
8149
+ "name": "objectType",
8150
+ "sdkName": "objectType",
8151
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8152
+ }
8153
+ ],
8154
+ "query": [],
8155
+ "body": {
8156
+ "required": true,
8157
+ "fields": [
8158
+ {
8159
+ "name": "inputs",
8160
+ "type": "array",
8161
+ "itemType": "object",
8162
+ "required": true,
8163
+ "description": "Records to process in this batch, each using the identifiers and properties described by its item schema."
8164
+ }
8165
+ ]
8166
+ }
8167
+ },
8168
+ {
8169
+ "resource": "crm.objects.batch",
8170
+ "method": "create",
8171
+ "summary": "Batch create records",
8172
+ "description": "Create several records of one object type using inputs with properties and optional associations. Obtain property names from properties.list; each successful input creates a record, so inspect per-item errors before resubmitting failed inputs. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
8173
+ "http": "POST",
8174
+ "path": "/crm/v1/objects/{objectType}/batch/create",
8175
+ "streaming": "no",
8176
+ "pagination": false,
8177
+ "pathParams": [
8178
+ {
8179
+ "name": "objectType",
8180
+ "sdkName": "objectType",
8181
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8182
+ }
8183
+ ],
8184
+ "query": [],
8185
+ "body": {
8186
+ "required": true,
8187
+ "fields": [
8188
+ {
8189
+ "name": "inputs",
8190
+ "type": "array",
8191
+ "itemType": "object",
8192
+ "required": true,
8193
+ "description": "Records to process in this batch, each using the identifiers and properties described by its item schema."
8194
+ }
8195
+ ]
8196
+ }
8197
+ },
8198
+ {
8199
+ "resource": "crm.objects.batch",
8200
+ "method": "read",
8201
+ "summary": "Batch read records",
8202
+ "description": "Read a set of known record ids in one call; use objects.search to discover ids first. Supply inputs with ids plus requested properties; set idProperty only when the inputs use unique-property values rather than record ids.",
8203
+ "http": "POST",
8204
+ "path": "/crm/v1/objects/{objectType}/batch/read",
8205
+ "streaming": "no",
8206
+ "pagination": false,
8207
+ "pathParams": [
8208
+ {
8209
+ "name": "objectType",
8210
+ "sdkName": "objectType",
8211
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8212
+ }
8213
+ ],
8214
+ "query": [
8215
+ {
8216
+ "name": "archived",
8217
+ "type": "boolean",
8218
+ "required": false,
8219
+ "description": "Whether to return only results that have been archived."
8220
+ }
8221
+ ],
8222
+ "body": {
8223
+ "required": true,
8224
+ "fields": [
8225
+ {
8226
+ "name": "idProperty",
8227
+ "type": "string",
8228
+ "required": false,
8229
+ "description": "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID."
8230
+ },
8231
+ {
8232
+ "name": "inputs",
8233
+ "type": "array",
8234
+ "itemType": "object",
8235
+ "required": true,
8236
+ "description": "Records to process in this batch, each using the identifiers and properties described by its item schema."
8237
+ },
8238
+ {
8239
+ "name": "properties",
8240
+ "type": "array",
8241
+ "itemType": "string",
8242
+ "required": true,
8243
+ "description": "Internal property names to include in each returned record; obtain them from properties.list."
8244
+ },
8245
+ {
8246
+ "name": "propertiesWithHistory",
8247
+ "type": "array",
8248
+ "itemType": "string",
8249
+ "required": true,
8250
+ "description": "Internal property names whose previous values should be returned with each record; use an empty array when no history is needed."
8251
+ }
8252
+ ]
8253
+ }
8254
+ },
8255
+ {
8256
+ "resource": "crm.objects.batch",
8257
+ "method": "update",
8258
+ "summary": "Batch update records",
8259
+ "description": "Apply distinct property patches to existing records identified by inputs[].id. Obtain ids from objects.list or objects.search and property names from properties.list. Omitted properties retain their values; inspect results and errors for each input. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
8260
+ "http": "POST",
8261
+ "path": "/crm/v1/objects/{objectType}/batch/update",
8262
+ "streaming": "no",
8263
+ "pagination": false,
8264
+ "pathParams": [
8265
+ {
8266
+ "name": "objectType",
8267
+ "sdkName": "objectType",
8268
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8269
+ }
8270
+ ],
8271
+ "query": [],
8272
+ "body": {
8273
+ "required": true,
8274
+ "fields": [
8275
+ {
8276
+ "name": "inputs",
8277
+ "type": "array",
8278
+ "itemType": "object",
8279
+ "required": true,
8280
+ "description": "Records to process in this batch, each using the identifiers and properties described by its item schema."
8281
+ }
8282
+ ]
8283
+ }
8284
+ },
8285
+ {
8286
+ "resource": "crm.objects.batch",
8287
+ "method": "upsert",
8288
+ "summary": "Batch upsert records",
8289
+ "description": "Create records that do not yet exist or update matches using a unique property. Provide idProperty and its value in each input, plus properties; choose a property with hasUniqueValue from properties.list. Inspect each result to determine whether it was newly created. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
8290
+ "http": "POST",
8291
+ "path": "/crm/v1/objects/{objectType}/batch/upsert",
8292
+ "streaming": "no",
8293
+ "pagination": false,
8294
+ "pathParams": [
8295
+ {
8296
+ "name": "objectType",
8297
+ "sdkName": "objectType",
8298
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8299
+ }
8300
+ ],
8301
+ "query": [],
8302
+ "body": {
8303
+ "required": true,
8304
+ "fields": [
8305
+ {
8306
+ "name": "inputs",
8307
+ "type": "array",
8308
+ "itemType": "object",
8309
+ "required": true,
8310
+ "description": "Records to process in this batch, each using the identifiers and properties described by its item schema."
8311
+ }
8312
+ ]
8313
+ }
8314
+ },
8315
+ {
8316
+ "resource": "crm.objects",
8317
+ "method": "search",
8318
+ "summary": "Search records",
8319
+ "description": "Find records using text query, property filters and sort order rather than scanning a list. Obtain objectType from schemas.list and filter propertyName values from properties.list. Supply filterGroups, sorts, properties, limit and after; use empty arrays for no filters, sorts or property selection, and an empty after for the first page. Copy paging.next.after with the same query to continue. This operation reads records without changing them.",
8320
+ "http": "POST",
8321
+ "path": "/crm/v1/objects/{objectType}/search",
8322
+ "streaming": "no",
8323
+ "pagination": false,
8324
+ "pathParams": [
8325
+ {
8326
+ "name": "objectType",
8327
+ "sdkName": "objectType",
8328
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8329
+ }
8330
+ ],
8331
+ "query": [],
8332
+ "body": {
8333
+ "required": true,
8334
+ "fields": [
8335
+ {
8336
+ "name": "after",
8337
+ "type": "string",
8338
+ "required": true,
8339
+ "description": "A paging cursor token for retrieving subsequent pages."
8340
+ },
8341
+ {
8342
+ "name": "filterGroups",
8343
+ "type": "array",
8344
+ "itemType": "object",
8345
+ "required": true,
8346
+ "description": "Up to 6 groups of filters defining additional query criteria."
8347
+ },
8348
+ {
8349
+ "name": "limit",
8350
+ "type": "integer",
8351
+ "required": true,
8352
+ "description": "The maximum results to return, up to 200 objects."
8353
+ },
8354
+ {
8355
+ "name": "properties",
8356
+ "type": "array",
8357
+ "itemType": "string",
8358
+ "required": true,
8359
+ "description": "Internal property names to include in each returned record; obtain them from properties.list."
8360
+ },
8361
+ {
8362
+ "name": "query",
8363
+ "type": "string",
8364
+ "required": false,
8365
+ "description": "The search query string, up to 3000 characters."
8366
+ },
8367
+ {
8368
+ "name": "sorts",
8369
+ "type": "array",
8370
+ "itemType": "string",
8371
+ "required": true,
8372
+ "description": "Property names controlling ordering; prefix a property name with a minus sign for descending order."
8373
+ }
8374
+ ]
8375
+ }
8376
+ },
8377
+ {
8378
+ "resource": "crm.objects",
8379
+ "method": "archive",
8380
+ "summary": "Archive record",
8381
+ "description": "Archive a record selected from objects.list or objects.search when it should leave active results. This removes it from normal lists without deleting its history; archived=true can be used to read archived records. Confirm objectType and objectId before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.",
8382
+ "http": "DELETE",
8383
+ "path": "/crm/v1/objects/{objectType}/{objectId}",
8384
+ "streaming": "no",
8385
+ "pagination": false,
8386
+ "pathParams": [
8387
+ {
8388
+ "name": "objectType",
8389
+ "sdkName": "objectType",
8390
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8391
+ },
8392
+ {
8393
+ "name": "objectId",
8394
+ "sdkName": "objectId",
8395
+ "description": "Record id from objects.list, objects.search or objects.create for this objectType."
8396
+ }
8397
+ ],
8398
+ "query": []
8399
+ },
8400
+ {
8401
+ "resource": "crm.objects",
8402
+ "method": "retrieve",
8403
+ "summary": "Retrieve record",
8404
+ "description": "Read one record by id from objects.list, objects.search or objects.create. Select property names with properties and associated object types with associations; use idProperty only when objectId is a value of that unique property. Use archived=true to inspect an archived record.",
8405
+ "http": "GET",
8406
+ "path": "/crm/v1/objects/{objectType}/{objectId}",
8407
+ "streaming": "no",
8408
+ "pagination": false,
8409
+ "pathParams": [
8410
+ {
8411
+ "name": "objectType",
8412
+ "sdkName": "objectType",
8413
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8414
+ },
8415
+ {
8416
+ "name": "objectId",
8417
+ "sdkName": "objectId",
8418
+ "description": "Record id from objects.list, objects.search or objects.create for this objectType."
8419
+ }
8420
+ ],
8421
+ "query": [
8422
+ {
8423
+ "name": "archived",
8424
+ "type": "boolean",
8425
+ "required": false,
8426
+ "description": "Whether to return only results that have been archived."
8427
+ },
8428
+ {
8429
+ "name": "associations",
8430
+ "type": "array",
8431
+ "itemType": "string",
8432
+ "required": false,
8433
+ "description": "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored."
8434
+ },
8435
+ {
8436
+ "name": "idProperty",
8437
+ "type": "string",
8438
+ "required": false,
8439
+ "description": "The name of a property whose values are unique for this object"
8440
+ },
8441
+ {
8442
+ "name": "properties",
8443
+ "type": "array",
8444
+ "itemType": "string",
8445
+ "required": false,
8446
+ "description": "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored."
8447
+ },
8448
+ {
8449
+ "name": "propertiesWithHistory",
8450
+ "type": "array",
8451
+ "itemType": "string",
8452
+ "required": false,
8453
+ "description": "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored."
8454
+ }
8455
+ ]
8456
+ },
8457
+ {
8458
+ "resource": "crm.objects",
8459
+ "method": "update",
8460
+ "summary": "Update record",
8461
+ "description": "Change only the supplied properties of a record selected from objects.list or objects.search. Omitted properties retain their values. Use property names from properties.list and valid stage ids from pipelines.retrieve. Stage-entry requirements must be satisfied by the resulting record; inspect 400 errors before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
8462
+ "http": "PATCH",
8463
+ "path": "/crm/v1/objects/{objectType}/{objectId}",
8464
+ "streaming": "no",
8465
+ "pagination": false,
8466
+ "pathParams": [
8467
+ {
8468
+ "name": "objectType",
8469
+ "sdkName": "objectType",
8470
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8471
+ },
8472
+ {
8473
+ "name": "objectId",
8474
+ "sdkName": "objectId",
8475
+ "description": "Record id from objects.list, objects.search or objects.create for this objectType."
8476
+ }
8477
+ ],
8478
+ "query": [
8479
+ {
8480
+ "name": "idProperty",
8481
+ "type": "string",
8482
+ "required": false,
8483
+ "description": "The name of a property whose values are unique for this object"
8484
+ }
8485
+ ],
8486
+ "body": {
8487
+ "required": true,
8488
+ "fields": [
8489
+ {
8490
+ "name": "properties",
8491
+ "type": "object",
8492
+ "required": true,
8493
+ "description": "Key value pairs representing the properties of the object."
8494
+ }
8495
+ ]
8496
+ }
8497
+ },
8498
+ {
8499
+ "resource": "crm.associations",
8500
+ "method": "createDefault",
8501
+ "summary": "Create default association",
8502
+ "description": "Link two existing records with the default unlabelled association. Obtain each record id from objects.list or objects.search for its type. No request body is required; use associations.create to choose explicit association labels. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
8503
+ "http": "PUT",
8504
+ "path": "/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}",
8505
+ "streaming": "no",
8506
+ "pagination": false,
8507
+ "pathParams": [
8508
+ {
8509
+ "name": "objectType",
8510
+ "sdkName": "objectType",
8511
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8512
+ },
8513
+ {
8514
+ "name": "objectId",
8515
+ "sdkName": "objectId",
8516
+ "description": "Record id from objects.list, objects.search or objects.create for this objectType."
8517
+ },
8518
+ {
8519
+ "name": "toObjectType",
8520
+ "sdkName": "toObjectType",
8521
+ "description": "Destination object type from schemas.list; use the type of the record being linked."
8522
+ },
8523
+ {
8524
+ "name": "toObjectId",
8525
+ "sdkName": "toObjectId",
8526
+ "description": "Destination record identifier from objects.list or objects.search for toObjectType."
8527
+ }
8528
+ ],
8529
+ "query": []
8530
+ },
8531
+ {
8532
+ "resource": "crm.associations",
8533
+ "method": "list",
8534
+ "summary": "List record associations",
8535
+ "description": "Read records linked to a source record, including association labels and type ids. Obtain source and destination object types from schemas.list and objectId from objects.list or objects.search. Follow paging.next.after to continue reading associated records.",
8536
+ "http": "GET",
8537
+ "path": "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}",
8538
+ "streaming": "no",
8539
+ "pagination": false,
8540
+ "pathParams": [
8541
+ {
8542
+ "name": "objectType",
8543
+ "sdkName": "objectType",
8544
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8545
+ },
8546
+ {
8547
+ "name": "objectId",
8548
+ "sdkName": "objectId",
8549
+ "description": "Record id from objects.list, objects.search or objects.create for this objectType."
8550
+ },
8551
+ {
8552
+ "name": "toObjectType",
8553
+ "sdkName": "toObjectType",
8554
+ "description": "Destination object type from schemas.list; use the type of the record being linked."
8555
+ }
8556
+ ],
8557
+ "query": [
8558
+ {
8559
+ "name": "after",
8560
+ "type": "string",
8561
+ "required": false,
8562
+ "description": "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results."
8563
+ },
8564
+ {
8565
+ "name": "limit",
8566
+ "type": "integer",
8567
+ "required": false,
8568
+ "description": "The maximum number of results to display per page."
8569
+ }
8570
+ ]
8571
+ },
8572
+ {
8573
+ "resource": "crm.associations",
8574
+ "method": "remove",
8575
+ "summary": "Remove association",
8576
+ "description": "Remove the association between two existing records without archiving either record. Obtain the linked destination id from associations.list and confirm the source and destination object types before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.",
8577
+ "http": "DELETE",
8578
+ "path": "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}",
8579
+ "streaming": "no",
8580
+ "pagination": false,
8581
+ "pathParams": [
8582
+ {
8583
+ "name": "objectType",
8584
+ "sdkName": "objectType",
8585
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8586
+ },
8587
+ {
8588
+ "name": "objectId",
8589
+ "sdkName": "objectId",
8590
+ "description": "Record id from objects.list, objects.search or objects.create for this objectType."
8591
+ },
8592
+ {
8593
+ "name": "toObjectType",
8594
+ "sdkName": "toObjectType",
8595
+ "description": "Destination object type from schemas.list; use the type of the record being linked."
8596
+ },
8597
+ {
8598
+ "name": "toObjectId",
8599
+ "sdkName": "toObjectId",
8600
+ "description": "Destination record identifier from objects.list or objects.search for toObjectType."
8601
+ }
8602
+ ],
8603
+ "query": []
8604
+ },
8605
+ {
8606
+ "resource": "crm.associations",
8607
+ "method": "create",
8608
+ "summary": "Create labelled association",
8609
+ "description": "Associate two existing records using the requested association category and type id. Obtain record ids from objects.list or objects.search; reuse known association type ids from associations.list. Send the association-spec array as the body; use associations.createDefault when no label is needed. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
8610
+ "http": "PUT",
8611
+ "path": "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}",
8612
+ "streaming": "no",
8613
+ "pagination": false,
8614
+ "pathParams": [
8615
+ {
8616
+ "name": "objectType",
8617
+ "sdkName": "objectType",
8618
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8619
+ },
8620
+ {
8621
+ "name": "objectId",
8622
+ "sdkName": "objectId",
8623
+ "description": "Record id from objects.list, objects.search or objects.create for this objectType."
8624
+ },
8625
+ {
8626
+ "name": "toObjectType",
8627
+ "sdkName": "toObjectType",
8628
+ "description": "Destination object type from schemas.list; use the type of the record being linked."
8629
+ },
8630
+ {
8631
+ "name": "toObjectId",
8632
+ "sdkName": "toObjectId",
8633
+ "description": "Destination record identifier from objects.list or objects.search for toObjectType."
8634
+ }
8635
+ ],
8636
+ "query": [],
8637
+ "body": {
8638
+ "required": true,
8639
+ "fields": []
8640
+ }
8641
+ },
8642
+ {
8643
+ "resource": "crm.pipelines",
8644
+ "method": "list",
8645
+ "summary": "List pipelines",
8646
+ "description": "Discover pipelines and stage ids for records of one object type from schemas.list. Reuse pipeline and stage ids in record property updates or lead qualification. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.",
8647
+ "http": "GET",
8648
+ "path": "/crm/v1/pipelines/{objectType}",
8649
+ "streaming": "no",
8650
+ "pagination": false,
8651
+ "pathParams": [
8652
+ {
8653
+ "name": "objectType",
8654
+ "sdkName": "objectType",
8655
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8656
+ }
8657
+ ],
8658
+ "query": []
8659
+ },
8660
+ {
8661
+ "resource": "crm.pipelines",
8662
+ "method": "create",
8663
+ "summary": "Create pipeline",
8664
+ "description": "Create a pipeline with its ordered stages for an object type from schemas.list. Provide a display label, displayOrder and initial stages, then use the returned ids when assigning records. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.",
8665
+ "http": "POST",
8666
+ "path": "/crm/v1/pipelines/{objectType}",
8667
+ "streaming": "no",
8668
+ "pagination": false,
8669
+ "pathParams": [
8670
+ {
8671
+ "name": "objectType",
8672
+ "sdkName": "objectType",
8673
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8674
+ }
8675
+ ],
8676
+ "query": [],
8677
+ "body": {
8678
+ "required": true,
8679
+ "fields": [
8680
+ {
8681
+ "name": "displayOrder",
8682
+ "type": "integer",
8683
+ "required": true,
8684
+ "description": "An integer indicating the order in which the pipeline appears relative to other pipelines."
8685
+ },
8686
+ {
8687
+ "name": "label",
8688
+ "type": "string",
8689
+ "required": true,
8690
+ "description": "A string representing the name or title of the pipeline."
8691
+ },
8692
+ {
8693
+ "name": "pipelineId",
8694
+ "type": "string",
8695
+ "required": false,
8696
+ "description": "A string that uniquely identifies the pipeline. This property is optional when creating a new pipeline."
8697
+ },
8698
+ {
8699
+ "name": "stages",
8700
+ "type": "array",
8701
+ "itemType": "object",
8702
+ "required": true,
8703
+ "description": "An array of PipelineStageInput objects, each representing a stage within the pipeline."
8704
+ }
8705
+ ]
8706
+ }
8707
+ },
8708
+ {
8709
+ "resource": "crm.pipelines",
8710
+ "method": "archive",
8711
+ "summary": "Archive pipeline",
8712
+ "description": "Archive a pipeline selected from pipelines.list when records no longer depend on it. Check current records and stage usage first; resolve references reported by validation before retrying. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.",
8713
+ "http": "DELETE",
8714
+ "path": "/crm/v1/pipelines/{objectType}/{pipelineId}",
8715
+ "streaming": "no",
8716
+ "pagination": false,
8717
+ "pathParams": [
8718
+ {
8719
+ "name": "objectType",
8720
+ "sdkName": "objectType",
8721
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8722
+ },
8723
+ {
8724
+ "name": "pipelineId",
8725
+ "sdkName": "pipelineId",
8726
+ "description": "Pipeline identifier from pipelines.list for this objectType."
8727
+ }
8728
+ ],
8729
+ "query": [
8730
+ {
8731
+ "name": "validateDealStageUsagesBeforeDelete",
8732
+ "type": "boolean",
8733
+ "required": false,
8734
+ "description": "A boolean indicating whether to validate deal stage usages before deleting the pipeline. Defaults to true."
8735
+ },
8736
+ {
8737
+ "name": "validateReferencesBeforeDelete",
8738
+ "type": "boolean",
8739
+ "required": false,
8740
+ "description": "A boolean indicating whether to validate references before deleting the pipeline. Defaults to true."
8741
+ }
8742
+ ]
8743
+ },
8744
+ {
8745
+ "resource": "crm.pipelines",
8746
+ "method": "retrieve",
8747
+ "summary": "Retrieve pipeline",
8748
+ "description": "Inspect the stage ids and metadata of a pipeline before moving a record or editing its workflow. Obtain pipelineId from pipelines.list and use the returned stages array to select a destination. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.",
8749
+ "http": "GET",
8750
+ "path": "/crm/v1/pipelines/{objectType}/{pipelineId}",
8751
+ "streaming": "no",
8752
+ "pagination": false,
8753
+ "pathParams": [
8754
+ {
8755
+ "name": "objectType",
8756
+ "sdkName": "objectType",
8757
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8758
+ },
8759
+ {
8760
+ "name": "pipelineId",
8761
+ "sdkName": "pipelineId",
8762
+ "description": "Pipeline identifier from pipelines.list for this objectType."
8763
+ }
8764
+ ],
8765
+ "query": []
8766
+ },
8767
+ {
8768
+ "resource": "crm.pipelines",
8769
+ "method": "update",
8770
+ "summary": "Update pipeline",
8771
+ "description": "Change editable pipeline settings selected by pipelineId from pipelines.list. Omit settings that should remain unchanged and inspect current stages with pipelines.retrieve before modifying the workflow. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.",
8772
+ "http": "PATCH",
8773
+ "path": "/crm/v1/pipelines/{objectType}/{pipelineId}",
8774
+ "streaming": "no",
8775
+ "pagination": false,
8776
+ "pathParams": [
8777
+ {
8778
+ "name": "objectType",
8779
+ "sdkName": "objectType",
8780
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8781
+ },
8782
+ {
8783
+ "name": "pipelineId",
8784
+ "sdkName": "pipelineId",
8785
+ "description": "Pipeline identifier from pipelines.list for this objectType."
8786
+ }
8787
+ ],
8788
+ "query": [
8789
+ {
8790
+ "name": "validateDealStageUsagesBeforeDelete",
8791
+ "type": "boolean",
8792
+ "required": false,
8793
+ "description": "A boolean indicating whether to validate deal stage usages before deleting. Defaults to true."
8794
+ },
8795
+ {
8796
+ "name": "validateReferencesBeforeDelete",
8797
+ "type": "boolean",
8798
+ "required": false,
8799
+ "description": "A boolean indicating whether to validate references before deleting. Defaults to true."
8800
+ }
8801
+ ],
8802
+ "body": {
8803
+ "required": true,
8804
+ "fields": [
8805
+ {
8806
+ "name": "archived",
8807
+ "type": "boolean",
8808
+ "required": false,
8809
+ "description": "A boolean value that indicates whether the pipeline is archived."
8810
+ },
8811
+ {
8812
+ "name": "displayOrder",
8813
+ "type": "integer",
8814
+ "required": false,
8815
+ "description": "An integer indicating the position of the pipeline in a list, which determines its display order."
8816
+ },
8817
+ {
8818
+ "name": "label",
8819
+ "type": "string",
8820
+ "required": false,
8821
+ "description": "The name of the pipeline, represented as a string."
8822
+ }
8823
+ ]
8824
+ }
8825
+ },
8826
+ {
8827
+ "resource": "crm.pipelines.stages",
8828
+ "method": "create",
8829
+ "summary": "Create pipeline stage",
8830
+ "description": "Add an ordered stage to a pipeline from pipelines.list. Provide its display label, displayOrder and metadata; save the returned stage id for record updates. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.",
8831
+ "http": "POST",
8832
+ "path": "/crm/v1/pipelines/{objectType}/{pipelineId}/stages",
8833
+ "streaming": "no",
8834
+ "pagination": false,
8835
+ "pathParams": [
8836
+ {
8837
+ "name": "objectType",
8838
+ "sdkName": "objectType",
8839
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8840
+ },
8841
+ {
8842
+ "name": "pipelineId",
8843
+ "sdkName": "pipelineId",
8844
+ "description": "Pipeline identifier from pipelines.list for this objectType."
8845
+ }
8846
+ ],
8847
+ "query": [],
8848
+ "body": {
8849
+ "required": true,
8850
+ "fields": [
8851
+ {
8852
+ "name": "displayOrder",
8853
+ "type": "integer",
8854
+ "required": true,
8855
+ "description": "An integer indicating the position of this stage within the pipeline. Lower numbers indicate earlier stages."
8856
+ },
8857
+ {
8858
+ "name": "label",
8859
+ "type": "string",
8860
+ "required": true,
8861
+ "description": "The name of the pipeline stage. It is a string that provides a human-readable identifier for the stage."
8862
+ },
8863
+ {
8864
+ "name": "metadata",
8865
+ "type": "object",
8866
+ "required": true,
8867
+ "description": "String-valued stage settings, including transition and entry requirements. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying."
8868
+ },
8869
+ {
8870
+ "name": "stageId",
8871
+ "type": "string",
8872
+ "required": false,
8873
+ "description": "A string that uniquely identifies the stage within the pipeline."
8874
+ }
8875
+ ]
8876
+ }
8877
+ },
8878
+ {
8879
+ "resource": "crm.pipelines.stages",
8880
+ "method": "archive",
8881
+ "summary": "Archive pipeline stage",
8882
+ "description": "Archive a stage selected from pipelines.retrieve after checking record usage. A stage that still has records cannot be archived without resolving their assignment; move those records to an allowed stage first. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.",
8883
+ "http": "DELETE",
8884
+ "path": "/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}",
8885
+ "streaming": "no",
8886
+ "pagination": false,
8887
+ "pathParams": [
8888
+ {
8889
+ "name": "objectType",
8890
+ "sdkName": "objectType",
8891
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8892
+ },
8893
+ {
8894
+ "name": "pipelineId",
8895
+ "sdkName": "pipelineId",
8896
+ "description": "Pipeline identifier from pipelines.list for this objectType."
8897
+ },
8898
+ {
8899
+ "name": "stageId",
8900
+ "sdkName": "stageId",
8901
+ "description": "Stage identifier from the stages array returned by pipelines.retrieve for this pipeline."
8902
+ }
8903
+ ],
8904
+ "query": [
8905
+ {
8906
+ "name": "validateReferencesBeforeDelete",
8907
+ "type": "boolean",
8908
+ "required": false,
8909
+ "description": "A boolean flag indicating whether to validate references before deleting the stage. Defaults to true."
8910
+ }
8911
+ ]
8912
+ },
8913
+ {
8914
+ "resource": "crm.pipelines.stages",
8915
+ "method": "update",
8916
+ "summary": "Update pipeline stage",
8917
+ "description": "Change the label, order or metadata of a stage selected from pipelines.retrieve. Existing records must satisfy entry rules when subsequently moved; omitted settings retain their values. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.",
8918
+ "http": "PATCH",
8919
+ "path": "/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}",
8920
+ "streaming": "no",
8921
+ "pagination": false,
8922
+ "pathParams": [
8923
+ {
8924
+ "name": "objectType",
8925
+ "sdkName": "objectType",
8926
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8927
+ },
8928
+ {
8929
+ "name": "pipelineId",
8930
+ "sdkName": "pipelineId",
8931
+ "description": "Pipeline identifier from pipelines.list for this objectType."
8932
+ },
8933
+ {
8934
+ "name": "stageId",
8935
+ "sdkName": "stageId",
8936
+ "description": "Stage identifier from the stages array returned by pipelines.retrieve for this pipeline."
8937
+ }
8938
+ ],
8939
+ "query": [],
8940
+ "body": {
8941
+ "required": true,
8942
+ "fields": [
8943
+ {
8944
+ "name": "archived",
8945
+ "type": "boolean",
8946
+ "required": false,
8947
+ "description": "A boolean indicating whether the pipeline stage is archived."
8948
+ },
8949
+ {
8950
+ "name": "displayOrder",
8951
+ "type": "integer",
8952
+ "required": false,
8953
+ "description": "An integer specifying the order in which the stage appears relative to other stages."
8954
+ },
8955
+ {
8956
+ "name": "label",
8957
+ "type": "string",
8958
+ "required": false,
8959
+ "description": "A string representing the name or title of the pipeline stage."
8960
+ },
8961
+ {
8962
+ "name": "metadata",
8963
+ "type": "object",
8964
+ "required": true,
8965
+ "description": "String-valued stage settings, including transition and entry requirements. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying."
8966
+ }
8967
+ ]
8968
+ }
8969
+ },
8970
+ {
8971
+ "resource": "crm.properties",
8972
+ "method": "list",
8973
+ "summary": "List properties",
8974
+ "description": "Inspect the property definitions available for an object type before writing or filtering records. Obtain objectType from schemas.list; reuse each immutable name in record properties and filters. archived defaults to false.",
8975
+ "http": "GET",
8976
+ "path": "/crm/v1/properties/{objectType}",
8977
+ "streaming": "no",
8978
+ "pagination": false,
8979
+ "pathParams": [
8980
+ {
8981
+ "name": "objectType",
8982
+ "sdkName": "objectType",
8983
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
8984
+ }
8985
+ ],
8986
+ "query": [
8987
+ {
8988
+ "name": "archived",
8989
+ "type": "boolean",
8990
+ "required": false,
8991
+ "description": "Whether to return only results that have been archived."
8992
+ },
8993
+ {
8994
+ "name": "dataSensitivity",
8995
+ "type": "string",
8996
+ "enum": [
8997
+ "highly_sensitive",
8998
+ "non_sensitive",
8999
+ "sensitive"
9000
+ ],
9001
+ "required": false,
9002
+ "description": "Filter properties based on data sensitivity level. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'."
9003
+ },
9004
+ {
9005
+ "name": "locale",
9006
+ "type": "string",
9007
+ "required": false,
9008
+ "description": "Specify the locale to retrieve properties in a particular language or regional format."
9009
+ },
9010
+ {
9011
+ "name": "properties",
9012
+ "type": "string",
9013
+ "required": false,
9014
+ "description": "A comma-separated list of property names to include in the response."
9015
+ }
9016
+ ]
9017
+ },
9018
+ {
9019
+ "resource": "crm.properties",
9020
+ "method": "create",
9021
+ "summary": "Create property",
9022
+ "description": "Define a property before setting its values on records. Choose objectType from schemas.list and groupName from properties.groups.list; provide an immutable internal name, display label, type and fieldType. Enumeration properties require their valid options. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
9023
+ "http": "POST",
9024
+ "path": "/crm/v1/properties/{objectType}",
9025
+ "streaming": "no",
9026
+ "pagination": false,
9027
+ "pathParams": [
9028
+ {
9029
+ "name": "objectType",
9030
+ "sdkName": "objectType",
9031
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
9032
+ }
9033
+ ],
9034
+ "query": [],
9035
+ "body": {
9036
+ "required": true,
9037
+ "fields": [
9038
+ {
9039
+ "name": "calculationFormula",
9040
+ "type": "string",
9041
+ "required": false,
9042
+ "description": "Represents a formula that is used to compute a calculated property."
9043
+ },
9044
+ {
9045
+ "name": "currencyPropertyName",
9046
+ "type": "string",
9047
+ "required": false,
9048
+ "description": "A string representing the name of the currency property."
9049
+ },
9050
+ {
9051
+ "name": "dataSensitivity",
9052
+ "type": "string",
9053
+ "enum": [
9054
+ "highly_sensitive",
9055
+ "non_sensitive",
9056
+ "sensitive"
9057
+ ],
9058
+ "required": false,
9059
+ "description": "Indicates the sensitivity level of the property, with options: highly_sensitive, non_sensitive, or sensitive."
9060
+ },
9061
+ {
9062
+ "name": "description",
9063
+ "type": "string",
9064
+ "required": false,
9065
+ "description": "A description of the property that will be shown as help text in CRM."
9066
+ },
9067
+ {
9068
+ "name": "displayOrder",
9069
+ "type": "integer",
9070
+ "required": false,
9071
+ "description": "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values."
9072
+ },
9073
+ {
9074
+ "name": "externalOptions",
9075
+ "type": "boolean",
9076
+ "required": false,
9077
+ "description": "Applicable only for 'enumeration' type properties. Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'. Otherwise false."
9078
+ },
9079
+ {
9080
+ "name": "fieldType",
9081
+ "type": "string",
9082
+ "enum": [
9083
+ "booleancheckbox",
9084
+ "calculation_equation",
9085
+ "checkbox",
9086
+ "date",
9087
+ "file",
9088
+ "html",
9089
+ "number",
9090
+ "phonenumber",
9091
+ "radio",
9092
+ "select",
9093
+ "text",
9094
+ "textarea"
9095
+ ],
9096
+ "required": true,
9097
+ "description": "Controls how the property appears in CRM."
9098
+ },
9099
+ {
9100
+ "name": "formField",
9101
+ "type": "boolean",
9102
+ "required": false,
9103
+ "description": "Whether or not the property can be used in a CRM form."
9104
+ },
9105
+ {
9106
+ "name": "groupName",
9107
+ "type": "string",
9108
+ "required": true,
9109
+ "description": "The name of the property group the property belongs to."
9110
+ },
9111
+ {
9112
+ "name": "hasUniqueValue",
9113
+ "type": "boolean",
9114
+ "required": false,
9115
+ "description": "Whether or not the property's value must be unique. Once set, this can't be changed."
9116
+ },
9117
+ {
9118
+ "name": "hidden",
9119
+ "type": "boolean",
9120
+ "required": false,
9121
+ "description": "If true, the property won't be visible and can't be used in CRM."
9122
+ },
9123
+ {
9124
+ "name": "label",
9125
+ "type": "string",
9126
+ "required": true,
9127
+ "description": "A human-readable property label that will be shown in CRM."
9128
+ },
9129
+ {
9130
+ "name": "name",
9131
+ "type": "string",
9132
+ "required": true,
9133
+ "description": "The internal property name, which must be used when referencing the property via the API."
9134
+ },
9135
+ {
9136
+ "name": "numberDisplayHint",
9137
+ "type": "string",
9138
+ "enum": [
9139
+ "currency",
9140
+ "duration",
9141
+ "formatted",
9142
+ "percentage",
9143
+ "probability",
9144
+ "unformatted"
9145
+ ],
9146
+ "required": false,
9147
+ "description": "A string providing a hint on how to display numbers. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', 'probability'."
9148
+ },
9149
+ {
9150
+ "name": "options",
9151
+ "type": "array",
9152
+ "itemType": "object",
9153
+ "required": false,
9154
+ "description": "A list of valid options for the property. This field is required for enumerated properties."
9155
+ },
9156
+ {
9157
+ "name": "referencedObjectType",
9158
+ "type": "string",
9159
+ "required": false,
9160
+ "description": "Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current CRM users."
9161
+ },
9162
+ {
9163
+ "name": "showCurrencySymbol",
9164
+ "type": "boolean",
9165
+ "required": false,
9166
+ "description": "A boolean indicating whether to show the currency symbol for currency fields."
9167
+ },
9168
+ {
9169
+ "name": "textDisplayHint",
9170
+ "type": "string",
9171
+ "enum": [
9172
+ "domain_name",
9173
+ "email",
9174
+ "ip_address",
9175
+ "multi_line",
9176
+ "phone_number",
9177
+ "physical_address",
9178
+ "postal_code",
9179
+ "unformatted_single_line"
9180
+ ],
9181
+ "required": false,
9182
+ "description": "A string providing a hint on how to display text. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', 'postal_code'."
9183
+ },
9184
+ {
9185
+ "name": "type",
9186
+ "type": "string",
9187
+ "enum": [
9188
+ "bool",
9189
+ "date",
9190
+ "datetime",
9191
+ "enumeration",
9192
+ "number",
9193
+ "phone_number",
9194
+ "string"
9195
+ ],
9196
+ "required": true,
9197
+ "description": "The data type of the property."
9198
+ }
9199
+ ]
9200
+ }
9201
+ },
9202
+ {
9203
+ "resource": "crm.properties.groups",
9204
+ "method": "list",
9205
+ "summary": "List property groups",
9206
+ "description": "Discover property groups for an object type before creating or organizing property definitions. Obtain objectType from schemas.list and reuse a group name as groupName in properties.create or properties.update.",
9207
+ "http": "GET",
9208
+ "path": "/crm/v1/properties/{objectType}/groups",
9209
+ "streaming": "no",
9210
+ "pagination": false,
9211
+ "pathParams": [
9212
+ {
9213
+ "name": "objectType",
9214
+ "sdkName": "objectType",
9215
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
9216
+ }
9217
+ ],
9218
+ "query": [
9219
+ {
9220
+ "name": "locale",
9221
+ "type": "string",
9222
+ "required": false,
9223
+ "description": "The language locale to use for property group labels. This can help in displaying labels in the preferred language."
9224
+ }
9225
+ ]
9226
+ },
9227
+ {
9228
+ "resource": "crm.properties.groups",
9229
+ "method": "create",
9230
+ "summary": "Create property group",
9231
+ "description": "Create a named group for related property definitions of one object type. Obtain objectType from schemas.list; choose a unique internal name and display label, then reuse the returned name as groupName when creating properties. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
9232
+ "http": "POST",
9233
+ "path": "/crm/v1/properties/{objectType}/groups",
9234
+ "streaming": "no",
9235
+ "pagination": false,
9236
+ "pathParams": [
9237
+ {
9238
+ "name": "objectType",
9239
+ "sdkName": "objectType",
9240
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
9241
+ }
9242
+ ],
9243
+ "query": [],
9244
+ "body": {
9245
+ "required": true,
9246
+ "fields": [
9247
+ {
9248
+ "name": "displayOrder",
9249
+ "type": "integer",
9250
+ "required": false,
9251
+ "description": "Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values."
9252
+ },
9253
+ {
9254
+ "name": "label",
9255
+ "type": "string",
9256
+ "required": true,
9257
+ "description": "A human-readable label that will be shown in CRM."
9258
+ },
9259
+ {
9260
+ "name": "name",
9261
+ "type": "string",
9262
+ "required": true,
9263
+ "description": "The internal property group name, which must be used when referencing the property group via the API."
9264
+ }
9265
+ ]
9266
+ }
9267
+ },
9268
+ {
9269
+ "resource": "crm.properties",
9270
+ "method": "archive",
9271
+ "summary": "Archive property",
9272
+ "description": "Archive a property definition selected by internal name from properties.list. Confirm that record entry and search flows no longer depend on it; archived definitions are excluded from normal property lists. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.",
9273
+ "http": "DELETE",
9274
+ "path": "/crm/v1/properties/{objectType}/{propertyName}",
9275
+ "streaming": "no",
9276
+ "pagination": false,
9277
+ "pathParams": [
9278
+ {
9279
+ "name": "objectType",
9280
+ "sdkName": "objectType",
9281
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
9282
+ },
9283
+ {
9284
+ "name": "propertyName",
9285
+ "sdkName": "propertyName",
9286
+ "description": "Immutable internal property name from properties.list; do not pass the display label."
9287
+ }
9288
+ ],
9289
+ "query": []
9290
+ },
9291
+ {
9292
+ "resource": "crm.properties",
9293
+ "method": "retrieve",
9294
+ "summary": "Retrieve property",
9295
+ "description": "Inspect the type, options and modification restrictions of a property before changing its definition or record values. Obtain propertyName from properties.list; it is the immutable internal name rather than the label.",
9296
+ "http": "GET",
9297
+ "path": "/crm/v1/properties/{objectType}/{propertyName}",
9298
+ "streaming": "no",
9299
+ "pagination": false,
9300
+ "pathParams": [
9301
+ {
9302
+ "name": "objectType",
9303
+ "sdkName": "objectType",
9304
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
9305
+ },
9306
+ {
9307
+ "name": "propertyName",
9308
+ "sdkName": "propertyName",
9309
+ "description": "Immutable internal property name from properties.list; do not pass the display label."
9310
+ }
9311
+ ],
9312
+ "query": [
9313
+ {
9314
+ "name": "archived",
9315
+ "type": "boolean",
9316
+ "required": false,
9317
+ "description": "Whether to return only results that have been archived."
9318
+ },
9319
+ {
9320
+ "name": "dataSensitivity",
9321
+ "type": "string",
9322
+ "enum": [
9323
+ "highly_sensitive",
9324
+ "non_sensitive",
9325
+ "sensitive"
9326
+ ],
9327
+ "required": false,
9328
+ "description": "The level of data sensitivity to filter properties by. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'."
9329
+ },
9330
+ {
9331
+ "name": "locale",
9332
+ "type": "string",
9333
+ "required": false,
9334
+ "description": "The locale to use for property labels and descriptions."
9335
+ },
9336
+ {
9337
+ "name": "properties",
9338
+ "type": "string",
9339
+ "required": false,
9340
+ "description": "A comma-separated list of property names to include in the response."
9341
+ }
9342
+ ]
9343
+ },
9344
+ {
9345
+ "resource": "crm.properties",
9346
+ "method": "update",
9347
+ "summary": "Update property",
9348
+ "description": "Change editable settings of a property selected from properties.list, such as its label, group or options. Preserve the immutable internal name; inspect modificationMetadata before editing system-managed definitions. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
9349
+ "http": "PATCH",
9350
+ "path": "/crm/v1/properties/{objectType}/{propertyName}",
9351
+ "streaming": "no",
9352
+ "pagination": false,
9353
+ "pathParams": [
9354
+ {
9355
+ "name": "objectType",
9356
+ "sdkName": "objectType",
9357
+ "description": "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>."
9358
+ },
9359
+ {
9360
+ "name": "propertyName",
9361
+ "sdkName": "propertyName",
9362
+ "description": "Immutable internal property name from properties.list; do not pass the display label."
9363
+ }
9364
+ ],
9365
+ "query": [],
9366
+ "body": {
9367
+ "required": true,
9368
+ "fields": [
9369
+ {
9370
+ "name": "calculationFormula",
9371
+ "type": "string",
9372
+ "required": false,
9373
+ "description": "Represents a formula that is used to compute a calculated property."
9374
+ },
9375
+ {
9376
+ "name": "currencyPropertyName",
9377
+ "type": "string",
9378
+ "required": false,
9379
+ "description": "A string specifying the name of the property that holds the currency information, applicable when showCurrencySymbol is true."
9380
+ },
9381
+ {
9382
+ "name": "description",
9383
+ "type": "string",
9384
+ "required": false,
9385
+ "description": "A description of the property that will be shown as help text in CRM."
9386
+ },
9387
+ {
9388
+ "name": "displayOrder",
9389
+ "type": "integer",
9390
+ "required": false,
9391
+ "description": "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values."
9392
+ },
9393
+ {
9394
+ "name": "fieldType",
9395
+ "type": "string",
9396
+ "enum": [
9397
+ "booleancheckbox",
9398
+ "calculation_equation",
9399
+ "checkbox",
9400
+ "date",
9401
+ "file",
9402
+ "html",
9403
+ "number",
9404
+ "phonenumber",
9405
+ "radio",
9406
+ "select",
9407
+ "text",
9408
+ "textarea"
9409
+ ],
9410
+ "required": false,
9411
+ "description": "Controls how the property appears in CRM."
9412
+ },
9413
+ {
9414
+ "name": "formField",
9415
+ "type": "boolean",
9416
+ "required": false,
9417
+ "description": "Whether or not the property can be used in a CRM form."
9418
+ },
9419
+ {
9420
+ "name": "groupName",
9421
+ "type": "string",
9422
+ "required": false,
9423
+ "description": "The name of the property group the property belongs to."
9424
+ },
9425
+ {
9426
+ "name": "hidden",
9427
+ "type": "boolean",
9428
+ "required": false,
9429
+ "description": "If true, the property won't be visible and can't be used in CRM."
9430
+ },
9431
+ {
9432
+ "name": "label",
9433
+ "type": "string",
9434
+ "required": false,
9435
+ "description": "A human-readable property label that will be shown in CRM."
9436
+ },
9437
+ {
9438
+ "name": "numberDisplayHint",
9439
+ "type": "string",
9440
+ "enum": [
9441
+ "currency",
9442
+ "duration",
9443
+ "formatted",
9444
+ "percentage",
9445
+ "probability",
9446
+ "unformatted"
9447
+ ],
9448
+ "required": false,
9449
+ "description": "A string providing a hint for displaying number values. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'."
9450
+ },
9451
+ {
9452
+ "name": "options",
9453
+ "type": "array",
9454
+ "itemType": "object",
9455
+ "required": false,
9456
+ "description": "A list of valid options for the property."
9457
+ },
9458
+ {
9459
+ "name": "showCurrencySymbol",
9460
+ "type": "boolean",
9461
+ "required": false,
9462
+ "description": "A boolean indicating whether to display a currency symbol for number fields formatted as currency."
9463
+ },
9464
+ {
9465
+ "name": "textDisplayHint",
9466
+ "type": "string",
9467
+ "enum": [
9468
+ "domain_name",
9469
+ "email",
9470
+ "ip_address",
9471
+ "multi_line",
9472
+ "phone_number",
9473
+ "physical_address",
9474
+ "postal_code",
9475
+ "unformatted_single_line"
9476
+ ],
9477
+ "required": false,
9478
+ "description": "A string providing a hint for displaying text values. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'."
9479
+ },
9480
+ {
9481
+ "name": "type",
9482
+ "type": "string",
9483
+ "enum": [
9484
+ "bool",
9485
+ "date",
9486
+ "datetime",
9487
+ "enumeration",
9488
+ "number",
9489
+ "phone_number",
9490
+ "string"
9491
+ ],
9492
+ "required": false,
9493
+ "description": "The data type of the property."
9494
+ }
9495
+ ]
9496
+ }
9497
+ },
9498
+ {
9499
+ "resource": "crm.schemas",
9500
+ "method": "list",
9501
+ "summary": "List object schemas",
9502
+ "description": "Discover available object schemas, display labels, property definitions and association definitions. Reuse the object type identifier or name in record, property and pipeline operations. archived defaults to false; the include parameters control the definition and audit details returned.",
9503
+ "http": "GET",
9504
+ "path": "/crm/v1/schemas",
9505
+ "streaming": "no",
9506
+ "pagination": false,
9507
+ "pathParams": [],
9508
+ "query": [
9509
+ {
9510
+ "name": "archived",
9511
+ "type": "boolean",
9512
+ "required": false,
9513
+ "description": "Whether to return only results that have been archived."
9514
+ },
9515
+ {
9516
+ "name": "includeAssociationDefinitions",
9517
+ "type": "boolean",
9518
+ "required": false,
9519
+ "description": "Whether to include association definitions in the response. Defaults to true."
9520
+ },
9521
+ {
9522
+ "name": "includeAuditMetadata",
9523
+ "type": "boolean",
9524
+ "required": false,
9525
+ "description": "Whether to include audit metadata in the response. Defaults to true."
9526
+ },
9527
+ {
9528
+ "name": "includePropertyDefinitions",
9529
+ "type": "boolean",
9530
+ "required": false,
9531
+ "description": "Whether to include property definitions in the response. Defaults to true."
9532
+ }
9533
+ ]
9534
+ },
9535
+ {
9536
+ "resource": "crm.schemas",
9537
+ "method": "create",
9538
+ "summary": "Create object schema",
9539
+ "description": "Define a custom CRM object type before creating its records. Provide its immutable name, singular and plural labels, primaryDisplayProperty, properties and associated object types. Save the returned object type identifier for subsequent record and property operations. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.",
9540
+ "http": "POST",
9541
+ "path": "/crm/v1/schemas",
9542
+ "streaming": "no",
9543
+ "pagination": false,
9544
+ "pathParams": [],
9545
+ "query": [],
9546
+ "body": {
9547
+ "required": true,
9548
+ "fields": [
9549
+ {
9550
+ "name": "allowsSensitiveProperties",
9551
+ "type": "boolean",
9552
+ "required": true,
9553
+ "description": "Determines if the object type can include properties that are marked as sensitive."
9554
+ },
9555
+ {
9556
+ "name": "associatedObjects",
9557
+ "type": "array",
9558
+ "itemType": "string",
9559
+ "required": true,
9560
+ "description": "Associations defined for this object type."
9561
+ },
9562
+ {
9563
+ "name": "description",
9564
+ "type": "string",
9565
+ "required": false,
9566
+ "description": "A brief explanation of the object type."
9567
+ },
9568
+ {
9569
+ "name": "labels",
9570
+ "type": "object",
9571
+ "required": true
9572
+ },
9573
+ {
9574
+ "name": "name",
9575
+ "type": "string",
9576
+ "required": true,
9577
+ "description": "A unique name for this object. For internal use only."
9578
+ },
9579
+ {
9580
+ "name": "primaryDisplayProperty",
9581
+ "type": "string",
9582
+ "required": false,
9583
+ "description": "The name of the primary property for this object. This will be displayed as primary on the CRM record page for this object type."
9584
+ },
9585
+ {
9586
+ "name": "properties",
9587
+ "type": "array",
9588
+ "itemType": "object",
9589
+ "required": true,
9590
+ "description": "Properties defined for this object type."
9591
+ },
9592
+ {
9593
+ "name": "requiredProperties",
9594
+ "type": "array",
9595
+ "itemType": "string",
9596
+ "required": true,
9597
+ "description": "The names of properties that should be **required** when creating an object of this type."
9598
+ },
9599
+ {
9600
+ "name": "searchableProperties",
9601
+ "type": "array",
9602
+ "itemType": "string",
9603
+ "required": true,
9604
+ "description": "Names of properties that will be indexed for this object type in by CRM's product search."
9605
+ },
9606
+ {
9607
+ "name": "secondaryDisplayProperties",
9608
+ "type": "array",
9609
+ "itemType": "string",
9610
+ "required": true,
9611
+ "description": "The names of secondary properties for this object. These will be displayed as secondary on the CRM record page for this object type."
9612
+ },
9613
+ {
9614
+ "name": "shouldCreateSameObjectAssociation",
9615
+ "type": "boolean",
9616
+ "required": true,
9617
+ "description": "A boolean indicating whether associations should be created between objects of the same type."
9618
+ }
9619
+ ]
9620
+ }
9621
+ },
9622
+ {
9623
+ "resource": "cut.exports",
9624
+ "method": "retrieve",
9625
+ "summary": "Retrieve video export",
9626
+ "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.",
9627
+ "http": "GET",
9628
+ "path": "/cut/v1/exports/{export_id}",
9629
+ "streaming": "no",
9630
+ "pagination": false,
9631
+ "pathParams": [
9632
+ {
9633
+ "name": "export_id",
9634
+ "sdkName": "export_id",
9635
+ "description": "Export identifier returned by its create or list operation; use the id, not a display name."
9636
+ }
9637
+ ],
9638
+ "query": []
9639
+ },
9640
+ {
9641
+ "resource": "cut.exports",
9642
+ "method": "cancel",
9643
+ "summary": "Cancel video export",
9644
+ "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.",
9645
+ "http": "POST",
9646
+ "path": "/cut/v1/exports/{export_id}:cancel",
9647
+ "streaming": "no",
9648
+ "pagination": false,
9649
+ "pathParams": [
9650
+ {
9651
+ "name": "export_id",
9652
+ "sdkName": "export_id",
9653
+ "description": "Export identifier returned by its create or list operation; use the id, not a display name."
9654
+ }
9655
+ ],
9656
+ "query": []
9657
+ },
9658
+ {
9659
+ "resource": "cut.projects",
9660
+ "method": "list",
9661
+ "summary": "List projects",
9662
+ "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.",
9663
+ "http": "GET",
9664
+ "path": "/cut/v1/projects",
9665
+ "streaming": "no",
9666
+ "pagination": false,
9667
+ "pathParams": [],
9668
+ "query": [
9669
+ {
9670
+ "name": "page_size",
9671
+ "type": "integer",
9672
+ "required": false,
9673
+ "description": "Maximum resources in one page, from 1 to 100; defaults to 50."
9674
+ },
9675
+ {
9676
+ "name": "page_token",
9677
+ "type": "string",
9678
+ "required": false,
9679
+ "description": "Opaque next_page_token from the preceding page; omit on the first request."
9680
+ },
9681
+ {
9682
+ "name": "filter",
9683
+ "type": "string",
9684
+ "required": false,
9685
+ "description": "Optional resource filter; projects supports state = \"active\" or state = \"deleted\"."
9686
+ },
9687
+ {
9688
+ "name": "order_by",
9689
+ "type": "string",
9690
+ "required": false,
9691
+ "description": "Optional ordering expression; projects supports updateTime desc."
9692
+ }
9693
+ ]
9694
+ },
9695
+ {
9696
+ "resource": "cut.projects",
9697
+ "method": "create",
9698
+ "summary": "Create project",
9699
+ "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.",
9700
+ "http": "POST",
9701
+ "path": "/cut/v1/projects",
9702
+ "streaming": "no",
9703
+ "pagination": false,
9704
+ "pathParams": [],
9705
+ "query": [],
9706
+ "body": {
9707
+ "required": true,
9708
+ "fields": [
9709
+ {
9710
+ "name": "name",
9711
+ "type": "string",
9712
+ "required": true,
9713
+ "description": "Human-readable project name; required and must contain non-whitespace text."
9714
+ },
9715
+ {
9716
+ "name": "labels",
9717
+ "type": "object",
9718
+ "required": false,
9719
+ "description": "User-defined string labels for organizing projects; label keys retain their original spelling."
9720
+ },
9721
+ {
9722
+ "name": "settings",
9723
+ "type": "object",
9724
+ "required": true,
9725
+ "description": "Dimensions and frame rate for a new editing project."
9726
+ },
9727
+ {
9728
+ "name": "bindings",
9729
+ "type": "array",
9730
+ "itemType": "object",
9731
+ "required": true,
9732
+ "description": "Accessible library bindings; exactly one read_write entry must have default_upload true."
9733
+ }
9734
+ ]
9735
+ }
9736
+ },
9737
+ {
9738
+ "resource": "cut.projects",
9739
+ "method": "delete",
9740
+ "summary": "Delete project",
9741
+ "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.",
9742
+ "http": "DELETE",
9743
+ "path": "/cut/v1/projects/{project_id}",
9744
+ "streaming": "no",
9745
+ "pagination": false,
9746
+ "pathParams": [
9747
+ {
9748
+ "name": "project_id",
9749
+ "sdkName": "project_id",
9750
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
9751
+ }
9752
+ ],
9753
+ "query": []
9754
+ },
9755
+ {
9756
+ "resource": "cut.projects",
9757
+ "method": "retrieve",
9758
+ "summary": "Retrieve project",
9759
+ "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.",
9760
+ "http": "GET",
9761
+ "path": "/cut/v1/projects/{project_id}",
9762
+ "streaming": "no",
9763
+ "pagination": false,
9764
+ "pathParams": [
9765
+ {
9766
+ "name": "project_id",
9767
+ "sdkName": "project_id",
9768
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
9769
+ }
9770
+ ],
9771
+ "query": [
9772
+ {
9773
+ "name": "expand",
9774
+ "type": "string",
9775
+ "required": false,
9776
+ "description": "Comma-separated expansions: timeline includes clips, exports includes render jobs, versions includes saved snapshots."
9777
+ }
9778
+ ]
9779
+ },
9780
+ {
9781
+ "resource": "cut.projects",
9782
+ "method": "update",
9783
+ "summary": "Update project metadata",
9784
+ "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.",
9785
+ "http": "PATCH",
9786
+ "path": "/cut/v1/projects/{project_id}",
9787
+ "streaming": "no",
9788
+ "pagination": false,
9789
+ "pathParams": [
9790
+ {
9791
+ "name": "project_id",
9792
+ "sdkName": "project_id",
9793
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
9794
+ }
9795
+ ],
9796
+ "query": [],
9797
+ "body": {
9798
+ "required": true,
9799
+ "fields": [
9800
+ {
9801
+ "name": "name",
9802
+ "type": "string",
9803
+ "required": false,
9804
+ "description": "Replacement display name when update_mask includes name."
9805
+ },
9806
+ {
9807
+ "name": "labels",
9808
+ "type": "object",
9809
+ "required": false,
9810
+ "description": "User-defined string labels for organizing projects; label keys retain their original spelling."
9811
+ },
9812
+ {
9813
+ "name": "update_mask",
9814
+ "type": "array",
9815
+ "itemType": "string",
9816
+ "enum": [
9817
+ "name",
9818
+ "labels"
9819
+ ],
9820
+ "required": true,
9821
+ "description": "Metadata fields to replace; name changes the display name and labels replaces all labels."
9822
+ }
9823
+ ]
9824
+ }
9825
+ },
9826
+ {
9827
+ "resource": "cut.projects.analysis",
9828
+ "method": "create",
9829
+ "summary": "Analyze project media",
9830
+ "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.",
9831
+ "http": "POST",
9832
+ "path": "/cut/v1/projects/{project_id}/analysis",
9833
+ "streaming": "no",
9834
+ "pagination": false,
9835
+ "pathParams": [
9836
+ {
9837
+ "name": "project_id",
9838
+ "sdkName": "project_id",
9839
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
9840
+ }
9841
+ ],
9842
+ "query": [],
9843
+ "body": {
9844
+ "required": true,
9845
+ "fields": [
9846
+ {
9847
+ "name": "media",
9848
+ "type": "array",
9849
+ "itemType": "object",
9850
+ "required": false,
9851
+ "description": "Bound-library assets to analyze; omission selects project media."
9852
+ },
9853
+ {
9854
+ "name": "kinds",
9855
+ "type": "array",
9856
+ "itemType": "string",
9857
+ "enum": [
9858
+ "silence",
9859
+ "filler",
9860
+ "scenes"
9861
+ ],
9862
+ "required": true,
9863
+ "description": "Analysis types to request for the selected source assets."
9864
+ }
9865
+ ]
9866
+ }
9867
+ },
9868
+ {
9869
+ "resource": "cut.projects.bindings",
9870
+ "method": "list",
9871
+ "summary": "List library bindings",
9872
+ "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.",
9873
+ "http": "GET",
9874
+ "path": "/cut/v1/projects/{project_id}/bindings",
9875
+ "streaming": "no",
9876
+ "pagination": false,
9877
+ "pathParams": [
9878
+ {
9879
+ "name": "project_id",
9880
+ "sdkName": "project_id",
9881
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
9882
+ }
9883
+ ],
9884
+ "query": []
9885
+ },
9886
+ {
9887
+ "resource": "cut.projects.bindings",
9888
+ "method": "create",
9889
+ "summary": "Bind media library",
9890
+ "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.",
9891
+ "http": "POST",
9892
+ "path": "/cut/v1/projects/{project_id}/bindings",
9893
+ "streaming": "no",
9894
+ "pagination": false,
9895
+ "pathParams": [
9896
+ {
9897
+ "name": "project_id",
9898
+ "sdkName": "project_id",
9899
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
9900
+ }
9901
+ ],
9902
+ "query": [],
9903
+ "body": {
9904
+ "required": true,
9905
+ "fields": [
9906
+ {
9907
+ "name": "binding",
9908
+ "type": "object",
9909
+ "required": true,
9910
+ "description": "A named project link to a media library. Exactly one read_write binding must be default_upload."
9911
+ }
9912
+ ]
9913
+ }
9914
+ },
9915
+ {
9916
+ "resource": "cut.projects.bindings",
9917
+ "method": "delete",
9918
+ "summary": "Remove library binding",
9919
+ "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.",
9920
+ "http": "DELETE",
9921
+ "path": "/cut/v1/projects/{project_id}/bindings/{name}",
9922
+ "streaming": "no",
9923
+ "pagination": false,
9924
+ "pathParams": [
9925
+ {
9926
+ "name": "project_id",
9927
+ "sdkName": "project_id",
9928
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
9929
+ },
9930
+ {
9931
+ "name": "name",
9932
+ "sdkName": "name",
9933
+ "description": "Project-local binding alias from bindings.list; detach only after removing all clips that reference its library."
9934
+ }
9935
+ ],
9936
+ "query": []
9937
+ },
9938
+ {
9939
+ "resource": "cut.projects.exports",
9940
+ "method": "list",
9941
+ "summary": "List project exports",
9942
+ "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.",
9943
+ "http": "GET",
9944
+ "path": "/cut/v1/projects/{project_id}/exports",
9945
+ "streaming": "no",
9946
+ "pagination": false,
9947
+ "pathParams": [
9948
+ {
9949
+ "name": "project_id",
9950
+ "sdkName": "project_id",
9951
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
9952
+ }
9953
+ ],
9954
+ "query": [
9955
+ {
9956
+ "name": "page_size",
9957
+ "type": "integer",
9958
+ "required": false,
9959
+ "description": "Maximum resources in one page, from 1 to 100; defaults to 50."
9960
+ },
9961
+ {
9962
+ "name": "page_token",
9963
+ "type": "string",
9964
+ "required": false,
9965
+ "description": "Opaque next_page_token from the preceding page; omit on the first request."
9966
+ },
9967
+ {
9968
+ "name": "filter",
9969
+ "type": "string",
9970
+ "required": false,
9971
+ "description": "Optional resource filter; projects supports state = \"active\" or state = \"deleted\"."
9972
+ },
9973
+ {
9974
+ "name": "order_by",
9975
+ "type": "string",
9976
+ "required": false,
9977
+ "description": "Optional ordering expression; projects supports updateTime desc."
9978
+ }
9979
+ ]
9980
+ },
9981
+ {
9982
+ "resource": "cut.projects.exports",
9983
+ "method": "create",
9984
+ "summary": "Create video export",
9985
+ "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.",
9986
+ "http": "POST",
9987
+ "path": "/cut/v1/projects/{project_id}/exports",
9988
+ "streaming": "no",
9989
+ "pagination": false,
9990
+ "pathParams": [
9991
+ {
9992
+ "name": "project_id",
9993
+ "sdkName": "project_id",
9994
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
9995
+ }
9996
+ ],
9997
+ "query": [],
9998
+ "body": {
9999
+ "required": true,
10000
+ "fields": [
10001
+ {
10002
+ "name": "output",
10003
+ "type": "object",
10004
+ "required": false,
10005
+ "description": "Rendering options for an exported video."
10006
+ },
10007
+ {
10008
+ "name": "binding",
10009
+ "type": "string",
10010
+ "required": false,
10011
+ "description": "Writable binding name used as the export destination; omission uses default_upload."
10012
+ },
10013
+ {
10014
+ "name": "revision",
10015
+ "type": "integer",
10016
+ "required": false,
10017
+ "description": "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
10018
+ }
10019
+ ]
10020
+ }
10021
+ },
10022
+ {
10023
+ "resource": "cut.projects.frames",
10024
+ "method": "list",
10025
+ "summary": "Render preview frames",
10026
+ "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. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. Decode its base64 payload to save the image. Codemode returns at most four images per call, so request at most four times when reviewing there.",
10027
+ "http": "GET",
10028
+ "path": "/cut/v1/projects/{project_id}/frames",
10029
+ "streaming": "no",
10030
+ "pagination": false,
10031
+ "pathParams": [
10032
+ {
10033
+ "name": "project_id",
10034
+ "sdkName": "project_id",
10035
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
10036
+ }
10037
+ ],
10038
+ "query": [
10039
+ {
10040
+ "name": "at",
10041
+ "type": "string",
10042
+ "required": true,
10043
+ "description": "Required comma-separated non-negative project times in seconds, for example 12,15.5."
10044
+ },
10045
+ {
10046
+ "name": "scale",
10047
+ "type": "number",
10048
+ "required": false,
10049
+ "description": "Positive image size multiplier; 0.5 renders at half the project dimensions."
10050
+ },
10051
+ {
10052
+ "name": "revision",
10053
+ "type": "integer",
10054
+ "required": false,
10055
+ "description": "Optional committed project revision from state or execute; omission selects the current revision."
10056
+ }
10057
+ ]
10058
+ },
10059
+ {
10060
+ "resource": "cut.projects.media",
10061
+ "method": "import",
10062
+ "summary": "Import project media",
10063
+ "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.",
10064
+ "http": "POST",
10065
+ "path": "/cut/v1/projects/{project_id}/media:import",
10066
+ "streaming": "no",
10067
+ "pagination": false,
10068
+ "pathParams": [
10069
+ {
10070
+ "name": "project_id",
10071
+ "sdkName": "project_id",
10072
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
10073
+ }
10074
+ ],
10075
+ "query": [],
10076
+ "body": {
10077
+ "required": true,
10078
+ "fields": [
10079
+ {
10080
+ "name": "binding",
10081
+ "type": "string",
10082
+ "required": false,
10083
+ "description": "Writable binding name from project bindings; omission uses default_upload."
10084
+ },
10085
+ {
10086
+ "name": "source",
10087
+ "type": "object",
10088
+ "required": true,
10089
+ "description": "Exactly one input source for the imported asset."
10090
+ },
10091
+ {
10092
+ "name": "display_name",
10093
+ "type": "string",
10094
+ "required": false,
10095
+ "description": "Optional human-readable display name for the new media asset."
10096
+ }
10097
+ ]
10098
+ }
10099
+ },
10100
+ {
10101
+ "resource": "cut.projects",
10102
+ "method": "retrieveState",
10103
+ "summary": "Read editing state",
10104
+ "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.",
10105
+ "http": "GET",
10106
+ "path": "/cut/v1/projects/{project_id}/state",
10107
+ "streaming": "no",
10108
+ "pagination": false,
10109
+ "pathParams": [
10110
+ {
10111
+ "name": "project_id",
10112
+ "sdkName": "project_id",
10113
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
10114
+ }
10115
+ ],
10116
+ "query": []
10117
+ },
10118
+ {
10119
+ "resource": "cut.projects",
10120
+ "method": "retrieveTimeline",
10121
+ "summary": "Read project timeline",
10122
+ "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.",
10123
+ "http": "GET",
10124
+ "path": "/cut/v1/projects/{project_id}/timeline",
10125
+ "streaming": "no",
10126
+ "pagination": false,
10127
+ "pathParams": [
10128
+ {
10129
+ "name": "project_id",
10130
+ "sdkName": "project_id",
10131
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
10132
+ }
10133
+ ],
10134
+ "query": [
10135
+ {
10136
+ "name": "view",
10137
+ "type": "string",
10138
+ "enum": [
10139
+ "full",
10140
+ "compact"
10141
+ ],
10142
+ "required": false,
10143
+ "description": "full returns structured clips; compact returns compact textual editing context."
10144
+ },
10145
+ {
10146
+ "name": "from",
10147
+ "type": "number",
10148
+ "required": false,
10149
+ "description": "Optional start of the selected project range in seconds; omit for the beginning."
10150
+ },
10151
+ {
10152
+ "name": "to",
10153
+ "type": "number",
10154
+ "required": false,
10155
+ "description": "Optional end of the selected project range in seconds; omit for the end."
10156
+ },
10157
+ {
10158
+ "name": "tracks",
10159
+ "type": "string",
10160
+ "required": false,
10161
+ "description": "Comma-separated track ids from state to include; omit to include every track."
10162
+ }
10163
+ ]
10164
+ },
10165
+ {
10166
+ "resource": "cut.projects.versions",
10167
+ "method": "list",
10168
+ "summary": "List saved versions",
10169
+ "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.",
10170
+ "http": "GET",
10171
+ "path": "/cut/v1/projects/{project_id}/versions",
10172
+ "streaming": "no",
10173
+ "pagination": false,
10174
+ "pathParams": [
10175
+ {
10176
+ "name": "project_id",
10177
+ "sdkName": "project_id",
10178
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
10179
+ }
10180
+ ],
10181
+ "query": [
10182
+ {
10183
+ "name": "page_size",
10184
+ "type": "integer",
10185
+ "required": false,
10186
+ "description": "Maximum resources in one page, from 1 to 100; defaults to 50."
10187
+ },
10188
+ {
10189
+ "name": "page_token",
10190
+ "type": "string",
10191
+ "required": false,
10192
+ "description": "Opaque next_page_token from the preceding page; omit on the first request."
10193
+ },
10194
+ {
10195
+ "name": "filter",
10196
+ "type": "string",
10197
+ "required": false,
10198
+ "description": "Optional resource filter; projects supports state = \"active\" or state = \"deleted\"."
10199
+ },
10200
+ {
10201
+ "name": "order_by",
10202
+ "type": "string",
10203
+ "required": false,
10204
+ "description": "Optional ordering expression; projects supports updateTime desc."
10205
+ }
10206
+ ]
10207
+ },
10208
+ {
10209
+ "resource": "cut.projects.versions",
10210
+ "method": "create",
10211
+ "summary": "Save project version",
10212
+ "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.",
10213
+ "http": "POST",
10214
+ "path": "/cut/v1/projects/{project_id}/versions",
10215
+ "streaming": "no",
10216
+ "pagination": false,
10217
+ "pathParams": [
10218
+ {
10219
+ "name": "project_id",
10220
+ "sdkName": "project_id",
10221
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
10222
+ }
10223
+ ],
10224
+ "query": [],
10225
+ "body": {
10226
+ "required": true,
10227
+ "fields": [
10228
+ {
10229
+ "name": "label",
10230
+ "type": "string",
10231
+ "required": false,
10232
+ "description": "Human-readable snapshot label, such as Before captions."
10233
+ }
10234
+ ]
10235
+ }
10236
+ },
10237
+ {
10238
+ "resource": "cut.projects",
10239
+ "method": "execute",
10240
+ "summary": "Execute editing script",
10241
+ "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. 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: `const t = AddTrack(\"video\"); Insert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: \"in\" | \"out\", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: \"video\" | \"audio\" | \"caption\", init?: { name?: string }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration and tracks (id, kind, name, index, locked, items); from/to and tracks narrow the read. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip's kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result's frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, volumeDb, transform, fit, animate, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |\n| audio | media | length, sourceIn, volumeDb, fadeIn, fadeOut, transitionIn, transitionOut |\n| caption | text, length | — |\n\nVideo tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, stroke, background, align, maxWidth}`. fontFamily: Geist or Noto Sans SC (default); fontSize defaults to 48; fontWeight: 400 (default), 500 or 700; color defaults to #FFFFFF; align: left, center (default), right; maxWidth is a fraction of canvas width (default 0.9). stroke is `{color,width}`. Caption style additionally supports position (top/middle/bottom), margin (0–0.4 of canvas height), highlightColor and maxLines: 2. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip's beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: `Update(id, {volumeDb: -12})` or `Update(id, {transitionIn: null})`.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection's #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n",
10242
+ "http": "POST",
10243
+ "path": "/cut/v1/projects/{project_id}:execute",
10244
+ "streaming": "no",
10245
+ "pagination": false,
10246
+ "pathParams": [
10247
+ {
10248
+ "name": "project_id",
10249
+ "sdkName": "project_id",
10250
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
10251
+ }
10252
+ ],
10253
+ "query": [],
10254
+ "body": {
10255
+ "required": true,
10256
+ "fields": [
10257
+ {
10258
+ "name": "script",
10259
+ "type": "string",
10260
+ "required": false,
10261
+ "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."
10262
+ },
10263
+ {
10264
+ "name": "edit_id",
10265
+ "type": "string",
10266
+ "required": false,
10267
+ "description": "Saved failed script identifier from error.details.edit_id; valid for ten minutes."
10268
+ },
10269
+ {
10270
+ "name": "edits",
10271
+ "type": "array",
10272
+ "itemType": "object",
10273
+ "required": false,
10274
+ "description": "Literal replacements applied to the saved source before rerunning."
10275
+ },
10276
+ {
10277
+ "name": "expected_revision",
10278
+ "type": "integer",
10279
+ "required": false,
10280
+ "description": "Committed project revision from retrieve, state, timeline or execute; increases after each successful write."
10281
+ }
10282
+ ]
10283
+ }
10284
+ },
10285
+ {
10286
+ "resource": "cut.projects",
10287
+ "method": "undelete",
10288
+ "summary": "Restore deleted project",
10289
+ "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.",
10290
+ "http": "POST",
10291
+ "path": "/cut/v1/projects/{project_id}:undelete",
10292
+ "streaming": "no",
10293
+ "pagination": false,
10294
+ "pathParams": [
10295
+ {
10296
+ "name": "project_id",
10297
+ "sdkName": "project_id",
10298
+ "description": "Project identifier returned by its create or list operation; use the id, not a display name."
10299
+ }
10300
+ ],
10301
+ "query": []
10302
+ },
10303
+ {
10304
+ "resource": "cut.versions",
10305
+ "method": "restore",
10306
+ "summary": "Restore saved version",
10307
+ "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.",
10308
+ "http": "POST",
10309
+ "path": "/cut/v1/versions/{version_id}:restore",
10310
+ "streaming": "no",
10311
+ "pagination": false,
10312
+ "pathParams": [
10313
+ {
10314
+ "name": "version_id",
10315
+ "sdkName": "version_id",
10316
+ "description": "Version identifier returned by its create or list operation; use the id, not a display name."
10317
+ }
10318
+ ],
10319
+ "query": []
10320
+ },
10321
+ {
10322
+ "resource": "database.databases",
10323
+ "method": "list",
10324
+ "summary": "List databases",
10325
+ "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.",
10326
+ "http": "GET",
10327
+ "path": "/database/v1/databases",
10328
+ "streaming": "no",
10329
+ "pagination": true,
10330
+ "pathParams": [],
10331
+ "query": [
10332
+ {
10333
+ "name": "cursor",
10334
+ "type": "string",
10335
+ "required": false,
10336
+ "description": "Opaque next_cursor from the previous page."
10337
+ },
10338
+ {
10339
+ "name": "limit",
10340
+ "type": "integer",
10341
+ "required": false,
10342
+ "description": "Page size."
10343
+ },
10344
+ {
10345
+ "name": "labels",
10346
+ "type": "object",
10347
+ "required": false,
10348
+ "description": "Exact label match, encoded as labels[purpose]=docs."
10349
+ },
10350
+ {
10351
+ "name": "status",
10352
+ "type": "string",
10353
+ "enum": [
10354
+ "active",
10355
+ "deleting"
10356
+ ],
10357
+ "required": false,
10358
+ "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."
10359
+ }
10360
+ ]
10361
+ },
10362
+ {
10363
+ "resource": "database.databases",
10364
+ "method": "create",
10365
+ "summary": "Create database",
10366
+ "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.",
10367
+ "http": "POST",
10368
+ "path": "/database/v1/databases",
10369
+ "streaming": "no",
10370
+ "pagination": false,
10371
+ "pathParams": [],
10372
+ "query": [],
10373
+ "body": {
10374
+ "required": true,
10375
+ "fields": [
10376
+ {
10377
+ "name": "name",
10378
+ "type": "string",
10379
+ "required": true,
10380
+ "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."
10381
+ },
10382
+ {
10383
+ "name": "labels",
10384
+ "type": "object",
10385
+ "required": false,
10386
+ "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."
10387
+ }
10388
+ ]
10389
+ }
10390
+ },
10391
+ {
10392
+ "resource": "database.databases",
10393
+ "method": "delete",
10394
+ "summary": "Delete database",
10395
+ "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.",
10396
+ "http": "DELETE",
10397
+ "path": "/database/v1/databases/{database_id}",
10398
+ "streaming": "no",
10399
+ "pagination": false,
10400
+ "pathParams": [
10401
+ {
10402
+ "name": "database_id",
10403
+ "sdkName": "database_id",
10404
+ "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
10405
+ }
10406
+ ],
10407
+ "query": []
10408
+ },
10409
+ {
10410
+ "resource": "database.databases",
10411
+ "method": "retrieve",
10412
+ "summary": "Get database",
10413
+ "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.",
10414
+ "http": "GET",
10415
+ "path": "/database/v1/databases/{database_id}",
10416
+ "streaming": "no",
10417
+ "pagination": false,
10418
+ "pathParams": [
10419
+ {
10420
+ "name": "database_id",
10421
+ "sdkName": "database_id",
10422
+ "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
10423
+ }
10424
+ ],
10425
+ "query": []
10426
+ },
10427
+ {
10428
+ "resource": "database.databases",
10429
+ "method": "update",
10430
+ "summary": "Update database",
10431
+ "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.",
10432
+ "http": "PATCH",
10433
+ "path": "/database/v1/databases/{database_id}",
10434
+ "streaming": "no",
10435
+ "pagination": false,
10436
+ "pathParams": [
10437
+ {
10438
+ "name": "database_id",
10439
+ "sdkName": "database_id",
10440
+ "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
10441
+ }
10442
+ ],
10443
+ "query": [],
10444
+ "body": {
10445
+ "required": true,
10446
+ "fields": [
10447
+ {
10448
+ "name": "name",
10449
+ "type": "string",
10450
+ "required": false,
10451
+ "description": "New display name, 1–64 visible characters after trimming. Omit it to keep the current name."
10452
+ },
10453
+ {
10454
+ "name": "labels",
10455
+ "type": "object",
10456
+ "required": false,
10457
+ "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."
10458
+ }
10459
+ ]
10460
+ }
10461
+ },
10462
+ {
10463
+ "resource": "database.databases.events",
10464
+ "method": "list",
10465
+ "summary": "List events",
10466
+ "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.",
10467
+ "http": "GET",
10468
+ "path": "/database/v1/databases/{database_id}/events",
10469
+ "streaming": "no",
10470
+ "pagination": false,
10471
+ "pathParams": [
10472
+ {
10473
+ "name": "database_id",
10474
+ "sdkName": "database_id",
10475
+ "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
10476
+ }
10477
+ ],
10478
+ "query": [
10479
+ {
10480
+ "name": "after_seq",
10481
+ "type": "integer",
10482
+ "required": false,
10483
+ "description": "With order=asc, return only events with seq greater than this value. Cannot be combined with before_seq."
10484
+ },
10485
+ {
10486
+ "name": "limit",
10487
+ "type": "integer",
10488
+ "required": false,
10489
+ "description": "Page size."
10490
+ },
10491
+ {
10492
+ "name": "order",
10493
+ "type": "string",
10494
+ "enum": [
10495
+ "asc",
10496
+ "desc"
10497
+ ],
10498
+ "required": false,
10499
+ "description": "Sequence order: asc or desc (newest first). Defaults to asc, or to desc when before_seq is supplied."
10500
+ },
10501
+ {
10502
+ "name": "before_seq",
10503
+ "type": "integer",
10504
+ "required": false,
10505
+ "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."
10506
+ }
10507
+ ]
10508
+ },
10509
+ {
10510
+ "resource": "database.databases.purge",
10511
+ "method": "create",
10512
+ "summary": "Permanently purge database",
10513
+ "description": "Immediately and irreversibly purges a deleting database. Active databases return 409; absent or already purged databases return 404.",
10514
+ "http": "POST",
10515
+ "path": "/database/v1/databases/{database_id}/purge",
10516
+ "streaming": "no",
10517
+ "pagination": false,
10518
+ "pathParams": [
10519
+ {
10520
+ "name": "database_id",
10521
+ "sdkName": "database_id",
10522
+ "description": "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted."
10523
+ }
10524
+ ],
10525
+ "query": []
10526
+ },
10527
+ {
10528
+ "resource": "database.databases.rest",
10529
+ "method": "delete",
10530
+ "summary": "Delete rows",
7496
10531
  "description": "Deletes the rows matched by the filter query parameters (the same filters as databaseSelect); with no filter every row of the table matches. Deletion is immediate and cannot be undone. A row that a link field of another table still references makes the whole call fail with 409 REFERENCE_RESTRICT and nothing is deleted. The default response is 204 with no body; send Prefer: return=representation to get HTTP 200 with the deleted rows.",
7497
10532
  "http": "DELETE",
7498
10533
  "path": "/database/v1/databases/{database_id}/rest/{table}",
@@ -8382,6 +11417,64 @@ export const operations = [
8382
11417
  ],
8383
11418
  "query": []
8384
11419
  },
11420
+ {
11421
+ "resource": "file.files.contentLinks",
11422
+ "method": "revoke",
11423
+ "summary": "Revoke a file content link",
11424
+ "description": "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 30 seconds; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {\"token\":\"<token from /c/>\"}.",
11425
+ "http": "POST",
11426
+ "path": "/file/v1/files/{file_id}/content_links:revoke",
11427
+ "streaming": "no",
11428
+ "pagination": false,
11429
+ "pathParams": [
11430
+ {
11431
+ "name": "file_id",
11432
+ "sdkName": "file_id",
11433
+ "description": "Tenant-owned file identifier returned by file creation or listing; the token must name this same file."
11434
+ }
11435
+ ],
11436
+ "query": [],
11437
+ "body": {
11438
+ "required": true,
11439
+ "fields": [
11440
+ {
11441
+ "name": "token",
11442
+ "type": "string",
11443
+ "required": true,
11444
+ "description": "Signed token taken from the /c/ path component of a previously issued file content URL, without the host or /c/ prefix."
11445
+ }
11446
+ ]
11447
+ }
11448
+ },
11449
+ {
11450
+ "resource": "file.files.contentUrl",
11451
+ "method": "create",
11452
+ "summary": "Create a download URL",
11453
+ "description": "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 3600 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {\"ttl_seconds\":3600}.",
11454
+ "http": "POST",
11455
+ "path": "/file/v1/files/{file_id}/content_url",
11456
+ "streaming": "no",
11457
+ "pagination": false,
11458
+ "pathParams": [
11459
+ {
11460
+ "name": "file_id",
11461
+ "sdkName": "file_id",
11462
+ "description": "Tenant-owned live file identifier from file creation or listing; the file must be active to issue a download URL."
11463
+ }
11464
+ ],
11465
+ "query": [],
11466
+ "body": {
11467
+ "required": false,
11468
+ "fields": [
11469
+ {
11470
+ "name": "ttl_seconds",
11471
+ "type": "integer",
11472
+ "required": false,
11473
+ "description": "Download link lifetime in seconds, from 1 through 604800; omitted means 3600. This does not change the file's own expiry."
11474
+ }
11475
+ ]
11476
+ }
11477
+ },
8385
11478
  {
8386
11479
  "resource": "file.uploads",
8387
11480
  "method": "create",
@@ -8439,6 +11532,63 @@ export const operations = [
8439
11532
  ]
8440
11533
  }
8441
11534
  },
11535
+ {
11536
+ "resource": "file.uploads",
11537
+ "method": "createSigned",
11538
+ "summary": "Create a one-time upload URL",
11539
+ "description": "Upload a local file of up to 2 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes), PUT each chunk to its numbered parts[].url in any order, then POST complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 3600 for multipart, at most 604800; all multipart URLs share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.",
11540
+ "http": "POST",
11541
+ "path": "/file/v1/uploads/signed",
11542
+ "streaming": "no",
11543
+ "pagination": false,
11544
+ "pathParams": [],
11545
+ "query": [],
11546
+ "body": {
11547
+ "required": true,
11548
+ "fields": [
11549
+ {
11550
+ "name": "filename",
11551
+ "type": "string",
11552
+ "required": true,
11553
+ "description": "Stored basename, 1–255 UTF-8 bytes without control characters or path separators."
11554
+ },
11555
+ {
11556
+ "name": "bytes",
11557
+ "type": "integer",
11558
+ "required": true,
11559
+ "description": "Exact local file size in bytes, from 1 through 2147483648 (2 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs and a completion URL. Every PUT requires its exact signed Content-Length."
11560
+ },
11561
+ {
11562
+ "name": "content_type",
11563
+ "type": "string",
11564
+ "required": true,
11565
+ "description": "Declared MIME type, such as image/png. In single-PUT mode, send exactly this Content-Type or omit it. Stored file metadata is detected from the bytes in both modes."
11566
+ },
11567
+ {
11568
+ "name": "purpose",
11569
+ "type": "string",
11570
+ "enum": [
11571
+ "user_data",
11572
+ "vision"
11573
+ ],
11574
+ "required": false,
11575
+ "description": "user_data stores ordinary files and conversation images; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data."
11576
+ },
11577
+ {
11578
+ "name": "expires_in",
11579
+ "type": "integer",
11580
+ "required": false,
11581
+ "description": "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 3600 for multipart. All part URLs and the completion URL share one expiry. This does not set the resulting file's lifetime."
11582
+ },
11583
+ {
11584
+ "name": "part_size",
11585
+ "type": "integer",
11586
+ "required": false,
11587
+ "description": "Fixed multipart chunk size in bytes, from 5242880 through 64000000; defaults to 64000000. Used only above 104857600 total bytes. The final part contains the remaining bytes; single-PUT mode keeps its existing response."
11588
+ }
11589
+ ]
11590
+ }
11591
+ },
8442
11592
  {
8443
11593
  "resource": "file.uploads",
8444
11594
  "method": "cancel",
@@ -8585,7 +11735,7 @@ export const operations = [
8585
11735
  "resource": "knowledge.vectorStores",
8586
11736
  "method": "create",
8587
11737
  "summary": "Create knowledge base",
8588
- "description": "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Unlike OpenAI vector stores, each file is limited to 100000000 bytes and each account to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.",
11738
+ "description": "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.",
8589
11739
  "http": "POST",
8590
11740
  "path": "/knowledge/v1/vector_stores",
8591
11741
  "streaming": "no",
@@ -8636,7 +11786,7 @@ export const operations = [
8636
11786
  "name": "models",
8637
11787
  "type": "object",
8638
11788
  "required": false,
8639
- "description": "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400."
11789
+ "description": "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions, ocr → mistral.ocr or pdf_input capability, vision → vision capability). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400."
8640
11790
  }
8641
11791
  ]
8642
11792
  }
@@ -8740,7 +11890,7 @@ export const operations = [
8740
11890
  "name": "models",
8741
11891
  "type": "object",
8742
11892
  "required": false,
8743
- "description": "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400."
11893
+ "description": "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions, ocr → mistral.ocr or pdf_input capability, vision → vision capability). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400."
8744
11894
  }
8745
11895
  ]
8746
11896
  }
@@ -8971,7 +12121,7 @@ export const operations = [
8971
12121
  "resource": "knowledge.vectorStores.files",
8972
12122
  "method": "create",
8973
12123
  "summary": "Add file",
8974
- "description": "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. Unlike OpenAI vector stores, the file limit is 100000000 bytes; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.",
12124
+ "description": "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.",
8975
12125
  "http": "POST",
8976
12126
  "path": "/knowledge/v1/vector_stores/{vector_store_id}/files",
8977
12127
  "streaming": "no",
@@ -9633,6 +12783,16 @@ export const operations = [
9633
12783
  ],
9634
12784
  "required": false,
9635
12785
  "description": "Upload category: image for images, video for video or audio, raw for unprocessed files, or auto to detect the category. Defaults to auto."
12786
+ },
12787
+ {
12788
+ "name": "type",
12789
+ "type": "string",
12790
+ "enum": [
12791
+ "upload",
12792
+ "authenticated"
12793
+ ],
12794
+ "required": false,
12795
+ "description": "Asset delivery mode: upload is public; authenticated requires a signed URL or delivery token for originals and derivatives. private is unsupported."
9636
12796
  }
9637
12797
  ]
9638
12798
  }
@@ -9661,7 +12821,7 @@ export const operations = [
9661
12821
  "name": "file_id",
9662
12822
  "type": "string",
9663
12823
  "required": true,
9664
- "description": "File ID to copy into this library; passed as the upload source instead of file bytes. This creates an independent public copy readable without authentication. Deleting the source File does not delete this asset; do not import confidential content."
12824
+ "description": "File ID to copy into this library instead of file bytes. This independent copy defaults to public delivery; set type=authenticated for private delivery. Deleting the source File does not delete this asset."
9665
12825
  },
9666
12826
  {
9667
12827
  "name": "public_id",
@@ -9746,6 +12906,16 @@ export const operations = [
9746
12906
  ],
9747
12907
  "required": false,
9748
12908
  "description": "Upload category: image for images, video for video or audio, raw for unprocessed files, or auto to detect the category. Defaults to auto."
12909
+ },
12910
+ {
12911
+ "name": "type",
12912
+ "type": "string",
12913
+ "enum": [
12914
+ "upload",
12915
+ "authenticated"
12916
+ ],
12917
+ "required": false,
12918
+ "description": "Asset delivery mode: upload is public; authenticated requires a signed URL or delivery token for originals and derivatives. private is unsupported."
9749
12919
  }
9750
12920
  ]
9751
12921
  }
@@ -10026,6 +13196,41 @@ export const operations = [
10026
13196
  ],
10027
13197
  "query": []
10028
13198
  },
13199
+ {
13200
+ "resource": "media.libraries.deliveryTokens",
13201
+ "method": "create",
13202
+ "summary": "Create delivery token",
13203
+ "description": "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 3600 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.",
13204
+ "http": "POST",
13205
+ "path": "/media/v1/libraries/{library_id}/delivery_tokens",
13206
+ "streaming": "no",
13207
+ "pagination": false,
13208
+ "pathParams": [
13209
+ {
13210
+ "name": "library_id",
13211
+ "sdkName": "library_id",
13212
+ "description": "Library ID returned by creation."
13213
+ }
13214
+ ],
13215
+ "query": [],
13216
+ "body": {
13217
+ "required": true,
13218
+ "fields": [
13219
+ {
13220
+ "name": "acl",
13221
+ "type": "string",
13222
+ "required": false,
13223
+ "description": "Delivery path glob restricted to the library path prefix (a slash, library_id, then a slash). Defaults to that prefix followed by *; * matches any path text. Tildes and control characters are rejected."
13224
+ },
13225
+ {
13226
+ "name": "expires_in",
13227
+ "type": "integer",
13228
+ "required": false,
13229
+ "description": "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 3600."
13230
+ }
13231
+ ]
13232
+ }
13233
+ },
10029
13234
  {
10030
13235
  "resource": "media.libraries.events",
10031
13236
  "method": "list",
@@ -11806,7 +15011,8 @@ export const operations = [
11806
15011
  "openai.images.edits",
11807
15012
  "openai.images.generations",
11808
15013
  "openai.responses",
11809
- "openai.videos"
15014
+ "openai.videos",
15015
+ "typesafe.systemone"
11810
15016
  ],
11811
15017
  "required": false,
11812
15018
  "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."
@@ -12381,6 +15587,47 @@ export const operations = [
12381
15587
  ],
12382
15588
  "query": []
12383
15589
  },
15590
+ {
15591
+ "resource": "model.systemone",
15592
+ "method": "create",
15593
+ "summary": "Ask structured decision questions",
15594
+ "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.",
15595
+ "http": "POST",
15596
+ "path": "/model/v1/systemone",
15597
+ "streaming": "no",
15598
+ "pagination": false,
15599
+ "pathParams": [],
15600
+ "query": [],
15601
+ "body": {
15602
+ "required": true,
15603
+ "fields": [
15604
+ {
15605
+ "name": "model",
15606
+ "type": "string",
15607
+ "required": true,
15608
+ "description": "Published model id from model.models.list with supported_apis containing typesafe.systemone; returned unchanged in the response."
15609
+ },
15610
+ {
15611
+ "name": "state",
15612
+ "type": "object",
15613
+ "required": true,
15614
+ "description": "Shared content evaluated by every question, supplied as text, a JSON object or an array."
15615
+ },
15616
+ {
15617
+ "name": "questions",
15618
+ "type": "object",
15619
+ "required": true,
15620
+ "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."
15621
+ },
15622
+ {
15623
+ "name": "assets",
15624
+ "type": "object",
15625
+ "required": false,
15626
+ "description": "Unsupported image assets. Supplying this field, including null or an empty collection, returns 400: images are not supported."
15627
+ }
15628
+ ]
15629
+ }
15630
+ },
12384
15631
  {
12385
15632
  "resource": "model.videos",
12386
15633
  "method": "list",
@@ -12972,6 +16219,31 @@ export const operations = [
12972
16219
  ]
12973
16220
  }
12974
16221
  },
16222
+ {
16223
+ "resource": "organization.members",
16224
+ "method": "list",
16225
+ "summary": "List organization members",
16226
+ "description": "Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.",
16227
+ "http": "GET",
16228
+ "path": "/organization/v1/members",
16229
+ "streaming": "no",
16230
+ "pagination": false,
16231
+ "pathParams": [],
16232
+ "query": [
16233
+ {
16234
+ "name": "limit",
16235
+ "type": "integer",
16236
+ "required": false,
16237
+ "description": "Maximum members per page, from 1 to 100; defaults to 20."
16238
+ },
16239
+ {
16240
+ "name": "page",
16241
+ "type": "string",
16242
+ "required": false,
16243
+ "description": "Opaque next_page cursor returned by the previous response; omit for the first page."
16244
+ }
16245
+ ]
16246
+ },
12975
16247
  {
12976
16248
  "resource": "organization.usage",
12977
16249
  "method": "list",
@@ -13679,7 +16951,7 @@ export const operations = [
13679
16951
  "resource": "sandbox.sandboxes.commands",
13680
16952
  "method": "run",
13681
16953
  "summary": "Run a command in the sandbox",
13682
- "description": "Execute a shell command and wait for stdout, stderr and exitCode. Supply cmd, optional cwd and envs, and timeoutMs (1–60000 milliseconds, default 60000). Unlike E2B, this endpoint is synchronous only: no background mode, callbacks or unlimited timeout; output is bounded to 1 MiB including stream framing. Nonzero exit codes return 200 with the result. A timeout returns COMMAND_TIMEOUT (504); transport timeout does not confirm process termination, so do not blindly retry commands with side effects. Example body: {\"cmd\":\"echo hi\"}.",
16954
+ "description": "Execute a shell command and wait for stdout, stderr and exitCode. Supply cmd, optional cwd and envs, and timeoutMs (1–3600000 milliseconds, default 600000, that is 10 minutes; E2B defaults to 60000). Unlike E2B, this endpoint is synchronous only: no background mode, callbacks or unlimited timeout (timeoutMs 0); output is bounded to 1 MiB including stream framing. Nonzero exit codes return 200 with the result. A timeout returns COMMAND_TIMEOUT (504); transport timeout does not confirm process termination, so do not blindly retry commands with side effects. Example body: {\"cmd\":\"echo hi\"}.",
13683
16955
  "http": "POST",
13684
16956
  "path": "/sandbox/v1/sandboxes/{sandbox_id}/commands",
13685
16957
  "streaming": "no",
@@ -13701,6 +16973,12 @@ export const operations = [
13701
16973
  "required": true,
13702
16974
  "description": "Shell command to execute, for example echo hi."
13703
16975
  },
16976
+ {
16977
+ "name": "background",
16978
+ "type": "boolean",
16979
+ "required": false,
16980
+ "description": "When true, return 202 with the pid as soon as the process starts; it keeps running after the request ends. Read its status and output with GET /sandbox/v1/sandboxes/{sandbox_id}/commands/{pid}, stop it with DELETE. Same idea as E2B background commands."
16981
+ },
13704
16982
  {
13705
16983
  "name": "cwd",
13706
16984
  "type": "string",
@@ -13717,7 +16995,7 @@ export const operations = [
13717
16995
  "name": "timeoutMs",
13718
16996
  "type": "integer",
13719
16997
  "required": false,
13720
- "description": "Execution timeout in milliseconds, from 1 to 60000; defaults to 60000."
16998
+ "description": "Execution timeout in milliseconds, from 1 to 3600000 (1 hour); defaults to 600000 (10 minutes). In background mode this limits process runtime; expiry records exit code 124."
13721
16999
  }
13722
17000
  ]
13723
17001
  }
@@ -13916,7 +17194,7 @@ export const operations = [
13916
17194
  "resource": "sandbox.templates",
13917
17195
  "method": "list",
13918
17196
  "summary": "List templates (v2)",
13919
- "description": "List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.",
17197
+ "description": "List official templates and all your custom templates, including waiting, building, ready and error builds. Custom templates appear first; each custom row describes its latest build, not necessarily the current ready build. Use templateID for build management and a ready template name when creating a sandbox. Own-face official distinguishes public catalog entries; sourceKind is omitted until a source is submitted and on official templates. Other organizations' templates are invisible.",
13920
17198
  "http": "GET",
13921
17199
  "path": "/sandbox/v1/templates",
13922
17200
  "streaming": "no",
@@ -13927,8 +17205,201 @@ export const operations = [
13927
17205
  "name": "teamID",
13928
17206
  "type": "string",
13929
17207
  "required": false,
13930
- "description": "Id of the team whose templates to list. Omit it to list the templates of your own team; a team you do not belong to answers 403."
17208
+ "description": "Upstream team selector; Praxis always lists the authenticated organization's templates."
17209
+ },
17210
+ {
17211
+ "name": "nextToken",
17212
+ "type": "string",
17213
+ "required": false,
17214
+ "description": "Cursor to start the list from"
13931
17215
  },
17216
+ {
17217
+ "name": "limit",
17218
+ "type": "integer",
17219
+ "required": false,
17220
+ "description": "Maximum number of items to return per page"
17221
+ }
17222
+ ]
17223
+ },
17224
+ {
17225
+ "resource": "sandbox.templates",
17226
+ "method": "create",
17227
+ "summary": "Create template (v3)",
17228
+ "description": "Reserve a waiting build before submitting its source. Reusing a name in your organization allocates a new build on the same template. Returns templateID and buildID; start it with templates.builds.update, then poll templates.builds.status.list. A name:tag suffix and tags are assigned after successful publication. Example: {\"name\":\"my-template\",\"cpuCount\":2,\"memoryMB\":2048}. The own face also accepts diskGb, a positive integer defaulting to 10 GiB.",
17229
+ "http": "POST",
17230
+ "path": "/sandbox/v1/templates",
17231
+ "streaming": "no",
17232
+ "pagination": false,
17233
+ "pathParams": [],
17234
+ "query": [],
17235
+ "body": {
17236
+ "required": true,
17237
+ "fields": [
17238
+ {
17239
+ "name": "name",
17240
+ "type": "string",
17241
+ "required": false,
17242
+ "description": "Name of the template. Can include a tag with colon separator (e.g. \"my-template\" or \"my-template:v1\"). If tag is included, it will be treated as if the tag was provided in the tags array."
17243
+ },
17244
+ {
17245
+ "name": "tags",
17246
+ "type": "array",
17247
+ "itemType": "string",
17248
+ "required": false,
17249
+ "description": "Tags to assign to the template build"
17250
+ },
17251
+ {
17252
+ "name": "alias",
17253
+ "type": "string",
17254
+ "required": false,
17255
+ "description": "Alias of the template. Deprecated, use name instead."
17256
+ },
17257
+ {
17258
+ "name": "teamID",
17259
+ "type": "string",
17260
+ "required": false,
17261
+ "description": "Identifier of the team"
17262
+ },
17263
+ {
17264
+ "name": "cpuCount",
17265
+ "type": "integer",
17266
+ "required": false,
17267
+ "description": "Requested virtual CPU count; a positive integer, default 2 for template builds."
17268
+ },
17269
+ {
17270
+ "name": "memoryMB",
17271
+ "type": "integer",
17272
+ "required": false,
17273
+ "description": "Requested build memory in MiB; a positive integer, default 1024."
17274
+ },
17275
+ {
17276
+ "name": "minFreeDiskMb",
17277
+ "type": "integer",
17278
+ "required": false,
17279
+ "description": "Upstream minimum free disk request in MiB; use the native diskGb field to set the build disk size."
17280
+ },
17281
+ {
17282
+ "name": "diskGb",
17283
+ "type": "integer",
17284
+ "required": false,
17285
+ "description": "Build disk size in GiB, a positive safe integer. Defaults to 10; available only on the own face."
17286
+ }
17287
+ ]
17288
+ }
17289
+ },
17290
+ {
17291
+ "resource": "sandbox.templates.aliases",
17292
+ "method": "retrieve",
17293
+ "summary": "Check template alias",
17294
+ "description": "Resolve a name within your organization to its templateID before reading or managing builds. Use the bare template name, without a :tag suffix. Unknown and other-organization names return 404. The response public field is false for your private templates.",
17295
+ "http": "GET",
17296
+ "path": "/sandbox/v1/templates/aliases/{alias}",
17297
+ "streaming": "no",
17298
+ "pagination": false,
17299
+ "pathParams": [
17300
+ {
17301
+ "name": "alias",
17302
+ "sdkName": "alias",
17303
+ "description": "Bare template name belonging to your organization, without a tag or provider namespace."
17304
+ }
17305
+ ],
17306
+ "query": []
17307
+ },
17308
+ {
17309
+ "resource": "sandbox.templates.tags",
17310
+ "method": "delete",
17311
+ "summary": "Delete template tags",
17312
+ "description": "Remove the specified tag labels from your template by name, for example {\"name\":\"my-template\",\"tags\":[\"stable\"]}. Builds remain available. Removing default means untagged sandbox creation no longer resolves this template. Unknown or other-organization names return 404. b<number> names are reserved read-only build aliases and cannot be assigned or deleted as tags.",
17313
+ "http": "DELETE",
17314
+ "path": "/sandbox/v1/templates/tags",
17315
+ "streaming": "no",
17316
+ "pagination": false,
17317
+ "pathParams": [],
17318
+ "query": [],
17319
+ "body": {
17320
+ "required": true,
17321
+ "fields": [
17322
+ {
17323
+ "name": "name",
17324
+ "type": "string",
17325
+ "required": true,
17326
+ "description": "Name of the template"
17327
+ },
17328
+ {
17329
+ "name": "tags",
17330
+ "type": "array",
17331
+ "itemType": "string",
17332
+ "required": true,
17333
+ "description": "Tags to delete"
17334
+ }
17335
+ ]
17336
+ }
17337
+ },
17338
+ {
17339
+ "resource": "sandbox.templates.tags",
17340
+ "method": "create",
17341
+ "summary": "Assign template tags",
17342
+ "description": "Assign tags to the ready build selected by target in name:tag format, for example {\"target\":\"my-template:default\",\"tags\":[\"stable\"]}. Names belong to your organization. Tags move an existing label to this build without rebuilding. Obtain available names from templates.list and tags from templates.tags.list. b<number> names are reserved read-only build aliases and cannot be assigned or deleted as tags. target also accepts name:b<number> to select a ready build by number, for example my-template:b1.",
17343
+ "http": "POST",
17344
+ "path": "/sandbox/v1/templates/tags",
17345
+ "streaming": "no",
17346
+ "pagination": false,
17347
+ "pathParams": [],
17348
+ "query": [],
17349
+ "body": {
17350
+ "required": true,
17351
+ "fields": [
17352
+ {
17353
+ "name": "target",
17354
+ "type": "string",
17355
+ "required": true,
17356
+ "description": "Target template in \"name:tag\" format"
17357
+ },
17358
+ {
17359
+ "name": "tags",
17360
+ "type": "array",
17361
+ "itemType": "string",
17362
+ "required": true,
17363
+ "description": "Tags to assign to the template"
17364
+ }
17365
+ ]
17366
+ }
17367
+ },
17368
+ {
17369
+ "resource": "sandbox.templates",
17370
+ "method": "delete",
17371
+ "summary": "Delete template",
17372
+ "description": "Permanently remove your template, its builds and tag assignments using templateID from templates.create. Active instances prevent deletion with 409; terminate them first. Unknown or other-organization IDs return 404. Snapshot IDs use snapshots.delete instead.",
17373
+ "http": "DELETE",
17374
+ "path": "/sandbox/v1/templates/{templateID}",
17375
+ "streaming": "no",
17376
+ "pagination": false,
17377
+ "pathParams": [
17378
+ {
17379
+ "name": "templateID",
17380
+ "sdkName": "templateID",
17381
+ "description": "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle."
17382
+ }
17383
+ ],
17384
+ "query": []
17385
+ },
17386
+ {
17387
+ "resource": "sandbox.templates",
17388
+ "method": "retrieve",
17389
+ "summary": "List template builds",
17390
+ "description": "Inspect your template and its newest builds using templateID from templates.create. Build states are waiting, building, ready or error. Use limit and the returned x-next-token header to page builds. Unknown or other-organization templates return 404.",
17391
+ "http": "GET",
17392
+ "path": "/sandbox/v1/templates/{templateID}",
17393
+ "streaming": "no",
17394
+ "pagination": false,
17395
+ "pathParams": [
17396
+ {
17397
+ "name": "templateID",
17398
+ "sdkName": "templateID",
17399
+ "description": "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle."
17400
+ }
17401
+ ],
17402
+ "query": [
13932
17403
  {
13933
17404
  "name": "nextToken",
13934
17405
  "type": "string",
@@ -13943,6 +17414,149 @@ export const operations = [
13943
17414
  }
13944
17415
  ]
13945
17416
  },
17417
+ {
17418
+ "resource": "sandbox.templates.builds",
17419
+ "method": "update",
17420
+ "summary": "Start template build (v2)",
17421
+ "description": "Submit source for a waiting build returned by templates.create; returns 202 after queueing, not after successful publication. Unlike E2B, COPY is rejected (use RUN curl or git clone), fromTemplate accepts official catalog names only, and plaintext registry credentials are rejected. The own face also accepts dockerfile, mutually exclusive with fromImage/fromTemplate/steps, and fromImageRegistry vault references for nonofficial images. Poll templates.builds.status.list until ready or error. Example: {\"fromImage\":\"node:22\",\"steps\":[{\"type\":\"RUN\",\"args\":[\"echo hello\"]}]}.",
17422
+ "http": "POST",
17423
+ "path": "/sandbox/v1/templates/{templateID}/builds/{buildID}",
17424
+ "streaming": "no",
17425
+ "pagination": false,
17426
+ "pathParams": [
17427
+ {
17428
+ "name": "templateID",
17429
+ "sdkName": "templateID",
17430
+ "description": "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle."
17431
+ },
17432
+ {
17433
+ "name": "buildID",
17434
+ "sdkName": "buildID",
17435
+ "description": "Build identifier returned by templates.create. It must belong to the selected template in your organization."
17436
+ }
17437
+ ],
17438
+ "query": [],
17439
+ "body": {
17440
+ "required": true,
17441
+ "fields": [
17442
+ {
17443
+ "name": "fromImage",
17444
+ "type": "string",
17445
+ "required": false,
17446
+ "description": "Image to use as a base for the template build"
17447
+ },
17448
+ {
17449
+ "name": "fromTemplate",
17450
+ "type": "string",
17451
+ "required": false,
17452
+ "description": "Template to use as a base for the template build"
17453
+ },
17454
+ {
17455
+ "name": "fromImageRegistry",
17456
+ "type": "object",
17457
+ "required": false,
17458
+ "description": "Registry authentication. Unlike E2B, only the vault reference variant is accepted; plaintext aws, gcp and registry variants return 400. Cannot be used with official templates."
17459
+ },
17460
+ {
17461
+ "name": "force",
17462
+ "type": "boolean",
17463
+ "required": false,
17464
+ "description": "Whether the whole build should be forced to run regardless of the cache"
17465
+ },
17466
+ {
17467
+ "name": "steps",
17468
+ "type": "array",
17469
+ "itemType": "object",
17470
+ "required": false,
17471
+ "description": "List of steps to execute in the template build"
17472
+ },
17473
+ {
17474
+ "name": "startCmd",
17475
+ "type": "string",
17476
+ "required": false,
17477
+ "description": "Start command to execute in the template after the build"
17478
+ },
17479
+ {
17480
+ "name": "readyCmd",
17481
+ "type": "string",
17482
+ "required": false,
17483
+ "description": "Ready check command to execute in the template after the build"
17484
+ },
17485
+ {
17486
+ "name": "dockerfile",
17487
+ "type": "string",
17488
+ "required": false,
17489
+ "description": "Dockerfile text, at most 64 KiB UTF-8. Mutually exclusive with fromImage, fromTemplate and steps. COPY/ADD are rejected; fetch remote content using RUN. Registry credentials require a nonofficial image in the first FROM."
17490
+ }
17491
+ ]
17492
+ }
17493
+ },
17494
+ {
17495
+ "resource": "sandbox.templates.builds.status",
17496
+ "method": "list",
17497
+ "summary": "Template build status",
17498
+ "description": "Poll a build using templateID and buildID from templates.create. waiting means source has not been submitted; building includes queued work; ready permits sandbox creation; error is terminal, with reason when available. logsOffset counts previously read log entries, starting at zero; add logEntries.length after each response. limit is 0–100, default 100. level selects one log level; offsets then count entries at that level. Drain logs until an empty page, including after a terminal status.",
17499
+ "http": "GET",
17500
+ "path": "/sandbox/v1/templates/{templateID}/builds/{buildID}/status",
17501
+ "streaming": "no",
17502
+ "pagination": false,
17503
+ "pathParams": [
17504
+ {
17505
+ "name": "templateID",
17506
+ "sdkName": "templateID",
17507
+ "description": "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle."
17508
+ },
17509
+ {
17510
+ "name": "buildID",
17511
+ "sdkName": "buildID",
17512
+ "description": "Build identifier returned by templates.create. It must belong to the selected template in your organization."
17513
+ }
17514
+ ],
17515
+ "query": [
17516
+ {
17517
+ "name": "logsOffset",
17518
+ "type": "integer",
17519
+ "required": false,
17520
+ "description": "Index of the starting build log that should be returned with the template"
17521
+ },
17522
+ {
17523
+ "name": "limit",
17524
+ "type": "integer",
17525
+ "required": false,
17526
+ "description": "Maximum number of logs that should be returned"
17527
+ },
17528
+ {
17529
+ "name": "level",
17530
+ "type": "string",
17531
+ "enum": [
17532
+ "debug",
17533
+ "info",
17534
+ "warn",
17535
+ "error"
17536
+ ],
17537
+ "required": false,
17538
+ "description": "Select one exact log severity: debug for diagnostics, info for progress, warn for warnings, error for failures. Offsets count matching entries."
17539
+ }
17540
+ ]
17541
+ },
17542
+ {
17543
+ "resource": "sandbox.templates.tags",
17544
+ "method": "list",
17545
+ "summary": "List template tags",
17546
+ "description": "Read the tag-to-build assignments for your template using templateID from templates.create. Only ready builds acquire tags. Use a returned tag with the template name as name:tag when creating a sandbox or assigning additional tags. Foreign IDs return 404.",
17547
+ "http": "GET",
17548
+ "path": "/sandbox/v1/templates/{templateID}/tags",
17549
+ "streaming": "no",
17550
+ "pagination": false,
17551
+ "pathParams": [
17552
+ {
17553
+ "name": "templateID",
17554
+ "sdkName": "templateID",
17555
+ "description": "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle."
17556
+ }
17557
+ ],
17558
+ "query": []
17559
+ },
13946
17560
  {
13947
17561
  "resource": "sandbox.volumes",
13948
17562
  "method": "list",
@@ -15102,7 +18716,7 @@ export const operations = [
15102
18716
  "resource": "ticket.milestones",
15103
18717
  "method": "create",
15104
18718
  "summary": "Create or add milestones",
15105
- "description": "Create or add milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
18719
+ "description": "Create or add milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
15106
18720
  "http": "POST",
15107
18721
  "path": "/ticket/v1/milestones",
15108
18722
  "streaming": "no",
@@ -15154,7 +18768,7 @@ export const operations = [
15154
18768
  "resource": "ticket.milestones",
15155
18769
  "method": "delete",
15156
18770
  "summary": "Remove milestones",
15157
- "description": "Remove milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
18771
+ "description": "Remove milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
15158
18772
  "http": "DELETE",
15159
18773
  "path": "/ticket/v1/milestones/{number}",
15160
18774
  "streaming": "no",
@@ -15206,7 +18820,7 @@ export const operations = [
15206
18820
  "resource": "ticket.milestones",
15207
18821
  "method": "update",
15208
18822
  "summary": "Update milestones",
15209
- "description": "Update milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Organization owner or admin authority is required for this write; API keys without role information act as members.",
18823
+ "description": "Update milestones within the authenticated organization. Obtain resource identifiers from the corresponding list or create response. Writes complete synchronously; read the returned resource to observe the result. Service authorization applies to the verified human subject.",
15210
18824
  "http": "PATCH",
15211
18825
  "path": "/ticket/v1/milestones/{number}",
15212
18826
  "streaming": "no",
@@ -16617,7 +20231,7 @@ export const operations = [
16617
20231
  "resource": "vault.vaults.secrets",
16618
20232
  "method": "create",
16619
20233
  "summary": "Create secret",
16620
- "description": "Store a manually supplied token in an active vault for use on requests to its allowed_hosts. Unlike Anthropic credentials, this native operation takes name, value and allowed_hosts directly and creates only static secrets; use praxis.vault.authorizations.create for OAuth. Its name must be unused by any non-archived secret in that vault; the response contains metadata but never the supplied value. Application praxis_vault_ref bindings declare vault_id and secret (the secret name), but currently return 501; do not copy the value into a plain-text binding or metadata as a substitute.",
20234
+ "description": "Store a manually supplied token in an active vault. Omit allowed_hosts for name-based resolution only; host-based redemption never matches an empty host list. Unlike Anthropic credentials, this native operation takes name and value directly, with optional allowed_hosts and creates only static secrets; use praxis.vault.authorizations.create for OAuth. Its name must be unused by any non-archived secret in that vault; the response contains metadata but never the supplied value. Application praxis_vault_ref bindings declare vault_id and secret (the secret name), but currently return 501; do not copy the value into a plain-text binding or metadata as a substitute.",
16621
20235
  "http": "POST",
16622
20236
  "path": "/vault/v1/vaults/{vault_id}/secrets",
16623
20237
  "streaming": "no",
@@ -16649,8 +20263,8 @@ export const operations = [
16649
20263
  "name": "allowed_hosts",
16650
20264
  "type": "array",
16651
20265
  "itemType": "string",
16652
- "required": true,
16653
- "description": "Allowed destinations for the secret. Unlike Anthropic's unrestricted networking option, an explicit allowlist is required. Supply 1–16 bare domain names, dotted-decimal IPv4 addresses or leading *. domain wildcards. A wildcard matches subdomains, not the domain itself. URLs, ports, paths, IPv6, local/private and platform hosts are rejected. Entries are lowercased, one trailing dot is removed, internationalized domains use Punycode, and duplicates are removed."
20266
+ "required": false,
20267
+ "description": "Allowed destinations for the secret. Omitting allowed_hosts on creation stores an empty list for name-based resolution only: host-based redemption never matches. When supplied, list 1–16 bare domain names, dotted-decimal IPv4 addresses or leading *. domain wildcards. A wildcard matches subdomains, not the domain itself. URLs, ports, paths, IPv6, local/private and platform hosts are rejected. Entries are lowercased, one trailing dot is removed, internationalized domains use Punycode, and duplicates are removed."
16654
20268
  },
16655
20269
  {
16656
20270
  "name": "description",
@@ -16674,7 +20288,7 @@ export const operations = [
16674
20288
  "stripe"
16675
20289
  ],
16676
20290
  "required": false,
16677
- "description": "Static template ID from List templates. Records metadata.template; name, value and allowed_hosts must still be supplied explicitly."
20291
+ "description": "Static template ID from List templates. Records metadata.template; name and value must still be supplied explicitly; allowed_hosts is optional."
16678
20292
  },
16679
20293
  {
16680
20294
  "name": "kind",
@@ -16770,7 +20384,7 @@ export const operations = [
16770
20384
  "type": "array",
16771
20385
  "itemType": "string",
16772
20386
  "required": false,
16773
- "description": "Allowed destinations for the secret. Unlike Anthropic's unrestricted networking option, an explicit allowlist is required. Supply 1–16 bare domain names, dotted-decimal IPv4 addresses or leading *. domain wildcards. A wildcard matches subdomains, not the domain itself. URLs, ports, paths, IPv6, local/private and platform hosts are rejected. Entries are lowercased, one trailing dot is removed, internationalized domains use Punycode, and duplicates are removed."
20387
+ "description": "Allowed destinations for the secret. Omitting allowed_hosts on creation stores an empty list for name-based resolution only: host-based redemption never matches. When supplied, list 1–16 bare domain names, dotted-decimal IPv4 addresses or leading *. domain wildcards. A wildcard matches subdomains, not the domain itself. URLs, ports, paths, IPv6, local/private and platform hosts are rejected. Entries are lowercased, one trailing dot is removed, internationalized domains use Punycode, and duplicates are removed."
16774
20388
  },
16775
20389
  {
16776
20390
  "name": "description",
@@ -16874,7 +20488,7 @@ export const operations = [
16874
20488
  "resource": "vault.vaults.secrets",
16875
20489
  "method": "import",
16876
20490
  "summary": "Import secrets",
16877
- "description": "Import lines or dotenv text into an active vault, reporting success or failure for each entry. Existing names have their values replaced; their hosts change only when that line supplies allowed_hosts. Shared hosts apply only to newly created secrets.",
20491
+ "description": "Import lines or dotenv text into an active vault, reporting success or failure for each entry. Existing names have their values replaced; their hosts change only when that line supplies allowed_hosts. Shared hosts apply only to newly created secrets; if neither shared nor per-line hosts are supplied, new secrets use an empty host list for name-based resolution only.",
16878
20492
  "http": "POST",
16879
20493
  "path": "/vault/v1/vaults/{vault_id}/secrets:import",
16880
20494
  "streaming": "no",