@laburen/delta-cli 0.2.0-canary.11 → 0.2.0-canary.13

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.
@@ -7,6 +7,8 @@ export const OPERATION_SCHEMAS = {
7
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
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
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
+ "agents.widgets.create": { "body": { "additionalProperties": false, "properties": { "allowed_domains": { "description": "Domains allowed to embed the widget (up to 50), like `example.com` or `*.example.com`. An empty list allows any site.", "items": { "maxLength": 253, "minLength": 1, "type": "string" }, "maxItems": 50, "type": "array" }, "allows_anonymous": { "default": true, "description": "Whether visitors can chat without an identity token. Defaults to true.", "type": "boolean" }, "appearance": { "additionalProperties": false, "description": "Look of the chat window. Every field is optional.", "properties": { "launcher_icon_url": { "description": "`https` URL of the image shown in the launcher button.", "format": "uri", "maxLength": 2048, "type": "string" }, "position": { "description": "Side of the screen where the launcher button sits.", "enum": ["left", "right"], "type": "string" }, "theme": { "description": "Color theme of the chat; `auto` follows the visitor system.", "enum": ["light", "dark", "auto"], "type": "string" }, "welcome_tagline": { "description": "Line shown under the title (up to 200 characters).", "maxLength": 200, "type": "string" }, "welcome_title": { "description": "Title shown at the top of the chat (up to 100 characters).", "maxLength": 100, "type": "string" }, "widget_color": { "description": "Main color of the widget, as a hex color like `#1f93ff`.", "pattern": "^#[0-9a-fA-F]{6}$", "type": "string" } }, "type": "object" }, "enabled": { "default": true, "description": "Whether the widget answers. Defaults to true.", "type": "boolean" }, "limit_reached_message": { "anyOf": [{ "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" }], "description": "Text shown to a visitor who reached the cap (1 to 500 characters); `null` for the default text." }, "max_attachments_per_message": { "default": 5, "description": "Files a visitor can attach to one message (1 to 10). Defaults to 5.", "maximum": 10, "minimum": 1, "type": "integer" }, "name": { "description": "Name of the widget (1 to 100 characters).", "maxLength": 100, "minLength": 1, "type": "string" }, "visitor_rate_limit": { "anyOf": [{ "additionalProperties": false, "description": "Cap of messages per visitor.", "properties": { "interval_seconds": { "description": "Length of the interval, in seconds (1 to 2592000, 30 days).", "maximum": 2592000, "minimum": 1, "type": "integer" }, "max_messages": { "description": "Messages one visitor can send in the interval (1 to 100000).", "maximum": 100000, "minimum": 1, "type": "integer" } }, "required": ["max_messages", "interval_seconds"], "type": "object" }, { "type": "null" }], "description": "Cap of messages per visitor; `null` removes the cap." } }, "required": ["name"], "type": "object" }, "response": { "properties": { "agent_id": { "description": "Id of the agent that answers in the widget.", "type": "string" }, "allowed_domains": { "description": "Domains allowed to embed the widget; an empty list allows any site.", "items": { "type": "string" }, "type": "array" }, "allows_anonymous": { "description": "Whether visitors can chat without the site identifying them with an identity token.", "type": "boolean" }, "appearance": { "description": "Look of the chat window. Every field is optional.", "properties": { "launcher_icon_url": { "description": "`https` URL of the image shown in the launcher button.", "format": "uri", "maxLength": 2048, "type": "string" }, "position": { "description": "Side of the screen where the launcher button sits.", "enum": ["left", "right"], "type": "string" }, "theme": { "description": "Color theme of the chat; `auto` follows the visitor system.", "enum": ["light", "dark", "auto"], "type": "string" }, "welcome_tagline": { "description": "Line shown under the title (up to 200 characters).", "maxLength": 200, "type": "string" }, "welcome_title": { "description": "Title shown at the top of the chat (up to 100 characters).", "maxLength": 100, "type": "string" }, "widget_color": { "description": "Main color of the widget, as a hex color like `#1f93ff`.", "pattern": "^#[0-9a-fA-F]{6}$", "type": "string" } }, "type": "object" }, "created_at": { "description": "When the widget 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" }, "embed_iframe": { "description": "`<iframe>` that shows the chat inside a page, with `mode=embedded` and `allow=\"microphone\"`.", "type": "string" }, "enabled": { "description": "Whether the widget answers. A turned-off widget behaves as if it did not exist.", "type": "boolean" }, "id": { "description": "Id of the widget.", "type": "string" }, "identity_secret": { "description": "Secret the site uses to sign identity tokens. Returned once: store it now, it cannot be read again.", "type": "string" }, "limit_reached_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Text shown to a visitor who reached the cap; `null` for the default text." }, "max_attachments_per_message": { "description": "Files a visitor can attach to one message.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "name": { "description": "Name of the widget.", "type": "string" }, "standalone_url": { "description": "URL of the standalone chat page, with the token already set.", "type": "string" }, "token": { "description": "Public token of the widget; it goes in the snippet of the site.", "type": "string" }, "type": { "const": "widget", "description": "Object type, always `widget`.", "type": "string" }, "updated_at": { "description": "When the widget 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" }, "visitor_rate_limit": { "anyOf": [{ "description": "Cap of messages per visitor.", "properties": { "interval_seconds": { "description": "Length of the interval, in seconds (1 to 2592000, 30 days).", "maximum": 2592000, "minimum": 1, "type": "integer" }, "max_messages": { "description": "Messages one visitor can send in the interval (1 to 100000).", "maximum": 100000, "minimum": 1, "type": "integer" } }, "required": ["max_messages", "interval_seconds"], "type": "object" }, { "type": "null" }], "description": "Cap of messages per visitor; `null` when there is none." }, "web_widget_script": { "description": "Snippet of the chat bubble, ready to paste in the site: a `<script>` with the token and the base URL already set.", "type": "string" } }, "required": ["type", "id", "agent_id", "name", "token", "enabled", "allowed_domains", "allows_anonymous", "max_attachments_per_message", "visitor_rate_limit", "limit_reached_message", "appearance", "web_widget_script", "embed_iframe", "standalone_url", "created_at", "updated_at", "identity_secret"], "type": "object" } },
11
+ "agents.widgets.update": { "body": { "additionalProperties": false, "properties": { "allowed_domains": { "description": "Domains allowed to embed the widget (up to 50), like `example.com` or `*.example.com`. An empty list allows any site.", "items": { "maxLength": 253, "minLength": 1, "type": "string" }, "maxItems": 50, "type": "array" }, "allows_anonymous": { "default": true, "description": "Whether visitors can chat without an identity token. Defaults to true.", "type": "boolean" }, "appearance": { "additionalProperties": false, "description": "Look of the chat window. Every field is optional.", "properties": { "launcher_icon_url": { "description": "`https` URL of the image shown in the launcher button.", "format": "uri", "maxLength": 2048, "type": "string" }, "position": { "description": "Side of the screen where the launcher button sits.", "enum": ["left", "right"], "type": "string" }, "theme": { "description": "Color theme of the chat; `auto` follows the visitor system.", "enum": ["light", "dark", "auto"], "type": "string" }, "welcome_tagline": { "description": "Line shown under the title (up to 200 characters).", "maxLength": 200, "type": "string" }, "welcome_title": { "description": "Title shown at the top of the chat (up to 100 characters).", "maxLength": 100, "type": "string" }, "widget_color": { "description": "Main color of the widget, as a hex color like `#1f93ff`.", "pattern": "^#[0-9a-fA-F]{6}$", "type": "string" } }, "type": "object" }, "enabled": { "default": true, "description": "Whether the widget answers. Defaults to true.", "type": "boolean" }, "limit_reached_message": { "anyOf": [{ "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" }], "description": "Text shown to a visitor who reached the cap (1 to 500 characters); `null` for the default text." }, "max_attachments_per_message": { "default": 5, "description": "Files a visitor can attach to one message (1 to 10). Defaults to 5.", "maximum": 10, "minimum": 1, "type": "integer" }, "name": { "description": "Name of the widget (1 to 100 characters).", "maxLength": 100, "minLength": 1, "type": "string" }, "visitor_rate_limit": { "anyOf": [{ "additionalProperties": false, "description": "Cap of messages per visitor.", "properties": { "interval_seconds": { "description": "Length of the interval, in seconds (1 to 2592000, 30 days).", "maximum": 2592000, "minimum": 1, "type": "integer" }, "max_messages": { "description": "Messages one visitor can send in the interval (1 to 100000).", "maximum": 100000, "minimum": 1, "type": "integer" } }, "required": ["max_messages", "interval_seconds"], "type": "object" }, { "type": "null" }], "description": "Cap of messages per visitor; `null` removes the cap." } }, "type": "object" }, "response": { "properties": { "agent_id": { "description": "Id of the agent that answers in the widget.", "type": "string" }, "allowed_domains": { "description": "Domains allowed to embed the widget; an empty list allows any site.", "items": { "type": "string" }, "type": "array" }, "allows_anonymous": { "description": "Whether visitors can chat without the site identifying them with an identity token.", "type": "boolean" }, "appearance": { "description": "Look of the chat window. Every field is optional.", "properties": { "launcher_icon_url": { "description": "`https` URL of the image shown in the launcher button.", "format": "uri", "maxLength": 2048, "type": "string" }, "position": { "description": "Side of the screen where the launcher button sits.", "enum": ["left", "right"], "type": "string" }, "theme": { "description": "Color theme of the chat; `auto` follows the visitor system.", "enum": ["light", "dark", "auto"], "type": "string" }, "welcome_tagline": { "description": "Line shown under the title (up to 200 characters).", "maxLength": 200, "type": "string" }, "welcome_title": { "description": "Title shown at the top of the chat (up to 100 characters).", "maxLength": 100, "type": "string" }, "widget_color": { "description": "Main color of the widget, as a hex color like `#1f93ff`.", "pattern": "^#[0-9a-fA-F]{6}$", "type": "string" } }, "type": "object" }, "created_at": { "description": "When the widget 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" }, "embed_iframe": { "description": "`<iframe>` that shows the chat inside a page, with `mode=embedded` and `allow=\"microphone\"`.", "type": "string" }, "enabled": { "description": "Whether the widget answers. A turned-off widget behaves as if it did not exist.", "type": "boolean" }, "id": { "description": "Id of the widget.", "type": "string" }, "limit_reached_message": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Text shown to a visitor who reached the cap; `null` for the default text." }, "max_attachments_per_message": { "description": "Files a visitor can attach to one message.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "name": { "description": "Name of the widget.", "type": "string" }, "standalone_url": { "description": "URL of the standalone chat page, with the token already set.", "type": "string" }, "token": { "description": "Public token of the widget; it goes in the snippet of the site.", "type": "string" }, "type": { "const": "widget", "description": "Object type, always `widget`.", "type": "string" }, "updated_at": { "description": "When the widget 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" }, "visitor_rate_limit": { "anyOf": [{ "description": "Cap of messages per visitor.", "properties": { "interval_seconds": { "description": "Length of the interval, in seconds (1 to 2592000, 30 days).", "maximum": 2592000, "minimum": 1, "type": "integer" }, "max_messages": { "description": "Messages one visitor can send in the interval (1 to 100000).", "maximum": 100000, "minimum": 1, "type": "integer" } }, "required": ["max_messages", "interval_seconds"], "type": "object" }, { "type": "null" }], "description": "Cap of messages per visitor; `null` when there is none." }, "web_widget_script": { "description": "Snippet of the chat bubble, ready to paste in the site: a `<script>` with the token and the base URL already set.", "type": "string" } }, "required": ["type", "id", "agent_id", "name", "token", "enabled", "allowed_domains", "allows_anonymous", "max_attachments_per_message", "visitor_rate_limit", "limit_reached_message", "appearance", "web_widget_script", "embed_iframe", "standalone_url", "created_at", "updated_at"], "type": "object" } },
10
12
  "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" }, "warnings": { "description": "Present only on the response of the call that created the version, and only when there is something to note: a version identical to the latest one (`no_changes`).", "items": { "description": "A note about a version that was saved.", "properties": { "code": { "description": "`no_changes`: the new version is identical to the latest one.", "enum": ["no_changes"], "type": "string" }, "message": { "description": "What happened: that the new version is identical to the latest one.", "type": "string" } }, "required": ["code", "message"], "type": "object" }, "type": "array" } }, "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
13
  "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
14
  "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" }, "warnings": { "description": "Present only on the response of the call that created the version, and only when there is something to note: a version identical to the latest one (`no_changes`).", "items": { "description": "A note about a version that was saved.", "properties": { "code": { "description": "`no_changes`: the new version is identical to the latest one.", "enum": ["no_changes"], "type": "string" }, "message": { "description": "What happened: that the new version is identical to the latest one.", "type": "string" } }, "required": ["code", "message"], "type": "object" }, "type": "array" } }, "required": ["type", "id", "connection_id", "version_number", "url", "url_host", "headers", "changed_fields", "change_message", "created_by", "created_at", "is_active"], "type": "object" } },
@@ -14,6 +16,9 @@ export const OPERATION_SCHEMAS = {
14
16
  "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" }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Description from the SKILL.md of the active version, or of the latest version when none is active; `null` when the skill has no versions." }, "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", "description", "created_by", "created_at", "updated_at", "version", "warnings"], "type": "object" } },
15
17
  "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
18
  "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" } },
19
+ "threads.create": { "body": { "additionalProperties": false, "properties": { "agent_id": { "description": "Id of the agent that will answer in this thread. It cannot be an agent in conversational mode.", "minLength": 1, "type": "string" }, "channel": { "anyOf": [{ "additionalProperties": false, "description": "Link the thread to a WhatsApp conversation, so replies and follow-ups reach the customer. The conversation is created if it does not exist.", "properties": { "phone_number_id": { "description": "Id of the WhatsApp number (`phone_number_id` of Meta) that sent the template. It must be a WhatsApp number of your organization connected to this same agent.", "minLength": 1, "type": "string" }, "to": { "description": "Identifier of the customer that Meta returned when the template was sent: `contacts[0].wa_id` (digits only, no `+` or spaces) or `contacts[0].user_id` (a BSUID such as `AR.123456`). If Meta returns both, send the `wa_id`. Anything else is rejected.", "type": "string" }, "type": { "const": "whatsapp", "description": "Channel type, always `whatsapp`.", "type": "string" } }, "required": ["type", "phone_number_id", "to"], "type": "object" }, { "additionalProperties": false, "description": "Link the thread to a conversation of the CRM connected to the agent.", "properties": { "account_id": { "description": "Id of the account in the CRM that owns the conversation.", "minLength": 1, "type": "string" }, "conversation_id": { "description": "Id of the conversation in the CRM, as the CRM reports it. It is not the id of the contact nor one you make up: the template must have been sent through the CRM so that the conversation exists.", "minLength": 1, "type": "string" }, "type": { "const": "crm", "description": "Channel type, always `crm`.", "type": "string" } }, "required": ["type", "account_id", "conversation_id"], "type": "object" }, { "additionalProperties": false, "description": "Link the thread to a Chatwoot conversation of the agent.", "properties": { "conversation_id": { "description": "Id of the conversation in Chatwoot, as Chatwoot reports it. It is not the id of the contact nor one you make up: the template must have been sent through Chatwoot so that the conversation exists.", "minLength": 1, "type": "string" }, "type": { "const": "chatwoot", "description": "Channel type, always `chatwoot`.", "type": "string" } }, "required": ["type", "conversation_id"], "type": "object" }], "description": "The channel conversation the thread must be linked to. The channel type is the `type` field; each type accepts only its own fields." }, "contact": { "additionalProperties": false, "description": "Profile of the end user, used only when `resource` creates a new contact. Fields that clash with another contact are left out, without warning.", "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" }, "messages": { "description": "Messages to store when the thread is created, in the order you send them, with no limit on the number of messages, but the whole request body is capped at about 1 MB (a bigger one gets 413): send long histories in several calls. Storing messages does not run the agent: run it on this thread afterwards (`agents.generate` with `memory.thread`, or `laburen agents run --thread`).", "items": { "anyOf": [{ "additionalProperties": false, "description": "A message of the end user.", "properties": { "parts": { "description": "Content of the message: text parts and file parts, in order. A message needs some text or at least one file.", "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`. It must match the file content: if the content is recognizably of another type (for example a PNG declared as `application/pdf`), the request fails with `invalid_request` and `details.reason` `media_type_mismatch`.", "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` here.", "type": "string" } }, "required": ["role", "parts"], "type": "object" }, { "additionalProperties": false, "description": "A message of the agent.", "properties": { "parts": { "description": "Content of the message: text parts only. File parts are rejected in an `assistant` message.", "items": { "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" }, "minItems": 1, "type": "array" }, "role": { "const": "assistant", "description": "Author of the message, always `assistant` here.", "type": "string" } }, "required": ["role", "parts"], "type": "object" }], "description": "A message to store in the thread. `role` is `user` or `assistant`; `system` is not accepted because the engine builds the prompt." }, "minItems": 1, "type": "array" }, "metadata": { "additionalProperties": {}, "description": "Your own data about the conversation, as an object. It goes to the prompt of every turn, so the model reads it and it costs tokens each time. The key `prompt` is put first as plain text; the other keys go as JSON; `scratchpad` is not shown.", "propertyNames": { "type": "string" }, "type": "object" }, "resource": { "description": "Your own id for the end user (for example a customer id). The server creates or reuses the contact of that user. A later agent run on this thread with the same `resource` is accepted.", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": ["agent_id"], "type": "object" }, "response": { "properties": { "agent_id": { "description": "Id of the agent of the thread.", "type": "string" }, "channel": { "description": "Channel of the conversation. `crm` is the CRM connected to the agent.", "enum": ["api", "dashboard", "whatsapp", "crm", "chatwoot"], "type": "string" }, "created": { "description": "true when this call created the thread; false when it found the existing conversation of that channel.", "type": "boolean" }, "created_at": { "description": "When the thread 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" }, "id": { "description": "Id of the thread; the same id as `memory.thread` of an agent run.", "type": "string" }, "messages": { "description": "Messages stored by this call, in the order you sent them; empty when you sent none.", "items": { "properties": { "created_at": { "description": "When the message was stored (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" }, "id": { "description": "Id of the stored message.", "type": "string" }, "role": { "description": "Author of the message.", "enum": ["user", "assistant"], "type": "string" }, "thread_id": { "description": "Id of the thread the message was stored in.", "type": "string" }, "type": { "const": "thread_message", "description": "Object type, always `thread_message`.", "type": "string" } }, "required": ["type", "id", "thread_id", "role", "created_at"], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": {}, "description": "Your data about the conversation; `{}` when there is none.", "propertyNames": { "type": "string" }, "type": "object" }, "resource": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Your id for the end user (`resource`) of the contact that owns the thread; `null` when there is none." }, "type": { "const": "thread", "description": "Object type, always `thread`.", "type": "string" }, "updated_at": { "description": "When the thread 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", "agent_id", "channel", "resource", "metadata", "created_at", "updated_at", "created", "messages"], "type": "object" } },
20
+ "threads.messages.create": { "body": { "additionalProperties": false, "properties": { "messages": { "description": "Messages to add at the end of the thread, in the order you send them, with no limit on the number of messages, but the whole request body is capped at about 1 MB (a bigger one gets 413): send long histories in several calls. Storing them does not run the agent: run it on this thread afterwards (`agents.generate` with `memory.thread`, or `laburen agents run --thread`).", "items": { "anyOf": [{ "additionalProperties": false, "description": "A message of the end user.", "properties": { "parts": { "description": "Content of the message: text parts and file parts, in order. A message needs some text or at least one file.", "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`. It must match the file content: if the content is recognizably of another type (for example a PNG declared as `application/pdf`), the request fails with `invalid_request` and `details.reason` `media_type_mismatch`.", "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` here.", "type": "string" } }, "required": ["role", "parts"], "type": "object" }, { "additionalProperties": false, "description": "A message of the agent.", "properties": { "parts": { "description": "Content of the message: text parts only. File parts are rejected in an `assistant` message.", "items": { "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" }, "minItems": 1, "type": "array" }, "role": { "const": "assistant", "description": "Author of the message, always `assistant` here.", "type": "string" } }, "required": ["role", "parts"], "type": "object" }], "description": "A message to store in the thread. `role` is `user` or `assistant`; `system` is not accepted because the engine builds the prompt." }, "minItems": 1, "type": "array" } }, "required": ["messages"], "type": "object" }, "response": { "properties": { "messages": { "description": "Messages stored by this call, in the order you sent them.", "items": { "properties": { "created_at": { "description": "When the message was stored (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" }, "id": { "description": "Id of the stored message.", "type": "string" }, "role": { "description": "Author of the message.", "enum": ["user", "assistant"], "type": "string" }, "thread_id": { "description": "Id of the thread the message was stored in.", "type": "string" }, "type": { "const": "thread_message", "description": "Object type, always `thread_message`.", "type": "string" } }, "required": ["type", "id", "thread_id", "role", "created_at"], "type": "object" }, "type": "array" }, "type": { "const": "thread_messages_created", "description": "Object type, always `thread_messages_created`.", "type": "string" } }, "required": ["type", "messages"], "type": "object" } },
21
+ "threads.update": { "body": { "additionalProperties": false, "properties": { "metadata": { "additionalProperties": {}, "description": "Keys to change in the metadata. Merged by top-level key: the keys you send are set, the others stay. A key with `null` is deleted. A value that is an object replaces the previous value whole, it is not merged inside. The metadata goes to the prompt of every turn, so the model reads it and it costs tokens each time; the key `prompt` is put first as plain text. Without it (or with `{}`) nothing changes and the thread comes back as it is.", "propertyNames": { "type": "string" }, "type": "object" } }, "type": "object" }, "response": { "properties": { "agent_id": { "description": "Id of the agent of the thread.", "type": "string" }, "channel": { "description": "Channel of the conversation. `crm` is the CRM connected to the agent.", "enum": ["api", "dashboard", "whatsapp", "crm", "chatwoot"], "type": "string" }, "created_at": { "description": "When the thread 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" }, "id": { "description": "Id of the thread; the same id as `memory.thread` of an agent run.", "type": "string" }, "metadata": { "additionalProperties": {}, "description": "Your data about the conversation; `{}` when there is none.", "propertyNames": { "type": "string" }, "type": "object" }, "resource": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Your id for the end user (`resource`) of the contact that owns the thread; `null` when there is none." }, "type": { "const": "thread", "description": "Object type, always `thread`.", "type": "string" }, "updated_at": { "description": "When the thread 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", "agent_id", "channel", "resource", "metadata", "created_at", "updated_at"], "type": "object" } },
17
22
  "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
23
  "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
24
  };