@laburen/delta-cli 0.0.0-stage → 0.2.0-canary.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +33 -2
- package/dist/bin.d.ts +2 -0
- package/dist/bin.js +20 -0
- package/dist/bin.js.map +1 -0
- package/dist/commands/agent-checks.d.ts +5 -0
- package/dist/commands/agent-checks.js +69 -0
- package/dist/commands/agent-checks.js.map +1 -0
- package/dist/commands/agent-run/body.d.ts +22 -0
- package/dist/commands/agent-run/body.js +88 -0
- package/dist/commands/agent-run/body.js.map +1 -0
- package/dist/commands/agent-run/render.d.ts +50 -0
- package/dist/commands/agent-run/render.js +281 -0
- package/dist/commands/agent-run/render.js.map +1 -0
- package/dist/commands/agent-run.d.ts +10 -0
- package/dist/commands/agent-run.js +243 -0
- package/dist/commands/agent-run.js.map +1 -0
- package/dist/commands/agent-tools/add.d.ts +5 -0
- package/dist/commands/agent-tools/add.js +101 -0
- package/dist/commands/agent-tools/add.js.map +1 -0
- package/dist/commands/agent-tools/remove.d.ts +5 -0
- package/dist/commands/agent-tools/remove.js +126 -0
- package/dist/commands/agent-tools/remove.js.map +1 -0
- package/dist/commands/agent-tools/shared.d.ts +283 -0
- package/dist/commands/agent-tools/shared.js +107 -0
- package/dist/commands/agent-tools/shared.js.map +1 -0
- package/dist/commands/agent-tools.d.ts +5 -0
- package/dist/commands/agent-tools.js +11 -0
- package/dist/commands/agent-tools.js.map +1 -0
- package/dist/commands/auth.d.ts +14 -0
- package/dist/commands/auth.js +171 -0
- package/dist/commands/auth.js.map +1 -0
- package/dist/commands/completion.d.ts +4 -0
- package/dist/commands/completion.js +50 -0
- package/dist/commands/completion.js.map +1 -0
- package/dist/commands/config-sources.d.ts +22 -0
- package/dist/commands/config-sources.js +46 -0
- package/dist/commands/config-sources.js.map +1 -0
- package/dist/commands/config-wizard.d.ts +9 -0
- package/dist/commands/config-wizard.js +332 -0
- package/dist/commands/config-wizard.js.map +1 -0
- package/dist/commands/orgs.d.ts +11 -0
- package/dist/commands/orgs.js +193 -0
- package/dist/commands/orgs.js.map +1 -0
- package/dist/commands/skill-dir.d.ts +18 -0
- package/dist/commands/skill-dir.js +101 -0
- package/dist/commands/skill-dir.js.map +1 -0
- package/dist/commands/token-notice.d.ts +4 -0
- package/dist/commands/token-notice.js +13 -0
- package/dist/commands/token-notice.js.map +1 -0
- package/dist/commands/whoami.d.ts +8 -0
- package/dist/commands/whoami.js +38 -0
- package/dist/commands/whoami.js.map +1 -0
- package/dist/commands/wizards.d.ts +4 -0
- package/dist/commands/wizards.js +210 -0
- package/dist/commands/wizards.js.map +1 -0
- package/dist/completion/bash.d.ts +3 -0
- package/dist/completion/bash.js +60 -0
- package/dist/completion/bash.js.map +1 -0
- package/dist/completion/files.d.ts +35 -0
- package/dist/completion/files.js +178 -0
- package/dist/completion/files.js.map +1 -0
- package/dist/completion/powershell.d.ts +9 -0
- package/dist/completion/powershell.js +83 -0
- package/dist/completion/powershell.js.map +1 -0
- package/dist/completion/tree.d.ts +25 -0
- package/dist/completion/tree.js +53 -0
- package/dist/completion/tree.js.map +1 -0
- package/dist/completion/zsh.d.ts +3 -0
- package/dist/completion/zsh.js +76 -0
- package/dist/completion/zsh.js.map +1 -0
- package/dist/config/auth.d.ts +26 -0
- package/dist/config/auth.js +223 -0
- package/dist/config/auth.js.map +1 -0
- package/dist/config/link.d.ts +16 -0
- package/dist/config/link.js +93 -0
- package/dist/config/link.js.map +1 -0
- package/dist/config/paths.d.ts +3 -0
- package/dist/config/paths.js +20 -0
- package/dist/config/paths.js.map +1 -0
- package/dist/config/settings.d.ts +8 -0
- package/dist/config/settings.js +24 -0
- package/dist/config/settings.js.map +1 -0
- package/dist/confirm.d.ts +35 -0
- package/dist/confirm.js +51 -0
- package/dist/confirm.js.map +1 -0
- package/dist/context.d.ts +29 -0
- package/dist/context.js +16 -0
- package/dist/context.js.map +1 -0
- package/dist/errors.d.ts +54 -0
- package/dist/errors.js +413 -0
- package/dist/errors.js.map +1 -0
- package/dist/generated/commands.d.ts +49 -0
- package/dist/generated/commands.js +52 -0
- package/dist/generated/commands.js.map +1 -0
- package/dist/generated/schemas.d.ts +5 -0
- package/dist/generated/schemas.js +20 -0
- package/dist/generated/schemas.js.map +1 -0
- package/dist/invocation.d.ts +64 -0
- package/dist/invocation.js +341 -0
- package/dist/invocation.js.map +1 -0
- package/dist/mode.d.ts +17 -0
- package/dist/mode.js +22 -0
- package/dist/mode.js.map +1 -0
- package/dist/operations/call.d.ts +6 -0
- package/dist/operations/call.js +17 -0
- package/dist/operations/call.js.map +1 -0
- package/dist/operations/extensions.d.ts +46 -0
- package/dist/operations/extensions.js +29 -0
- package/dist/operations/extensions.js.map +1 -0
- package/dist/operations/json-input.d.ts +7 -0
- package/dist/operations/json-input.js +50 -0
- package/dist/operations/json-input.js.map +1 -0
- package/dist/operations/params.d.ts +17 -0
- package/dist/operations/params.js +106 -0
- package/dist/operations/params.js.map +1 -0
- package/dist/operations/register.d.ts +10 -0
- package/dist/operations/register.js +102 -0
- package/dist/operations/register.js.map +1 -0
- package/dist/operations/run-operation.d.ts +8 -0
- package/dist/operations/run-operation.js +148 -0
- package/dist/operations/run-operation.js.map +1 -0
- package/dist/operations/schema-flag.d.ts +8 -0
- package/dist/operations/schema-flag.js +12 -0
- package/dist/operations/schema-flag.js.map +1 -0
- package/dist/operations/skeleton.d.ts +16 -0
- package/dist/operations/skeleton.js +116 -0
- package/dist/operations/skeleton.js.map +1 -0
- package/dist/operations/tables.d.ts +7 -0
- package/dist/operations/tables.js +131 -0
- package/dist/operations/tables.js.map +1 -0
- package/dist/operations.d.ts +5 -0
- package/dist/operations.js +7 -0
- package/dist/operations.js.map +1 -0
- package/dist/output.d.ts +33 -0
- package/dist/output.js +321 -0
- package/dist/output.js.map +1 -0
- package/dist/pickers.d.ts +51 -0
- package/dist/pickers.js +277 -0
- package/dist/pickers.js.map +1 -0
- package/dist/program.d.ts +31 -0
- package/dist/program.js +260 -0
- package/dist/program.js.map +1 -0
- package/dist/prompter.d.ts +54 -0
- package/dist/prompter.js +129 -0
- package/dist/prompter.js.map +1 -0
- package/dist/session.d.ts +45 -0
- package/dist/session.js +170 -0
- package/dist/session.js.map +1 -0
- package/dist/stdout-policy.d.ts +4 -0
- package/dist/stdout-policy.js +11 -0
- package/dist/stdout-policy.js.map +1 -0
- package/dist/update-check.d.ts +4 -0
- package/dist/update-check.js +60 -0
- package/dist/update-check.js.map +1 -0
- package/docs/SKILL.md +175 -0
- package/docs/references/auth-and-organizations.md +72 -0
- package/docs/references/commands.md +217 -0
- package/docs/references/output-and-errors.md +105 -0
- package/package.json +39 -5
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
// GENERADO por scripts/generate-commands.mjs a partir de ../delta-sdk/contract/openapi.json. No editar a mano.
|
|
2
|
+
/** Por operación con body: el JSON Schema de lo que se manda y de la respuesta, con los `$ref` ya resueltos. */
|
|
3
|
+
export const OPERATION_SCHEMAS = {
|
|
4
|
+
"agents.create": { "body": { "additionalProperties": false, "properties": { "activate": { "description": "Whether to make the new version the active one. Requires config. Defaults to true.", "type": "boolean" }, "config": { "additionalProperties": false, "description": "Config of the first version. When omitted, no version is created.", "properties": { "$schema": { "description": "JSON Schema URL for editors. Accepted and ignored; never stored.", "type": "string" }, "attachments": { "additionalProperties": false, "description": "How the agent handles files sent by the user.", "properties": { "access": { "const": "inline", "default": "inline", "description": "How the model reads attachments. Only `inline` is supported.", "type": "string" }, "allow_reread": { "default": true, "description": "Whether the model can read an attachment again after the turn it arrived in.", "type": "boolean" }, "keep_in_history": { "default": false, "description": "Whether attachments stay in the history of later turns.", "type": "boolean" }, "max_tokens_per_attachment": { "default": 30000, "description": "Token limit for each attachment.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "max_tokens_per_message": { "default": 90000, "description": "Token limit for all the attachments of one message.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "type": "object" }, "history": { "additionalProperties": false, "description": "How much of the conversation is sent to the model on each turn.", "properties": { "exchanges": { "default": 5, "description": "How many previous user/agent exchanges are sent to the model (1 to 12).", "maximum": 12, "minimum": 1, "type": "integer" }, "reasoning": { "description": "Whether past reasoning is sent back to the model.", "type": "boolean" }, "tool_calls": { "anyOf": [{ "additionalProperties": false, "description": "Tool calls are not kept in the history.", "properties": { "mode": { "const": "off", "description": "Tool calls are not kept.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": false, "description": "Tool calls of every exchange in the history are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "all", "description": "Keep the tool calls of every exchange.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": false, "description": "Only tool calls of the latest exchanges are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "recent", "description": "Keep the tool calls of the latest exchanges only.", "type": "string" }, "turns": { "description": "How many of the latest exchanges keep their tool calls.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "required": ["mode", "turns"], "type": "object" }], "default": { "mode": "off" }, "description": "Which tool calls are kept in the history. Defaults to `off`." } }, "type": "object" }, "knowledge": { "additionalProperties": false, "description": "Knowledge the agent can search to answer.", "properties": { "mode": { "description": "How the knowledge is searched. Only `vector` is supported.", "enum": ["vector"], "type": "string" }, "project_ids": { "description": "Knowledge projects the agent can search. Each id is the id of a knowledge project of the organization.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "model": { "additionalProperties": false, "description": "The model the agent runs on.", "properties": { "id": { "description": "Model id; one of the offered models.", "pattern": "\\S", "type": "string" }, "reasoning_effort": { "description": "How much the model reasons before answering; must be one of the reasoning levels of the chosen model. When omitted, the model default applies.", "enum": ["off", "low", "medium", "high", "max"], "type": "string" } }, "required": ["id"], "type": "object" }, "prompt": { "description": "System prompt, as a list of blocks that are joined in order.", "items": { "additionalProperties": false, "description": "A prompt block.", "properties": { "content": { "description": "Text of the block.", "type": "string" }, "type": { "const": "text", "description": "Block type. Only `text` is supported.", "type": "string" } }, "required": ["type", "content"], "type": "object" }, "type": "array" }, "tools": { "description": "Tools the model can call. Each non-http tool type at most once; thinking only when the model does not reason (see the reasoning levels of the model) or reasoning_effort is off.", "items": { "anyOf": [{ "additionalProperties": false, "description": "Calls an HTTP endpoint.", "properties": { "body": { "description": "Fields of the request body. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"city\", \"value\": \"Madrid\", \"description\": \"City to look up\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "description": { "description": "Tells the model when to use the tool.", "type": "string" }, "headers": { "description": "Headers sent on every call. Each item is an object `{ key, value, description? }`, not a string; for example `[{ \"key\": \"Authorization\", \"value\": \"Bearer abc\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "method": { "description": "HTTP method. Defaults to GET.", "enum": ["GET", "POST", "PUT", "DELETE", "PATCH"], "type": "string" }, "name": { "description": "Name the model sees for the tool.", "type": "string" }, "path_variables": { "description": "Values for the `{name}` placeholders of the url. Each item is an object `{ key, value, description? }` where `key` is the placeholder name; for example `[{ \"key\": \"id\", \"value\": \"123\", \"description\": \"Order id\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "query_parameters": { "description": "Query parameters of the request. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"page\", \"value\": \"1\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "type": { "const": "http", "description": "Tool type: `http`.", "type": "string" }, "url": { "description": "URL the tool calls. Path variables are written as `{name}`.", "type": "string" }, "with_approval": { "description": "Whether a person must approve each call.", "type": "boolean" } }, "required": ["type", "url"], "type": "object" }, { "additionalProperties": false, "description": "Lets the model write down its reasoning before answering. Only for models that do not reason.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "instructions": { "description": "Extra instructions for how the model should think.", "type": "string" }, "max_thoughts": { "description": "Maximum number of thoughts per turn.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "type": { "const": "thinking", "description": "Tool type: `thinking`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": false, "description": "Lets the model send files to the user.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "send_files", "description": "Tool type: `send_files`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": false, "description": "Lets the model hand the conversation to a person.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "request_human", "description": "Tool type: `request_human`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }] }, "type": "array" } }, "required": ["model"], "type": "object" }, "description": { "default": "", "description": "What the agent is for. Defaults to an empty string.", "type": "string" }, "harness_type": { "const": "mastra", "description": "Runtime of the agent. Only `mastra` can be created through this API.", "type": "string" }, "mcp_connections": { "description": "MCP connections to assign. Requires config. Each connection_id is the id of an MCP connection of the organization.", "items": { "additionalProperties": false, "description": "An MCP connection to assign to the agent.", "properties": { "connection_id": { "description": "Id of the MCP connection to assign.", "minLength": 1, "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "tools": { "description": "Names of the connection tools the agent can use; when omitted or empty, all of them. Use the `name` field of each tool the connection offers (not `agent_tool_name`). Validated at save: an unknown name is rejected and lists the valid ones.", "items": { "type": "string" }, "type": "array" }, "version_id": { "description": "Version of the connection to pin. Used when the strategy is `pin`.", "minLength": 1, "type": "string" } }, "required": ["connection_id"], "type": "object" }, "type": "array" }, "name": { "description": "Name of the agent.", "minLength": 1, "type": "string" }, "skills": { "description": "Skills to assign. Requires config. Each skill_id is the id of a skill of the organization.", "items": { "additionalProperties": false, "description": "A skill to assign to the agent.", "properties": { "skill_id": { "description": "Id of the skill to assign.", "minLength": 1, "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "version_id": { "description": "Version of the skill to pin. Used when the strategy is `pin`.", "minLength": 1, "type": "string" } }, "required": ["skill_id"], "type": "object" }, "type": "array" } }, "required": ["harness_type", "name"], "type": "object" }, "response": { "properties": { "active_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the version that is running; `null` when none is active." }, "created_at": { "description": "When the agent was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "description": { "description": "What the agent is for.", "type": "string" }, "harness_type": { "description": "Runtime the agent runs on. Agents created through this API are `mastra`.", "enum": ["legacy", "mastra"], "type": "string" }, "id": { "description": "Id of the agent.", "type": "string" }, "name": { "description": "Name of the agent.", "type": "string" }, "type": { "const": "agent", "description": "Object type, always `agent`.", "type": "string" }, "updated_at": { "description": "When the agent was last changed (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "version": { "anyOf": [{ "properties": { "agent_id": { "description": "Id of the agent this version belongs to.", "type": "string" }, "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Config paths that changed compared with the previous version.", "items": { "type": "string" }, "type": "array" }, "config": { "additionalProperties": {}, "description": "Config of an agent version.", "properties": { "attachments": { "additionalProperties": {}, "description": "How the agent handles files sent by the user.", "properties": { "access": { "const": "inline", "default": "inline", "description": "How the model reads attachments. Only `inline` is supported.", "type": "string" }, "allow_reread": { "default": true, "description": "Whether the model can read an attachment again after the turn it arrived in.", "type": "boolean" }, "keep_in_history": { "default": false, "description": "Whether attachments stay in the history of later turns.", "type": "boolean" }, "max_tokens_per_attachment": { "default": 30000, "description": "Token limit for each attachment.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "max_tokens_per_message": { "default": 90000, "description": "Token limit for all the attachments of one message.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "type": "object" }, "history": { "additionalProperties": {}, "description": "How much of the conversation is sent to the model on each turn.", "properties": { "exchanges": { "default": 5, "description": "How many previous user/agent exchanges are sent to the model (1 to 12).", "maximum": 12, "minimum": 1, "type": "integer" }, "reasoning": { "description": "Whether past reasoning is sent back to the model.", "type": "boolean" }, "tool_calls": { "anyOf": [{ "additionalProperties": {}, "description": "Tool calls are not kept in the history.", "properties": { "mode": { "const": "off", "description": "Tool calls are not kept.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": {}, "description": "Tool calls of every exchange in the history are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "all", "description": "Keep the tool calls of every exchange.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": {}, "description": "Only tool calls of the latest exchanges are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "recent", "description": "Keep the tool calls of the latest exchanges only.", "type": "string" }, "turns": { "description": "How many of the latest exchanges keep their tool calls.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "required": ["mode", "turns"], "type": "object" }], "default": { "mode": "off" }, "description": "Which tool calls are kept in the history. Defaults to `off`." } }, "type": "object" }, "knowledge": { "additionalProperties": {}, "description": "Knowledge the agent can search to answer.", "properties": { "mode": { "description": "How the knowledge is searched. Only `vector` is supported.", "enum": ["vector"], "type": "string" }, "project_ids": { "description": "Knowledge projects the agent can search. Each id is the id of a knowledge project of the organization.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "model": { "additionalProperties": {}, "description": "The model the agent runs on.", "properties": { "id": { "description": "Model id; one of the offered models.", "type": "string" }, "reasoning_effort": { "description": "How much the model reasons before answering; must be one of the reasoning levels of the chosen model. When omitted, the model default applies.", "enum": ["off", "low", "medium", "high", "max"], "type": "string" } }, "required": ["id"], "type": "object" }, "prompt": { "description": "System prompt, as a list of blocks that are joined in order.", "items": {}, "type": "array" }, "tools": { "description": "Tools the model can call. Each non-http tool type at most once; thinking only when the model does not reason (see the reasoning levels of the model) or reasoning_effort is off.", "items": { "anyOf": [{ "additionalProperties": {}, "description": "Calls an HTTP endpoint.", "properties": { "body": { "description": "Fields of the request body. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"city\", \"value\": \"Madrid\", \"description\": \"City to look up\" }]`.", "items": {}, "type": "array" }, "description": { "description": "Tells the model when to use the tool.", "type": "string" }, "headers": { "description": "Headers sent on every call. Each item is an object `{ key, value, description? }`, not a string; for example `[{ \"key\": \"Authorization\", \"value\": \"Bearer abc\" }]`.", "items": {}, "type": "array" }, "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "method": { "description": "HTTP method. Defaults to GET.", "type": "string" }, "name": { "description": "Name the model sees for the tool." }, "path_variables": { "description": "Values for the `{name}` placeholders of the url. Each item is an object `{ key, value, description? }` where `key` is the placeholder name; for example `[{ \"key\": \"id\", \"value\": \"123\", \"description\": \"Order id\" }]`.", "items": {}, "type": "array" }, "query_parameters": { "description": "Query parameters of the request. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"page\", \"value\": \"1\" }]`.", "items": {}, "type": "array" }, "type": { "const": "http", "description": "Tool type: `http`.", "type": "string" }, "url": { "description": "URL the tool calls. Path variables are written as `{name}`.", "type": "string" }, "with_approval": { "description": "Whether a person must approve each call." } }, "required": ["type", "url"], "type": "object" }, { "additionalProperties": {}, "description": "Lets the model write down its reasoning before answering. Only for models that do not reason.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "instructions": { "description": "Extra instructions for how the model should think.", "type": "string" }, "max_thoughts": { "description": "Maximum number of thoughts per turn.", "type": "number" }, "type": { "const": "thinking", "description": "Tool type: `thinking`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": {}, "description": "Lets the model send files to the user.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "send_files", "description": "Tool type: `send_files`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": {}, "description": "Lets the model hand the conversation to a person.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "request_human", "description": "Tool type: `request_human`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }] }, "type": "array" } }, "type": "object" }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "harness_type": { "description": "Runtime the version runs on.", "enum": ["legacy", "mastra"], "type": "string" }, "id": { "description": "Id of the version.", "type": "string" }, "is_active": { "description": "Whether this is the version that is running.", "type": "boolean" }, "mcp_connections": { "description": "MCP connections assigned to this version.", "items": { "description": "An MCP connection assigned to the agent.", "properties": { "connection_id": { "description": "Id of the assigned MCP connection.", "type": "string" }, "pinned_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Version of the connection in use when the strategy is `pin`; `null` otherwise." }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "tools": { "description": "Server tool names of the connection the agent can use (the `name` field of each tool the connection offers); empty means all of them.", "items": { "type": "string" }, "type": "array" } }, "required": ["connection_id", "strategy", "pinned_version_id", "tools"], "type": "object" }, "type": "array" }, "skills": { "description": "Skills assigned to this version.", "items": { "description": "A skill assigned to the agent.", "properties": { "pinned_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Version of the skill in use when the strategy is `pin`; `null` otherwise." }, "skill_id": { "description": "Id of the assigned skill.", "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" } }, "required": ["skill_id", "strategy", "pinned_version_id"], "type": "object" }, "type": "array" }, "type": { "const": "agent_version", "description": "Object type, always `agent_version`.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "warnings": { "description": "Present only on the response of the call that created the version, and only when there is something to note: something saved without verification (`mcp_tools_unverified`) or a version identical to the latest one (`no_changes`).", "items": { "description": "A note about a version that was saved: something saved without being verified, or a version identical to the latest one.", "properties": { "code": { "description": "`mcp_tools_unverified`: the MCP server could not be reached, so the tool names of this connection were saved without checking. `no_changes`: the new version is identical to the latest one.", "enum": ["mcp_tools_unverified", "no_changes"], "type": "string" }, "connection_id": { "description": "Id of the MCP connection that could not be reached; only on `mcp_tools_unverified`.", "type": "string" }, "message": { "description": "What happened and what to do about it: what could not be checked and how to check it (`mcp_tools_unverified`), or that the new version is identical to the latest one (`no_changes`).", "type": "string" } }, "required": ["code", "message"], "type": "object" }, "type": "array" } }, "required": ["type", "id", "agent_id", "version_number", "harness_type", "config", "skills", "mcp_connections", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" }, { "type": "null" }], "description": "The version this call created; `null` when it did not create one." } }, "required": ["type", "id", "name", "description", "harness_type", "active_version_id", "created_at", "updated_at", "version"], "type": "object" } },
|
|
5
|
+
"agents.generate": { "body": { "additionalProperties": false, "properties": { "contact": { "additionalProperties": false, "description": "Profile of the end user, used only when `memory.resource` creates a new contact.", "properties": { "email": { "description": "Email of the end user. If another contact of the organization already uses it, the contact is created without it.", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "type": "string" }, "first_name": { "description": "First name of the end user.", "type": "string" }, "last_name": { "description": "Last name of the end user.", "type": "string" }, "phone_number": { "description": "Phone number of the end user. If another contact of the organization already uses it, the contact is created without it.", "type": "string" } }, "type": "object" }, "context": { "description": "Extra texts the model should know in this run. They are joined with a blank line and put before the message.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "instructions": { "description": "Replaces the prompt of the agent for this run only. Requires the `write` permission.", "minLength": 1, "type": "string" }, "max_steps": { "default": 80, "description": "Maximum number of model steps in the run (1 to 200). Requires the `write` permission.", "maximum": 200, "minimum": 1, "type": "integer" }, "memory": { "additionalProperties": false, "description": "Which conversation the turn belongs to and who the end user is.", "properties": { "resource": { "description": "Your own id for the end user (for example a customer id). The server creates or reuses the contact of that user.", "maxLength": 255, "minLength": 1, "type": "string" }, "thread": { "description": "A conversation id returned by a previous run; omit it to start a new conversation. It must belong to this agent.", "minLength": 1, "type": "string" } }, "type": "object" }, "messages": { "anyOf": [{ "minLength": 1, "type": "string" }, { "items": { "description": "A message of the user.", "properties": { "parts": { "description": "Content of the message: text parts and file parts, in order. Text parts are joined with a blank line.", "items": { "anyOf": [{ "description": "A piece of text of the message.", "properties": { "text": { "description": "The text of the part.", "type": "string" }, "type": { "const": "text", "description": "Part type, always `text`.", "type": "string" } }, "required": ["type", "text"], "type": "object" }, { "description": "A file attached to the message.", "properties": { "filename": { "description": "Name of the file. If omitted, the last segment of the URL is used.", "type": "string" }, "media_type": { "description": "MIME type of the file, for example `application/pdf` or `image/png`.", "minLength": 1, "type": "string" }, "type": { "const": "file", "description": "Part type, always `file`.", "type": "string" }, "url": { "description": "Public `https` URL of the file. The server downloads it before the turn starts; the file can be up to 20 MB.", "format": "uri", "type": "string" } }, "required": ["type", "url", "media_type"], "type": "object" }] }, "minItems": 1, "type": "array" }, "role": { "const": "user", "description": "Author of the message, always `user`.", "type": "string" } }, "required": ["role", "parts"], "type": "object" }, "minItems": 1, "type": "array" }], "description": "What the user says: a plain string, or a list of user messages with text and file parts. The text of all the parts is joined with a blank line. A message with files and no text is valid; one with neither is rejected." }, "model": { "description": "Replaces the model of the agent for this run only. It must be one of the offered models. Requires the `write` permission.", "minLength": 1, "type": "string" }, "model_settings": { "additionalProperties": false, "description": "Model settings for this run only. Only `reasoning` is accepted; any other key is rejected. Requires the `write` permission.", "properties": { "reasoning": { "description": "Reasoning effort for this run. It must be a level the model supports. Requires the `write` permission.", "enum": ["off", "low", "medium", "high", "max"], "type": "string" } }, "type": "object" }, "versions": { "additionalProperties": false, "description": "Runs a specific version instead of the active one. Needs only the `query` permission.", "properties": { "agents": { "additionalProperties": { "additionalProperties": false, "description": "The version to run.", "properties": { "version_id": { "description": "Id of the version to run. A version of this agent.", "minLength": 1, "type": "string" } }, "required": ["version_id"], "type": "object" }, "description": "Versions to run, keyed by agent id. The only key allowed is the agent being called.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": ["agents"], "type": "object" } }, "required": ["messages"], "type": "object" }, "response": { "properties": { "cost": { "anyOf": [{ "type": "number" }, { "type": "null" }], "description": "Credits the run cost; `null` when it was not charged." }, "files": { "description": "Files the agent sent in the run.", "items": { "description": "A file the agent sent.", "properties": { "media_type": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "MIME type of the file." }, "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Name of the file." }, "url": { "description": "URL of the file.", "type": "string" } }, "required": ["url", "media_type", "name"], "type": "object" }, "type": "array" }, "finish_reason": { "description": "Why the run ended.", "enum": ["stop", "length", "content-filter", "tool-calls", "error", "other"], "type": "string" }, "handoff": { "description": "Whether the agent asked to hand the conversation to a person.", "type": "boolean" }, "memory": { "description": "The conversation the run belongs to.", "properties": { "resource": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The `memory.resource` of the request; `null` when it was not sent." }, "thread": { "description": "Id of the conversation. Send it as `memory.thread` to continue it.", "type": "string" } }, "required": ["thread", "resource"], "type": "object" }, "message_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the stored message with the answer; `null` when nothing was stored." }, "reasoning_text": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Reasoning of the model, if it produced any; `null` otherwise." }, "run_id": { "description": "Id of the run.", "type": "string" }, "sources": { "description": "Knowledge sources the answer used.", "items": { "description": "A knowledge source the answer used.", "properties": { "chunk_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the chunk that was cited." }, "datasource_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the datasource the chunk comes from." }, "datasource_name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Name of the datasource." }, "datastore_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the datastore the chunk comes from." }, "mime_type": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "MIME type of the source." }, "score": { "anyOf": [{ "type": "number" }, { "type": "null" }], "description": "Relevance score of the chunk." }, "source_url": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "URL of the source." } }, "required": ["chunk_id", "datastore_id", "datasource_id", "datasource_name", "source_url", "mime_type", "score"], "type": "object" }, "type": "array" }, "text": { "description": "The answer of the agent.", "type": "string" }, "tool_calls": { "description": "Every tool the model called in the run.", "items": { "description": "A tool call of the run.", "properties": { "args": { "description": "Arguments the model sent to the tool." }, "tool_call_id": { "description": "Id of the tool call.", "type": "string" }, "tool_name": { "description": "Name of the tool the model called.", "type": "string" } }, "required": ["tool_call_id", "tool_name", "args"], "type": "object" }, "type": "array" }, "tool_results": { "description": "The result of each tool call that finished.", "items": { "description": "The result of a tool call.", "properties": { "is_error": { "description": "Whether the tool failed.", "type": "boolean" }, "result": { "description": "What the tool returned, or its error message when it failed." }, "tool_call_id": { "description": "Id of the tool call this result belongs to.", "type": "string" }, "tool_name": { "description": "Name of the tool.", "type": "string" } }, "required": ["tool_call_id", "tool_name", "result", "is_error"], "type": "object" }, "type": "array" }, "total_usage": { "description": "Tokens used, summed over the steps of the run.", "properties": { "cached_input_tokens": { "description": "Input tokens served from cache, of all the steps.", "type": "number" }, "input_tokens": { "description": "Input tokens of all the steps.", "type": "number" }, "output_tokens": { "description": "Output tokens of all the steps.", "type": "number" }, "reasoning_tokens": { "description": "Reasoning tokens of all the steps.", "type": "number" } }, "required": ["input_tokens", "output_tokens", "cached_input_tokens", "reasoning_tokens"], "type": "object" }, "trace_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the trace of the run in the observability tool; `null` when there is none." }, "type": { "const": "agent_run", "description": "Object type, always `agent_run`.", "type": "string" } }, "required": ["type", "text", "reasoning_text", "tool_calls", "tool_results", "sources", "files", "finish_reason", "total_usage", "trace_id", "run_id", "memory", "message_id", "cost", "handoff"], "type": "object" } },
|
|
6
|
+
"agents.stream": { "body": { "additionalProperties": false, "properties": { "contact": { "additionalProperties": false, "description": "Profile of the end user, used only when `memory.resource` creates a new contact.", "properties": { "email": { "description": "Email of the end user. If another contact of the organization already uses it, the contact is created without it.", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "type": "string" }, "first_name": { "description": "First name of the end user.", "type": "string" }, "last_name": { "description": "Last name of the end user.", "type": "string" }, "phone_number": { "description": "Phone number of the end user. If another contact of the organization already uses it, the contact is created without it.", "type": "string" } }, "type": "object" }, "context": { "description": "Extra texts the model should know in this run. They are joined with a blank line and put before the message.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "instructions": { "description": "Replaces the prompt of the agent for this run only. Requires the `write` permission.", "minLength": 1, "type": "string" }, "max_steps": { "default": 80, "description": "Maximum number of model steps in the run (1 to 200). Requires the `write` permission.", "maximum": 200, "minimum": 1, "type": "integer" }, "memory": { "additionalProperties": false, "description": "Which conversation the turn belongs to and who the end user is.", "properties": { "resource": { "description": "Your own id for the end user (for example a customer id). The server creates or reuses the contact of that user.", "maxLength": 255, "minLength": 1, "type": "string" }, "thread": { "description": "A conversation id returned by a previous run; omit it to start a new conversation. It must belong to this agent.", "minLength": 1, "type": "string" } }, "type": "object" }, "messages": { "anyOf": [{ "minLength": 1, "type": "string" }, { "items": { "description": "A message of the user.", "properties": { "parts": { "description": "Content of the message: text parts and file parts, in order. Text parts are joined with a blank line.", "items": { "anyOf": [{ "description": "A piece of text of the message.", "properties": { "text": { "description": "The text of the part.", "type": "string" }, "type": { "const": "text", "description": "Part type, always `text`.", "type": "string" } }, "required": ["type", "text"], "type": "object" }, { "description": "A file attached to the message.", "properties": { "filename": { "description": "Name of the file. If omitted, the last segment of the URL is used.", "type": "string" }, "media_type": { "description": "MIME type of the file, for example `application/pdf` or `image/png`.", "minLength": 1, "type": "string" }, "type": { "const": "file", "description": "Part type, always `file`.", "type": "string" }, "url": { "description": "Public `https` URL of the file. The server downloads it before the turn starts; the file can be up to 20 MB.", "format": "uri", "type": "string" } }, "required": ["type", "url", "media_type"], "type": "object" }] }, "minItems": 1, "type": "array" }, "role": { "const": "user", "description": "Author of the message, always `user`.", "type": "string" } }, "required": ["role", "parts"], "type": "object" }, "minItems": 1, "type": "array" }], "description": "What the user says: a plain string, or a list of user messages with text and file parts. The text of all the parts is joined with a blank line. A message with files and no text is valid; one with neither is rejected." }, "model": { "description": "Replaces the model of the agent for this run only. It must be one of the offered models. Requires the `write` permission.", "minLength": 1, "type": "string" }, "model_settings": { "additionalProperties": false, "description": "Model settings for this run only. Only `reasoning` is accepted; any other key is rejected. Requires the `write` permission.", "properties": { "reasoning": { "description": "Reasoning effort for this run. It must be a level the model supports. Requires the `write` permission.", "enum": ["off", "low", "medium", "high", "max"], "type": "string" } }, "type": "object" }, "versions": { "additionalProperties": false, "description": "Runs a specific version instead of the active one. Needs only the `query` permission.", "properties": { "agents": { "additionalProperties": { "additionalProperties": false, "description": "The version to run.", "properties": { "version_id": { "description": "Id of the version to run. A version of this agent.", "minLength": 1, "type": "string" } }, "required": ["version_id"], "type": "object" }, "description": "Versions to run, keyed by agent id. The only key allowed is the agent being called.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": ["agents"], "type": "object" } }, "required": ["messages"], "type": "object" }, "response": null },
|
|
7
|
+
"agents.update": { "body": { "additionalProperties": false, "properties": { "activate": { "description": "Whether to make the new version the active one. Only applies when a version is created. Defaults to false.", "type": "boolean" }, "base_version_id": { "anyOf": [{ "minLength": 1, "type": "string" }, { "type": "null" }], "description": "Id of the version you based this change on. If it is not the latest version, the call fails with 409 `base_version_mismatch` and `details.latest_version_id`. Send `null` to say the resource has no versions yet; omit it to skip the check." }, "change_message": { "description": "Note stored with the new version. Used only when a version is created.", "type": "string" }, "config": { "additionalProperties": false, "description": "Changes to the config. Creates a new version.", "properties": { "$schema": { "description": "JSON Schema URL for editors. Accepted and ignored; never stored.", "type": "string" }, "attachments": { "anyOf": [{ "additionalProperties": false, "description": "How the agent handles files sent by the user.", "properties": { "access": { "const": "inline", "default": "inline", "description": "How the model reads attachments. Only `inline` is supported.", "type": "string" }, "allow_reread": { "default": true, "description": "Whether the model can read an attachment again after the turn it arrived in.", "type": "boolean" }, "keep_in_history": { "default": false, "description": "Whether attachments stay in the history of later turns.", "type": "boolean" }, "max_tokens_per_attachment": { "default": 30000, "description": "Token limit for each attachment.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "max_tokens_per_message": { "default": 90000, "description": "Token limit for all the attachments of one message.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "type": "object" }, { "type": "null" }], "description": "How the agent handles files sent by the user. `null` removes it." }, "history": { "anyOf": [{ "additionalProperties": false, "description": "How much of the conversation is sent to the model on each turn.", "properties": { "exchanges": { "default": 5, "description": "How many previous user/agent exchanges are sent to the model (1 to 12).", "maximum": 12, "minimum": 1, "type": "integer" }, "reasoning": { "description": "Whether past reasoning is sent back to the model.", "type": "boolean" }, "tool_calls": { "anyOf": [{ "additionalProperties": false, "description": "Tool calls are not kept in the history.", "properties": { "mode": { "const": "off", "description": "Tool calls are not kept.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": false, "description": "Tool calls of every exchange in the history are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "all", "description": "Keep the tool calls of every exchange.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": false, "description": "Only tool calls of the latest exchanges are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "recent", "description": "Keep the tool calls of the latest exchanges only.", "type": "string" }, "turns": { "description": "How many of the latest exchanges keep their tool calls.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "required": ["mode", "turns"], "type": "object" }], "default": { "mode": "off" }, "description": "Which tool calls are kept in the history. Defaults to `off`." } }, "type": "object" }, { "type": "null" }], "description": "How much of the conversation is sent to the model. `null` removes it." }, "knowledge": { "anyOf": [{ "additionalProperties": false, "description": "Knowledge the agent can search to answer.", "properties": { "mode": { "description": "How the knowledge is searched. Only `vector` is supported.", "enum": ["vector"], "type": "string" }, "project_ids": { "description": "Knowledge projects the agent can search. Each id is the id of a knowledge project of the organization.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, { "type": "null" }], "description": "Knowledge the agent can search. `null` removes it." }, "model": { "additionalProperties": false, "description": "The model the agent runs on.", "properties": { "id": { "description": "Model id; one of the offered models.", "pattern": "\\S", "type": "string" }, "reasoning_effort": { "description": "How much the model reasons before answering; must be one of the reasoning levels of the chosen model. When omitted, the model default applies.", "enum": ["off", "low", "medium", "high", "max"], "type": "string" } }, "required": ["id"], "type": "object" }, "prompt": { "anyOf": [{ "description": "System prompt, as a list of blocks that are joined in order.", "items": { "additionalProperties": false, "description": "A prompt block.", "properties": { "content": { "description": "Text of the block.", "type": "string" }, "type": { "const": "text", "description": "Block type. Only `text` is supported.", "type": "string" } }, "required": ["type", "content"], "type": "object" }, "type": "array" }, { "type": "null" }], "description": "System prompt, as a list of blocks. `null` removes it." }, "tools": { "anyOf": [{ "description": "Tools the model can call. Each non-http tool type at most once; thinking only when the model does not reason (see the reasoning levels of the model) or reasoning_effort is off.", "items": { "anyOf": [{ "additionalProperties": false, "description": "Calls an HTTP endpoint.", "properties": { "body": { "description": "Fields of the request body. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"city\", \"value\": \"Madrid\", \"description\": \"City to look up\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "description": { "description": "Tells the model when to use the tool.", "type": "string" }, "headers": { "description": "Headers sent on every call. Each item is an object `{ key, value, description? }`, not a string; for example `[{ \"key\": \"Authorization\", \"value\": \"Bearer abc\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "method": { "description": "HTTP method. Defaults to GET.", "enum": ["GET", "POST", "PUT", "DELETE", "PATCH"], "type": "string" }, "name": { "description": "Name the model sees for the tool.", "type": "string" }, "path_variables": { "description": "Values for the `{name}` placeholders of the url. Each item is an object `{ key, value, description? }` where `key` is the placeholder name; for example `[{ \"key\": \"id\", \"value\": \"123\", \"description\": \"Order id\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "query_parameters": { "description": "Query parameters of the request. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"page\", \"value\": \"1\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "type": { "const": "http", "description": "Tool type: `http`.", "type": "string" }, "url": { "description": "URL the tool calls. Path variables are written as `{name}`.", "type": "string" }, "with_approval": { "description": "Whether a person must approve each call.", "type": "boolean" } }, "required": ["type", "url"], "type": "object" }, { "additionalProperties": false, "description": "Lets the model write down its reasoning before answering. Only for models that do not reason.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "instructions": { "description": "Extra instructions for how the model should think.", "type": "string" }, "max_thoughts": { "description": "Maximum number of thoughts per turn.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "type": { "const": "thinking", "description": "Tool type: `thinking`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": false, "description": "Lets the model send files to the user.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "send_files", "description": "Tool type: `send_files`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": false, "description": "Lets the model hand the conversation to a person.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "request_human", "description": "Tool type: `request_human`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }] }, "type": "array" }, { "type": "null" }], "description": "Tools the model can call. Each non-http tool type at most once; thinking only when the model does not reason (see the reasoning levels of the model) or reasoning_effort is off. `null` removes it." } }, "type": "object" }, "description": { "description": "New description of the agent.", "type": "string" }, "mcp_connections": { "description": "Replaces the assigned MCP connections. Creates a new version. Each connection_id is the id of an MCP connection of the organization.", "items": { "additionalProperties": false, "description": "An MCP connection to assign to the agent.", "properties": { "connection_id": { "description": "Id of the MCP connection to assign.", "minLength": 1, "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "tools": { "description": "Names of the connection tools the agent can use; when omitted or empty, all of them. Use the `name` field of each tool the connection offers (not `agent_tool_name`). Validated at save: an unknown name is rejected and lists the valid ones.", "items": { "type": "string" }, "type": "array" }, "version_id": { "description": "Version of the connection to pin. Used when the strategy is `pin`.", "minLength": 1, "type": "string" } }, "required": ["connection_id"], "type": "object" }, "type": "array" }, "name": { "description": "New name of the agent.", "minLength": 1, "type": "string" }, "skills": { "description": "Replaces the assigned skills. Creates a new version. Each skill_id is the id of a skill of the organization.", "items": { "additionalProperties": false, "description": "A skill to assign to the agent.", "properties": { "skill_id": { "description": "Id of the skill to assign.", "minLength": 1, "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "version_id": { "description": "Version of the skill to pin. Used when the strategy is `pin`.", "minLength": 1, "type": "string" } }, "required": ["skill_id"], "type": "object" }, "type": "array" } }, "type": "object" }, "response": { "properties": { "active_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the version that is running; `null` when none is active." }, "created_at": { "description": "When the agent was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "description": { "description": "What the agent is for.", "type": "string" }, "harness_type": { "description": "Runtime the agent runs on. Agents created through this API are `mastra`.", "enum": ["legacy", "mastra"], "type": "string" }, "id": { "description": "Id of the agent.", "type": "string" }, "name": { "description": "Name of the agent.", "type": "string" }, "type": { "const": "agent", "description": "Object type, always `agent`.", "type": "string" }, "updated_at": { "description": "When the agent was last changed (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "version": { "anyOf": [{ "properties": { "agent_id": { "description": "Id of the agent this version belongs to.", "type": "string" }, "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Config paths that changed compared with the previous version.", "items": { "type": "string" }, "type": "array" }, "config": { "additionalProperties": {}, "description": "Config of an agent version.", "properties": { "attachments": { "additionalProperties": {}, "description": "How the agent handles files sent by the user.", "properties": { "access": { "const": "inline", "default": "inline", "description": "How the model reads attachments. Only `inline` is supported.", "type": "string" }, "allow_reread": { "default": true, "description": "Whether the model can read an attachment again after the turn it arrived in.", "type": "boolean" }, "keep_in_history": { "default": false, "description": "Whether attachments stay in the history of later turns.", "type": "boolean" }, "max_tokens_per_attachment": { "default": 30000, "description": "Token limit for each attachment.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "max_tokens_per_message": { "default": 90000, "description": "Token limit for all the attachments of one message.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "type": "object" }, "history": { "additionalProperties": {}, "description": "How much of the conversation is sent to the model on each turn.", "properties": { "exchanges": { "default": 5, "description": "How many previous user/agent exchanges are sent to the model (1 to 12).", "maximum": 12, "minimum": 1, "type": "integer" }, "reasoning": { "description": "Whether past reasoning is sent back to the model.", "type": "boolean" }, "tool_calls": { "anyOf": [{ "additionalProperties": {}, "description": "Tool calls are not kept in the history.", "properties": { "mode": { "const": "off", "description": "Tool calls are not kept.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": {}, "description": "Tool calls of every exchange in the history are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "all", "description": "Keep the tool calls of every exchange.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": {}, "description": "Only tool calls of the latest exchanges are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "recent", "description": "Keep the tool calls of the latest exchanges only.", "type": "string" }, "turns": { "description": "How many of the latest exchanges keep their tool calls.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "required": ["mode", "turns"], "type": "object" }], "default": { "mode": "off" }, "description": "Which tool calls are kept in the history. Defaults to `off`." } }, "type": "object" }, "knowledge": { "additionalProperties": {}, "description": "Knowledge the agent can search to answer.", "properties": { "mode": { "description": "How the knowledge is searched. Only `vector` is supported.", "enum": ["vector"], "type": "string" }, "project_ids": { "description": "Knowledge projects the agent can search. Each id is the id of a knowledge project of the organization.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "model": { "additionalProperties": {}, "description": "The model the agent runs on.", "properties": { "id": { "description": "Model id; one of the offered models.", "type": "string" }, "reasoning_effort": { "description": "How much the model reasons before answering; must be one of the reasoning levels of the chosen model. When omitted, the model default applies.", "enum": ["off", "low", "medium", "high", "max"], "type": "string" } }, "required": ["id"], "type": "object" }, "prompt": { "description": "System prompt, as a list of blocks that are joined in order.", "items": {}, "type": "array" }, "tools": { "description": "Tools the model can call. Each non-http tool type at most once; thinking only when the model does not reason (see the reasoning levels of the model) or reasoning_effort is off.", "items": { "anyOf": [{ "additionalProperties": {}, "description": "Calls an HTTP endpoint.", "properties": { "body": { "description": "Fields of the request body. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"city\", \"value\": \"Madrid\", \"description\": \"City to look up\" }]`.", "items": {}, "type": "array" }, "description": { "description": "Tells the model when to use the tool.", "type": "string" }, "headers": { "description": "Headers sent on every call. Each item is an object `{ key, value, description? }`, not a string; for example `[{ \"key\": \"Authorization\", \"value\": \"Bearer abc\" }]`.", "items": {}, "type": "array" }, "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "method": { "description": "HTTP method. Defaults to GET.", "type": "string" }, "name": { "description": "Name the model sees for the tool." }, "path_variables": { "description": "Values for the `{name}` placeholders of the url. Each item is an object `{ key, value, description? }` where `key` is the placeholder name; for example `[{ \"key\": \"id\", \"value\": \"123\", \"description\": \"Order id\" }]`.", "items": {}, "type": "array" }, "query_parameters": { "description": "Query parameters of the request. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"page\", \"value\": \"1\" }]`.", "items": {}, "type": "array" }, "type": { "const": "http", "description": "Tool type: `http`.", "type": "string" }, "url": { "description": "URL the tool calls. Path variables are written as `{name}`.", "type": "string" }, "with_approval": { "description": "Whether a person must approve each call." } }, "required": ["type", "url"], "type": "object" }, { "additionalProperties": {}, "description": "Lets the model write down its reasoning before answering. Only for models that do not reason.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "instructions": { "description": "Extra instructions for how the model should think.", "type": "string" }, "max_thoughts": { "description": "Maximum number of thoughts per turn.", "type": "number" }, "type": { "const": "thinking", "description": "Tool type: `thinking`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": {}, "description": "Lets the model send files to the user.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "send_files", "description": "Tool type: `send_files`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": {}, "description": "Lets the model hand the conversation to a person.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "request_human", "description": "Tool type: `request_human`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }] }, "type": "array" } }, "type": "object" }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "harness_type": { "description": "Runtime the version runs on.", "enum": ["legacy", "mastra"], "type": "string" }, "id": { "description": "Id of the version.", "type": "string" }, "is_active": { "description": "Whether this is the version that is running.", "type": "boolean" }, "mcp_connections": { "description": "MCP connections assigned to this version.", "items": { "description": "An MCP connection assigned to the agent.", "properties": { "connection_id": { "description": "Id of the assigned MCP connection.", "type": "string" }, "pinned_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Version of the connection in use when the strategy is `pin`; `null` otherwise." }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "tools": { "description": "Server tool names of the connection the agent can use (the `name` field of each tool the connection offers); empty means all of them.", "items": { "type": "string" }, "type": "array" } }, "required": ["connection_id", "strategy", "pinned_version_id", "tools"], "type": "object" }, "type": "array" }, "skills": { "description": "Skills assigned to this version.", "items": { "description": "A skill assigned to the agent.", "properties": { "pinned_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Version of the skill in use when the strategy is `pin`; `null` otherwise." }, "skill_id": { "description": "Id of the assigned skill.", "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" } }, "required": ["skill_id", "strategy", "pinned_version_id"], "type": "object" }, "type": "array" }, "type": { "const": "agent_version", "description": "Object type, always `agent_version`.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "warnings": { "description": "Present only on the response of the call that created the version, and only when there is something to note: something saved without verification (`mcp_tools_unverified`) or a version identical to the latest one (`no_changes`).", "items": { "description": "A note about a version that was saved: something saved without being verified, or a version identical to the latest one.", "properties": { "code": { "description": "`mcp_tools_unverified`: the MCP server could not be reached, so the tool names of this connection were saved without checking. `no_changes`: the new version is identical to the latest one.", "enum": ["mcp_tools_unverified", "no_changes"], "type": "string" }, "connection_id": { "description": "Id of the MCP connection that could not be reached; only on `mcp_tools_unverified`.", "type": "string" }, "message": { "description": "What happened and what to do about it: what could not be checked and how to check it (`mcp_tools_unverified`), or that the new version is identical to the latest one (`no_changes`).", "type": "string" } }, "required": ["code", "message"], "type": "object" }, "type": "array" } }, "required": ["type", "id", "agent_id", "version_number", "harness_type", "config", "skills", "mcp_connections", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" }, { "type": "null" }], "description": "The version this call created; `null` when it did not create one." } }, "required": ["type", "id", "name", "description", "harness_type", "active_version_id", "created_at", "updated_at", "version"], "type": "object" } },
|
|
8
|
+
"agents.versions.create": { "body": { "additionalProperties": false, "properties": { "base_version_id": { "anyOf": [{ "minLength": 1, "type": "string" }, { "type": "null" }], "description": "Id of the version you based this change on. If it is not the latest version, the call fails with 409 `base_version_mismatch` and `details.latest_version_id`. Send `null` to say the resource has no versions yet; omit it to skip the check." }, "change_message": { "description": "Note stored with the version.", "type": "string" }, "config": { "additionalProperties": false, "description": "Config to create an agent version. `model` is required; omitted keys use their defaults.", "properties": { "$schema": { "description": "JSON Schema URL for editors. Accepted and ignored; never stored.", "type": "string" }, "attachments": { "additionalProperties": false, "description": "How the agent handles files sent by the user.", "properties": { "access": { "const": "inline", "default": "inline", "description": "How the model reads attachments. Only `inline` is supported.", "type": "string" }, "allow_reread": { "default": true, "description": "Whether the model can read an attachment again after the turn it arrived in.", "type": "boolean" }, "keep_in_history": { "default": false, "description": "Whether attachments stay in the history of later turns.", "type": "boolean" }, "max_tokens_per_attachment": { "default": 30000, "description": "Token limit for each attachment.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "max_tokens_per_message": { "default": 90000, "description": "Token limit for all the attachments of one message.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "type": "object" }, "history": { "additionalProperties": false, "description": "How much of the conversation is sent to the model on each turn.", "properties": { "exchanges": { "default": 5, "description": "How many previous user/agent exchanges are sent to the model (1 to 12).", "maximum": 12, "minimum": 1, "type": "integer" }, "reasoning": { "description": "Whether past reasoning is sent back to the model.", "type": "boolean" }, "tool_calls": { "anyOf": [{ "additionalProperties": false, "description": "Tool calls are not kept in the history.", "properties": { "mode": { "const": "off", "description": "Tool calls are not kept.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": false, "description": "Tool calls of every exchange in the history are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "all", "description": "Keep the tool calls of every exchange.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": false, "description": "Only tool calls of the latest exchanges are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "recent", "description": "Keep the tool calls of the latest exchanges only.", "type": "string" }, "turns": { "description": "How many of the latest exchanges keep their tool calls.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "required": ["mode", "turns"], "type": "object" }], "default": { "mode": "off" }, "description": "Which tool calls are kept in the history. Defaults to `off`." } }, "type": "object" }, "knowledge": { "additionalProperties": false, "description": "Knowledge the agent can search to answer.", "properties": { "mode": { "description": "How the knowledge is searched. Only `vector` is supported.", "enum": ["vector"], "type": "string" }, "project_ids": { "description": "Knowledge projects the agent can search. Each id is the id of a knowledge project of the organization.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "model": { "additionalProperties": false, "description": "The model the agent runs on.", "properties": { "id": { "description": "Model id; one of the offered models.", "pattern": "\\S", "type": "string" }, "reasoning_effort": { "description": "How much the model reasons before answering; must be one of the reasoning levels of the chosen model. When omitted, the model default applies.", "enum": ["off", "low", "medium", "high", "max"], "type": "string" } }, "required": ["id"], "type": "object" }, "prompt": { "description": "System prompt, as a list of blocks that are joined in order.", "items": { "additionalProperties": false, "description": "A prompt block.", "properties": { "content": { "description": "Text of the block.", "type": "string" }, "type": { "const": "text", "description": "Block type. Only `text` is supported.", "type": "string" } }, "required": ["type", "content"], "type": "object" }, "type": "array" }, "tools": { "description": "Tools the model can call. Each non-http tool type at most once; thinking only when the model does not reason (see the reasoning levels of the model) or reasoning_effort is off.", "items": { "anyOf": [{ "additionalProperties": false, "description": "Calls an HTTP endpoint.", "properties": { "body": { "description": "Fields of the request body. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"city\", \"value\": \"Madrid\", \"description\": \"City to look up\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "description": { "description": "Tells the model when to use the tool.", "type": "string" }, "headers": { "description": "Headers sent on every call. Each item is an object `{ key, value, description? }`, not a string; for example `[{ \"key\": \"Authorization\", \"value\": \"Bearer abc\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "method": { "description": "HTTP method. Defaults to GET.", "enum": ["GET", "POST", "PUT", "DELETE", "PATCH"], "type": "string" }, "name": { "description": "Name the model sees for the tool.", "type": "string" }, "path_variables": { "description": "Values for the `{name}` placeholders of the url. Each item is an object `{ key, value, description? }` where `key` is the placeholder name; for example `[{ \"key\": \"id\", \"value\": \"123\", \"description\": \"Order id\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "query_parameters": { "description": "Query parameters of the request. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"page\", \"value\": \"1\" }]`.", "items": { "additionalProperties": false, "description": "A header, body field, query parameter or path variable of an http tool.", "properties": { "accepted_values": { "description": "Values the model may choose from.", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Tells the model what to put in this field.", "type": "string" }, "is_user_provided": { "description": "Whether the model fills this value on each call instead of a fixed one.", "type": "boolean" }, "key": { "description": "Name of the header, body field, query parameter or path variable.", "type": "string" }, "required": { "description": "Whether the model must provide this value.", "type": "boolean" }, "type": { "description": "Type of the value the model provides.", "type": "string" }, "value": { "description": "Fixed value sent on every call." } }, "required": ["key"], "type": "object" }, "type": "array" }, "type": { "const": "http", "description": "Tool type: `http`.", "type": "string" }, "url": { "description": "URL the tool calls. Path variables are written as `{name}`.", "type": "string" }, "with_approval": { "description": "Whether a person must approve each call.", "type": "boolean" } }, "required": ["type", "url"], "type": "object" }, { "additionalProperties": false, "description": "Lets the model write down its reasoning before answering. Only for models that do not reason.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "instructions": { "description": "Extra instructions for how the model should think.", "type": "string" }, "max_thoughts": { "description": "Maximum number of thoughts per turn.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "type": { "const": "thinking", "description": "Tool type: `thinking`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": false, "description": "Lets the model send files to the user.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "send_files", "description": "Tool type: `send_files`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": false, "description": "Lets the model hand the conversation to a person.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "request_human", "description": "Tool type: `request_human`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }] }, "type": "array" } }, "required": ["model"], "type": "object" }, "mcp_connections": { "description": "MCP connections to assign. Each connection_id is the id of an MCP connection of the organization.", "items": { "additionalProperties": false, "description": "An MCP connection to assign to the agent.", "properties": { "connection_id": { "description": "Id of the MCP connection to assign.", "minLength": 1, "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "tools": { "description": "Names of the connection tools the agent can use; when omitted or empty, all of them. Use the `name` field of each tool the connection offers (not `agent_tool_name`). Validated at save: an unknown name is rejected and lists the valid ones.", "items": { "type": "string" }, "type": "array" }, "version_id": { "description": "Version of the connection to pin. Used when the strategy is `pin`.", "minLength": 1, "type": "string" } }, "required": ["connection_id"], "type": "object" }, "type": "array" }, "skills": { "description": "Skills to assign. Each skill_id is the id of a skill of the organization.", "items": { "additionalProperties": false, "description": "A skill to assign to the agent.", "properties": { "skill_id": { "description": "Id of the skill to assign.", "minLength": 1, "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "version_id": { "description": "Version of the skill to pin. Used when the strategy is `pin`.", "minLength": 1, "type": "string" } }, "required": ["skill_id"], "type": "object" }, "type": "array" } }, "required": ["config"], "type": "object" }, "response": { "properties": { "agent_id": { "description": "Id of the agent this version belongs to.", "type": "string" }, "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Config paths that changed compared with the previous version.", "items": { "type": "string" }, "type": "array" }, "config": { "additionalProperties": {}, "description": "Config of an agent version.", "properties": { "attachments": { "additionalProperties": {}, "description": "How the agent handles files sent by the user.", "properties": { "access": { "const": "inline", "default": "inline", "description": "How the model reads attachments. Only `inline` is supported.", "type": "string" }, "allow_reread": { "default": true, "description": "Whether the model can read an attachment again after the turn it arrived in.", "type": "boolean" }, "keep_in_history": { "default": false, "description": "Whether attachments stay in the history of later turns.", "type": "boolean" }, "max_tokens_per_attachment": { "default": 30000, "description": "Token limit for each attachment.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "max_tokens_per_message": { "default": 90000, "description": "Token limit for all the attachments of one message.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "type": "object" }, "history": { "additionalProperties": {}, "description": "How much of the conversation is sent to the model on each turn.", "properties": { "exchanges": { "default": 5, "description": "How many previous user/agent exchanges are sent to the model (1 to 12).", "maximum": 12, "minimum": 1, "type": "integer" }, "reasoning": { "description": "Whether past reasoning is sent back to the model.", "type": "boolean" }, "tool_calls": { "anyOf": [{ "additionalProperties": {}, "description": "Tool calls are not kept in the history.", "properties": { "mode": { "const": "off", "description": "Tool calls are not kept.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": {}, "description": "Tool calls of every exchange in the history are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "all", "description": "Keep the tool calls of every exchange.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": {}, "description": "Only tool calls of the latest exchanges are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "recent", "description": "Keep the tool calls of the latest exchanges only.", "type": "string" }, "turns": { "description": "How many of the latest exchanges keep their tool calls.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "required": ["mode", "turns"], "type": "object" }], "default": { "mode": "off" }, "description": "Which tool calls are kept in the history. Defaults to `off`." } }, "type": "object" }, "knowledge": { "additionalProperties": {}, "description": "Knowledge the agent can search to answer.", "properties": { "mode": { "description": "How the knowledge is searched. Only `vector` is supported.", "enum": ["vector"], "type": "string" }, "project_ids": { "description": "Knowledge projects the agent can search. Each id is the id of a knowledge project of the organization.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "model": { "additionalProperties": {}, "description": "The model the agent runs on.", "properties": { "id": { "description": "Model id; one of the offered models.", "type": "string" }, "reasoning_effort": { "description": "How much the model reasons before answering; must be one of the reasoning levels of the chosen model. When omitted, the model default applies.", "enum": ["off", "low", "medium", "high", "max"], "type": "string" } }, "required": ["id"], "type": "object" }, "prompt": { "description": "System prompt, as a list of blocks that are joined in order.", "items": {}, "type": "array" }, "tools": { "description": "Tools the model can call. Each non-http tool type at most once; thinking only when the model does not reason (see the reasoning levels of the model) or reasoning_effort is off.", "items": { "anyOf": [{ "additionalProperties": {}, "description": "Calls an HTTP endpoint.", "properties": { "body": { "description": "Fields of the request body. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"city\", \"value\": \"Madrid\", \"description\": \"City to look up\" }]`.", "items": {}, "type": "array" }, "description": { "description": "Tells the model when to use the tool.", "type": "string" }, "headers": { "description": "Headers sent on every call. Each item is an object `{ key, value, description? }`, not a string; for example `[{ \"key\": \"Authorization\", \"value\": \"Bearer abc\" }]`.", "items": {}, "type": "array" }, "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "method": { "description": "HTTP method. Defaults to GET.", "type": "string" }, "name": { "description": "Name the model sees for the tool." }, "path_variables": { "description": "Values for the `{name}` placeholders of the url. Each item is an object `{ key, value, description? }` where `key` is the placeholder name; for example `[{ \"key\": \"id\", \"value\": \"123\", \"description\": \"Order id\" }]`.", "items": {}, "type": "array" }, "query_parameters": { "description": "Query parameters of the request. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"page\", \"value\": \"1\" }]`.", "items": {}, "type": "array" }, "type": { "const": "http", "description": "Tool type: `http`.", "type": "string" }, "url": { "description": "URL the tool calls. Path variables are written as `{name}`.", "type": "string" }, "with_approval": { "description": "Whether a person must approve each call." } }, "required": ["type", "url"], "type": "object" }, { "additionalProperties": {}, "description": "Lets the model write down its reasoning before answering. Only for models that do not reason.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "instructions": { "description": "Extra instructions for how the model should think.", "type": "string" }, "max_thoughts": { "description": "Maximum number of thoughts per turn.", "type": "number" }, "type": { "const": "thinking", "description": "Tool type: `thinking`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": {}, "description": "Lets the model send files to the user.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "send_files", "description": "Tool type: `send_files`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": {}, "description": "Lets the model hand the conversation to a person.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "request_human", "description": "Tool type: `request_human`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }] }, "type": "array" } }, "type": "object" }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "harness_type": { "description": "Runtime the version runs on.", "enum": ["legacy", "mastra"], "type": "string" }, "id": { "description": "Id of the version.", "type": "string" }, "is_active": { "description": "Whether this is the version that is running.", "type": "boolean" }, "mcp_connections": { "description": "MCP connections assigned to this version.", "items": { "description": "An MCP connection assigned to the agent.", "properties": { "connection_id": { "description": "Id of the assigned MCP connection.", "type": "string" }, "pinned_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Version of the connection in use when the strategy is `pin`; `null` otherwise." }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "tools": { "description": "Server tool names of the connection the agent can use (the `name` field of each tool the connection offers); empty means all of them.", "items": { "type": "string" }, "type": "array" } }, "required": ["connection_id", "strategy", "pinned_version_id", "tools"], "type": "object" }, "type": "array" }, "skills": { "description": "Skills assigned to this version.", "items": { "description": "A skill assigned to the agent.", "properties": { "pinned_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Version of the skill in use when the strategy is `pin`; `null` otherwise." }, "skill_id": { "description": "Id of the assigned skill.", "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" } }, "required": ["skill_id", "strategy", "pinned_version_id"], "type": "object" }, "type": "array" }, "type": { "const": "agent_version", "description": "Object type, always `agent_version`.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "warnings": { "description": "Present only on the response of the call that created the version, and only when there is something to note: something saved without verification (`mcp_tools_unverified`) or a version identical to the latest one (`no_changes`).", "items": { "description": "A note about a version that was saved: something saved without being verified, or a version identical to the latest one.", "properties": { "code": { "description": "`mcp_tools_unverified`: the MCP server could not be reached, so the tool names of this connection were saved without checking. `no_changes`: the new version is identical to the latest one.", "enum": ["mcp_tools_unverified", "no_changes"], "type": "string" }, "connection_id": { "description": "Id of the MCP connection that could not be reached; only on `mcp_tools_unverified`.", "type": "string" }, "message": { "description": "What happened and what to do about it: what could not be checked and how to check it (`mcp_tools_unverified`), or that the new version is identical to the latest one (`no_changes`).", "type": "string" } }, "required": ["code", "message"], "type": "object" }, "type": "array" } }, "required": ["type", "id", "agent_id", "version_number", "harness_type", "config", "skills", "mcp_connections", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" } },
|
|
9
|
+
"agents.versions.restore": { "body": { "additionalProperties": false, "properties": { "activate": { "default": true, "description": "Whether to make the restored copy the active version. Defaults to true.", "type": "boolean" } }, "type": "object" }, "response": { "properties": { "agent_id": { "description": "Id of the agent this version belongs to.", "type": "string" }, "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Config paths that changed compared with the previous version.", "items": { "type": "string" }, "type": "array" }, "config": { "additionalProperties": {}, "description": "Config of an agent version.", "properties": { "attachments": { "additionalProperties": {}, "description": "How the agent handles files sent by the user.", "properties": { "access": { "const": "inline", "default": "inline", "description": "How the model reads attachments. Only `inline` is supported.", "type": "string" }, "allow_reread": { "default": true, "description": "Whether the model can read an attachment again after the turn it arrived in.", "type": "boolean" }, "keep_in_history": { "default": false, "description": "Whether attachments stay in the history of later turns.", "type": "boolean" }, "max_tokens_per_attachment": { "default": 30000, "description": "Token limit for each attachment.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "max_tokens_per_message": { "default": 90000, "description": "Token limit for all the attachments of one message.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "type": "object" }, "history": { "additionalProperties": {}, "description": "How much of the conversation is sent to the model on each turn.", "properties": { "exchanges": { "default": 5, "description": "How many previous user/agent exchanges are sent to the model (1 to 12).", "maximum": 12, "minimum": 1, "type": "integer" }, "reasoning": { "description": "Whether past reasoning is sent back to the model.", "type": "boolean" }, "tool_calls": { "anyOf": [{ "additionalProperties": {}, "description": "Tool calls are not kept in the history.", "properties": { "mode": { "const": "off", "description": "Tool calls are not kept.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": {}, "description": "Tool calls of every exchange in the history are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "all", "description": "Keep the tool calls of every exchange.", "type": "string" } }, "required": ["mode"], "type": "object" }, { "additionalProperties": {}, "description": "Only tool calls of the latest exchanges are kept.", "properties": { "exclude_tools": { "description": "Ids of tools whose calls are left out of the history.", "items": { "type": "string" }, "type": "array" }, "mode": { "const": "recent", "description": "Keep the tool calls of the latest exchanges only.", "type": "string" }, "turns": { "description": "How many of the latest exchanges keep their tool calls.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "required": ["mode", "turns"], "type": "object" }], "default": { "mode": "off" }, "description": "Which tool calls are kept in the history. Defaults to `off`." } }, "type": "object" }, "knowledge": { "additionalProperties": {}, "description": "Knowledge the agent can search to answer.", "properties": { "mode": { "description": "How the knowledge is searched. Only `vector` is supported.", "enum": ["vector"], "type": "string" }, "project_ids": { "description": "Knowledge projects the agent can search. Each id is the id of a knowledge project of the organization.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "model": { "additionalProperties": {}, "description": "The model the agent runs on.", "properties": { "id": { "description": "Model id; one of the offered models.", "type": "string" }, "reasoning_effort": { "description": "How much the model reasons before answering; must be one of the reasoning levels of the chosen model. When omitted, the model default applies.", "enum": ["off", "low", "medium", "high", "max"], "type": "string" } }, "required": ["id"], "type": "object" }, "prompt": { "description": "System prompt, as a list of blocks that are joined in order.", "items": {}, "type": "array" }, "tools": { "description": "Tools the model can call. Each non-http tool type at most once; thinking only when the model does not reason (see the reasoning levels of the model) or reasoning_effort is off.", "items": { "anyOf": [{ "additionalProperties": {}, "description": "Calls an HTTP endpoint.", "properties": { "body": { "description": "Fields of the request body. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"city\", \"value\": \"Madrid\", \"description\": \"City to look up\" }]`.", "items": {}, "type": "array" }, "description": { "description": "Tells the model when to use the tool.", "type": "string" }, "headers": { "description": "Headers sent on every call. Each item is an object `{ key, value, description? }`, not a string; for example `[{ \"key\": \"Authorization\", \"value\": \"Bearer abc\" }]`.", "items": {}, "type": "array" }, "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "method": { "description": "HTTP method. Defaults to GET.", "type": "string" }, "name": { "description": "Name the model sees for the tool." }, "path_variables": { "description": "Values for the `{name}` placeholders of the url. Each item is an object `{ key, value, description? }` where `key` is the placeholder name; for example `[{ \"key\": \"id\", \"value\": \"123\", \"description\": \"Order id\" }]`.", "items": {}, "type": "array" }, "query_parameters": { "description": "Query parameters of the request. Each item is an object `{ key, value, description? }`; for example `[{ \"key\": \"page\", \"value\": \"1\" }]`.", "items": {}, "type": "array" }, "type": { "const": "http", "description": "Tool type: `http`.", "type": "string" }, "url": { "description": "URL the tool calls. Path variables are written as `{name}`.", "type": "string" }, "with_approval": { "description": "Whether a person must approve each call." } }, "required": ["type", "url"], "type": "object" }, { "additionalProperties": {}, "description": "Lets the model write down its reasoning before answering. Only for models that do not reason.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "instructions": { "description": "Extra instructions for how the model should think.", "type": "string" }, "max_thoughts": { "description": "Maximum number of thoughts per turn.", "type": "number" }, "type": { "const": "thinking", "description": "Tool type: `thinking`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": {}, "description": "Lets the model send files to the user.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "send_files", "description": "Tool type: `send_files`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }, { "additionalProperties": {}, "description": "Lets the model hand the conversation to a person.", "properties": { "id": { "description": "Assigned by the server when omitted; use it to edit or remove the tool. Must be unique among the tools.", "type": "string" }, "type": { "const": "request_human", "description": "Tool type: `request_human`.", "type": "string" } }, "required": ["type"], "type": "object", "x-single": true }] }, "type": "array" } }, "type": "object" }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "harness_type": { "description": "Runtime the version runs on.", "enum": ["legacy", "mastra"], "type": "string" }, "id": { "description": "Id of the version.", "type": "string" }, "is_active": { "description": "Whether this is the version that is running.", "type": "boolean" }, "mcp_connections": { "description": "MCP connections assigned to this version.", "items": { "description": "An MCP connection assigned to the agent.", "properties": { "connection_id": { "description": "Id of the assigned MCP connection.", "type": "string" }, "pinned_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Version of the connection in use when the strategy is `pin`; `null` otherwise." }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" }, "tools": { "description": "Server tool names of the connection the agent can use (the `name` field of each tool the connection offers); empty means all of them.", "items": { "type": "string" }, "type": "array" } }, "required": ["connection_id", "strategy", "pinned_version_id", "tools"], "type": "object" }, "type": "array" }, "skills": { "description": "Skills assigned to this version.", "items": { "description": "A skill assigned to the agent.", "properties": { "pinned_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Version of the skill in use when the strategy is `pin`; `null` otherwise." }, "skill_id": { "description": "Id of the assigned skill.", "type": "string" }, "strategy": { "description": "`pin` keeps a fixed version; `latest` follows the active version.", "enum": ["pin", "latest"], "type": "string" } }, "required": ["skill_id", "strategy", "pinned_version_id"], "type": "object" }, "type": "array" }, "type": { "const": "agent_version", "description": "Object type, always `agent_version`.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "warnings": { "description": "Present only on the response of the call that created the version, and only when there is something to note: something saved without verification (`mcp_tools_unverified`) or a version identical to the latest one (`no_changes`).", "items": { "description": "A note about a version that was saved: something saved without being verified, or a version identical to the latest one.", "properties": { "code": { "description": "`mcp_tools_unverified`: the MCP server could not be reached, so the tool names of this connection were saved without checking. `no_changes`: the new version is identical to the latest one.", "enum": ["mcp_tools_unverified", "no_changes"], "type": "string" }, "connection_id": { "description": "Id of the MCP connection that could not be reached; only on `mcp_tools_unverified`.", "type": "string" }, "message": { "description": "What happened and what to do about it: what could not be checked and how to check it (`mcp_tools_unverified`), or that the new version is identical to the latest one (`no_changes`).", "type": "string" } }, "required": ["code", "message"], "type": "object" }, "type": "array" } }, "required": ["type", "id", "agent_id", "version_number", "harness_type", "config", "skills", "mcp_connections", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" } },
|
|
10
|
+
"mcp.connections.create": { "body": { "additionalProperties": false, "properties": { "activate": { "description": "Whether to make the first version the active one.", "type": "boolean" }, "change_message": { "description": "Note stored with the first version.", "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Headers sent to the MCP server: name to value.", "propertyNames": { "type": "string" }, "type": "object" }, "name": { "description": "Name of the connection.", "minLength": 1, "type": "string" }, "url": { "description": "URL of the MCP server.", "minLength": 1, "type": "string" } }, "required": ["name", "url"], "type": "object" }, "response": { "properties": { "active_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the version in use; `null` when none is active." }, "created_at": { "description": "When the connection was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the connection.", "type": "string" }, "id": { "description": "Id of the connection.", "type": "string" }, "name": { "description": "Name of the connection.", "type": "string" }, "type": { "const": "mcp_connection", "description": "Object type, always `mcp_connection`.", "type": "string" }, "updated_at": { "description": "When the connection was last changed (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "version": { "anyOf": [{ "properties": { "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Fields that changed compared with the previous version. A changed URL shows as `url_host`.", "items": { "type": "string" }, "type": "array" }, "connection_id": { "description": "Id of the connection this version belongs to.", "type": "string" }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Headers sent to the server: name to value. Values are always returned as `[REDACTED]`.", "propertyNames": { "type": "string" }, "type": "object" }, "id": { "description": "Id of the version.", "type": "string" }, "is_active": { "description": "Whether this is the version in use.", "type": "boolean" }, "type": { "const": "mcp_connection_version", "description": "Object type, always `mcp_connection_version`.", "type": "string" }, "url": { "description": "URL of the MCP server. Always returned as `[REDACTED]` because it can carry secrets.", "type": "string" }, "url_host": { "description": "Host of the URL, to recognize the server without exposing the rest.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": ["type", "id", "connection_id", "version_number", "url", "url_host", "headers", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" }, { "type": "null" }], "description": "The version this call created; `null` when it did not create one." } }, "required": ["type", "id", "name", "active_version_id", "created_by", "created_at", "updated_at", "version"], "type": "object" } },
|
|
11
|
+
"mcp.connections.update": { "body": { "additionalProperties": false, "properties": { "name": { "description": "New name of the connection.", "minLength": 1, "type": "string" } }, "required": ["name"], "type": "object" }, "response": { "properties": { "active_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the version in use; `null` when none is active." }, "created_at": { "description": "When the connection was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the connection.", "type": "string" }, "id": { "description": "Id of the connection.", "type": "string" }, "name": { "description": "Name of the connection.", "type": "string" }, "type": { "const": "mcp_connection", "description": "Object type, always `mcp_connection`.", "type": "string" }, "updated_at": { "description": "When the connection was last changed (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" } }, "required": ["type", "id", "name", "active_version_id", "created_by", "created_at", "updated_at"], "type": "object" } },
|
|
12
|
+
"mcp.connections.versions.create": { "body": { "additionalProperties": false, "properties": { "base_version_id": { "anyOf": [{ "minLength": 1, "type": "string" }, { "type": "null" }], "description": "Id of the version you based this change on. If it is not the latest version, the call fails with 409 `base_version_mismatch` and `details.latest_version_id`. Send `null` to say the resource has no versions yet; omit it to skip the check." }, "change_message": { "description": "Note stored with the version.", "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Headers sent to the MCP server: name to value. Omit it to keep the headers of the latest version; send `{}` to remove them.", "propertyNames": { "type": "string" }, "type": "object" }, "url": { "description": "URL of the MCP server. Omit it to keep the URL of the latest version.", "minLength": 1, "type": "string" } }, "type": "object" }, "response": { "properties": { "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Fields that changed compared with the previous version. A changed URL shows as `url_host`.", "items": { "type": "string" }, "type": "array" }, "connection_id": { "description": "Id of the connection this version belongs to.", "type": "string" }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Headers sent to the server: name to value. Values are always returned as `[REDACTED]`.", "propertyNames": { "type": "string" }, "type": "object" }, "id": { "description": "Id of the version.", "type": "string" }, "is_active": { "description": "Whether this is the version in use.", "type": "boolean" }, "type": { "const": "mcp_connection_version", "description": "Object type, always `mcp_connection_version`.", "type": "string" }, "url": { "description": "URL of the MCP server. Always returned as `[REDACTED]` because it can carry secrets.", "type": "string" }, "url_host": { "description": "Host of the URL, to recognize the server without exposing the rest.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": ["type", "id", "connection_id", "version_number", "url", "url_host", "headers", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" } },
|
|
13
|
+
"mcp.connections.versions.restore": { "body": { "additionalProperties": false, "properties": { "activate": { "default": true, "description": "Whether to make the restored copy the active version. Defaults to true.", "type": "boolean" } }, "type": "object" }, "response": { "properties": { "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Fields that changed compared with the previous version. A changed URL shows as `url_host`.", "items": { "type": "string" }, "type": "array" }, "connection_id": { "description": "Id of the connection this version belongs to.", "type": "string" }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Headers sent to the server: name to value. Values are always returned as `[REDACTED]`.", "propertyNames": { "type": "string" }, "type": "object" }, "id": { "description": "Id of the version.", "type": "string" }, "is_active": { "description": "Whether this is the version in use.", "type": "boolean" }, "type": { "const": "mcp_connection_version", "description": "Object type, always `mcp_connection_version`.", "type": "string" }, "url": { "description": "URL of the MCP server. Always returned as `[REDACTED]` because it can carry secrets.", "type": "string" }, "url_host": { "description": "Host of the URL, to recognize the server without exposing the rest.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": ["type", "id", "connection_id", "version_number", "url", "url_host", "headers", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" } },
|
|
14
|
+
"skills.create": { "body": { "additionalProperties": false, "properties": { "activate": { "description": "Whether to make the first version the active one. Defaults to true.", "type": "boolean" }, "change_message": { "description": "Note stored with the first version.", "type": "string" }, "files": { "additionalProperties": { "type": "string" }, "description": "Files of the skill: path to content. `SKILL.md` is required.", "propertyNames": { "type": "string" }, "type": "object" }, "name": { "description": "Name of the skill.", "minLength": 1, "type": "string" } }, "required": ["name", "files"], "type": "object" }, "response": { "properties": { "active_version_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the version in use; `null` when none is active." }, "created_at": { "description": "When the skill was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the skill.", "type": "string" }, "id": { "description": "Id of the skill.", "type": "string" }, "name": { "description": "Name of the skill.", "type": "string" }, "status": { "description": "`draft` until a version is activated; `published` afterwards.", "enum": ["draft", "published"], "type": "string" }, "type": { "const": "skill", "description": "Object type, always `skill`.", "type": "string" }, "updated_at": { "description": "When the skill was last changed (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "version": { "properties": { "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Fields that changed compared with the previous version.", "items": { "type": "string" }, "type": "array" }, "compatibility": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Compatibility notes declared in SKILL.md; `null` when there are none." }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "description": { "description": "What the skill does and when to use it, from SKILL.md.", "type": "string" }, "files": { "description": "Paths of the files of the version, not counting SKILL.md.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Id of the version.", "type": "string" }, "instructions": { "description": "Body of SKILL.md: the instructions the model follows.", "type": "string" }, "is_active": { "description": "Whether this is the version in use.", "type": "boolean" }, "license": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "License declared in SKILL.md; `null` when there is none." }, "metadata": { "description": "Free-form metadata declared in SKILL.md; returned as it was written." }, "name": { "description": "Name of the skill, from SKILL.md.", "type": "string" }, "skill_id": { "description": "Id of the skill this version belongs to.", "type": "string" }, "type": { "const": "skill_version", "description": "Object type, always `skill_version`.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": ["type", "id", "skill_id", "version_number", "name", "description", "instructions", "license", "compatibility", "metadata", "files", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" }, "warnings": { "description": "Notes that did not stop the save: problems found while reading SKILL.md, or that the new version is identical to the latest one.", "items": { "type": "string" }, "type": "array" } }, "required": ["type", "id", "name", "status", "active_version_id", "created_by", "created_at", "updated_at", "version", "warnings"], "type": "object" } },
|
|
15
|
+
"skills.versions.create": { "body": { "additionalProperties": false, "properties": { "change_message": { "description": "Note stored with the version.", "type": "string" }, "files": { "additionalProperties": { "type": "string" }, "description": "Files of the skill: path to content. `SKILL.md` is required.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": ["files"], "type": "object" }, "response": { "properties": { "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Fields that changed compared with the previous version.", "items": { "type": "string" }, "type": "array" }, "compatibility": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Compatibility notes declared in SKILL.md; `null` when there are none." }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "description": { "description": "What the skill does and when to use it, from SKILL.md.", "type": "string" }, "files": { "description": "Paths of the files of the version, not counting SKILL.md.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Id of the version.", "type": "string" }, "instructions": { "description": "Body of SKILL.md: the instructions the model follows.", "type": "string" }, "is_active": { "description": "Whether this is the version in use.", "type": "boolean" }, "license": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "License declared in SKILL.md; `null` when there is none." }, "metadata": { "description": "Free-form metadata declared in SKILL.md; returned as it was written." }, "name": { "description": "Name of the skill, from SKILL.md.", "type": "string" }, "skill_id": { "description": "Id of the skill this version belongs to.", "type": "string" }, "type": { "const": "skill_version", "description": "Object type, always `skill_version`.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "warnings": { "description": "Notes that did not stop the save: problems found while reading SKILL.md, or that the new version is identical to the latest one.", "items": { "type": "string" }, "type": "array" } }, "required": ["type", "id", "skill_id", "version_number", "name", "description", "instructions", "license", "compatibility", "metadata", "files", "changed_fields", "change_message", "created_by", "created_at", "is_active", "warnings"], "type": "object" } },
|
|
16
|
+
"skills.versions.restore": { "body": { "additionalProperties": false, "properties": { "activate": { "default": true, "description": "Whether to make the restored copy the active version. Defaults to true.", "type": "boolean" } }, "type": "object" }, "response": { "properties": { "change_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Note written when the version was created; `null` when there is none." }, "changed_fields": { "description": "Fields that changed compared with the previous version.", "items": { "type": "string" }, "type": "array" }, "compatibility": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Compatibility notes declared in SKILL.md; `null` when there are none." }, "created_at": { "description": "When the version was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the version.", "type": "string" }, "description": { "description": "What the skill does and when to use it, from SKILL.md.", "type": "string" }, "files": { "description": "Paths of the files of the version, not counting SKILL.md.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Id of the version.", "type": "string" }, "instructions": { "description": "Body of SKILL.md: the instructions the model follows.", "type": "string" }, "is_active": { "description": "Whether this is the version in use.", "type": "boolean" }, "license": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "License declared in SKILL.md; `null` when there is none." }, "metadata": { "description": "Free-form metadata declared in SKILL.md; returned as it was written." }, "name": { "description": "Name of the skill, from SKILL.md.", "type": "string" }, "skill_id": { "description": "Id of the skill this version belongs to.", "type": "string" }, "type": { "const": "skill_version", "description": "Object type, always `skill_version`.", "type": "string" }, "version_number": { "description": "Sequential number of the version, starting at 1.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": ["type", "id", "skill_id", "version_number", "name", "description", "instructions", "license", "compatibility", "metadata", "files", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" } },
|
|
17
|
+
"tokens.create": { "body": { "additionalProperties": false, "properties": { "all_organizations": { "description": "For a personal token: make it work in every organization you belong to. Then X-Laburen-Organization is required on each call.", "type": "boolean" }, "description": { "description": "What the token is used for (up to 500 characters).", "maxLength": 500, "type": "string" }, "expires_at": { "description": "When the token expires (RFC 3339). When omitted, it does not expire.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "kind": { "description": "`personal` acts as you; `organization` acts as the organization and needs admin.", "enum": ["personal", "organization"], "type": "string" }, "name": { "description": "Name of the token (1 to 100 characters).", "maxLength": 100, "minLength": 1, "type": "string" }, "permissions": { "description": "Permissions to grant. They cannot exceed your own.", "items": { "description": "Permission level: `query`, `read`, `write` or `admin`.", "enum": ["query", "read", "write", "admin"], "type": "string" }, "type": "array" } }, "required": ["kind", "permissions", "name"], "type": "object" }, "response": { "properties": { "created_at": { "description": "When the token was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the token.", "type": "string" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "What the token is used for; `null` when there is none." }, "expires_at": { "anyOf": [{ "description": "When the token expires (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, { "type": "null" }], "description": "When the token expires (RFC 3339); `null` if it does not expire." }, "id": { "description": "Id of the token.", "type": "string" }, "kind": { "description": "`personal` acts as a user; `organization` acts as the organization itself.", "enum": ["personal", "organization"], "type": "string" }, "last_used_at": { "anyOf": [{ "description": "When the token was last used (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, { "type": "null" }], "description": "When the token was last used (RFC 3339); `null` if it never was." }, "name": { "description": "Name of the token.", "type": "string" }, "organization_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the organization the token is limited to; `null` for a personal token of all organizations." }, "permissions": { "description": "Permissions the token grants.", "items": { "description": "Permission level: `query`, `read`, `write` or `admin`.", "enum": ["query", "read", "write", "admin"], "type": "string" }, "type": "array" }, "prefix": { "description": "First characters of the token value, to recognize it.", "type": "string" }, "revoked_at": { "anyOf": [{ "description": "When the token was revoked (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, { "type": "null" }], "description": "When the token was revoked (RFC 3339); `null` if it is still valid." }, "suffix": { "description": "Last characters of the token value, to recognize it.", "type": "string" }, "type": { "const": "token", "description": "Object type, always `token`.", "type": "string" }, "user_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the user the token belongs to; `null` for an organization token." }, "value": { "description": "The token secret, returned once in this response. Store it now: it cannot be read again.", "type": "string" } }, "required": ["type", "id", "kind", "user_id", "organization_id", "permissions", "prefix", "suffix", "name", "description", "last_used_at", "expires_at", "revoked_at", "created_by", "created_at", "value"], "type": "object" } },
|
|
18
|
+
"tokens.update": { "body": { "additionalProperties": false, "properties": { "description": { "anyOf": [{ "description": "What the token is used for (up to 500 characters).", "maxLength": 500, "type": "string" }, { "type": "null" }], "description": "New description; `null` clears it." }, "name": { "description": "Name of the token (1 to 100 characters).", "maxLength": 100, "minLength": 1, "type": "string" } }, "type": "object" }, "response": { "properties": { "created_at": { "description": "When the token was created (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, "created_by": { "description": "Id of the user or credential that created the token.", "type": "string" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "What the token is used for; `null` when there is none." }, "expires_at": { "anyOf": [{ "description": "When the token expires (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, { "type": "null" }], "description": "When the token expires (RFC 3339); `null` if it does not expire." }, "id": { "description": "Id of the token.", "type": "string" }, "kind": { "description": "`personal` acts as a user; `organization` acts as the organization itself.", "enum": ["personal", "organization"], "type": "string" }, "last_used_at": { "anyOf": [{ "description": "When the token was last used (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, { "type": "null" }], "description": "When the token was last used (RFC 3339); `null` if it never was." }, "name": { "description": "Name of the token.", "type": "string" }, "organization_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the organization the token is limited to; `null` for a personal token of all organizations." }, "permissions": { "description": "Permissions the token grants.", "items": { "description": "Permission level: `query`, `read`, `write` or `admin`.", "enum": ["query", "read", "write", "admin"], "type": "string" }, "type": "array" }, "prefix": { "description": "First characters of the token value, to recognize it.", "type": "string" }, "revoked_at": { "anyOf": [{ "description": "When the token was revoked (RFC 3339).", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, { "type": "null" }], "description": "When the token was revoked (RFC 3339); `null` if it is still valid." }, "suffix": { "description": "Last characters of the token value, to recognize it.", "type": "string" }, "type": { "const": "token", "description": "Object type, always `token`.", "type": "string" }, "user_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Id of the user the token belongs to; `null` for an organization token." } }, "required": ["type", "id", "kind", "user_id", "organization_id", "permissions", "prefix", "suffix", "name", "description", "last_used_at", "expires_at", "revoked_at", "created_by", "created_at"], "type": "object" } },
|
|
19
|
+
};
|
|
20
|
+
//# sourceMappingURL=schemas.js.map
|