# Public API > Version 1.0.0 ## Path Table | Method | Path | Description | | --- | --- | --- | | POST | [/api/v1/agents](#postapiv1agents) | | | GET | [/api/v1/agents](#getapiv1agents) | | | POST | [/api/v1/agents/{agentId}/mcps](#postapiv1agentsagentidmcps) | | | POST | [/api/v1/agents/{agentId}/tools](#postapiv1agentsagentidtools) | | | POST | [/api/v1/agents/{id}/execute](#postapiv1agentsidexecute) | | | DELETE | [/api/v1/agents/{id}](#deleteapiv1agentsid) | | | GET | [/api/v1/agents/{id}](#getapiv1agentsid) | | | PATCH | [/api/v1/agents/{id}](#patchapiv1agentsid) | | | DELETE | [/api/v1/agents/{agentId}/mcps/{mcpId}](#deleteapiv1agentsagentidmcpsmcpid) | | | DELETE | [/api/v1/agents/{agentId}/tools/{toolId}](#deleteapiv1agentsagentidtoolstoolid) | | | GET | [/api/v1/analytics/periodic-responder-chat-message-volume](#getapiv1analyticsperiodic-responder-chat-message-volume) | | | GET | [/api/v1/analytics/periodic-responder-credit-usage](#getapiv1analyticsperiodic-responder-credit-usage) | | | GET | [/api/v1/analytics/periodic-user-chat-message-average](#getapiv1analyticsperiodic-user-chat-message-average) | | | GET | [/api/v1/analytics/periodic-user-interactivity](#getapiv1analyticsperiodic-user-interactivity) | | | POST | [/api/v1/channels](#postapiv1channels) | | | GET | [/api/v1/channels](#getapiv1channels) | | | DELETE | [/api/v1/channels/{id}](#deleteapiv1channelsid) | | | GET | [/api/v1/channels/{id}](#getapiv1channelsid) | | | PATCH | [/api/v1/channels/{id}](#patchapiv1channelsid) | | | POST | [/api/v1/chat-message-follow-ups](#postapiv1chat-message-follow-ups) | | | GET | [/api/v1/chat-message-follow-ups](#getapiv1chat-message-follow-ups) | | | PATCH | [/api/v1/chat-message-follow-ups/{id}](#patchapiv1chat-message-follow-upsid) | | | POST | [/api/v1/chat-messages](#postapiv1chat-messages) | | | GET | [/api/v1/chat-messages](#getapiv1chat-messages) | | | POST | [/api/v1/chat-messages/export](#postapiv1chat-messagesexport) | | | POST | [/api/v1/chat-threads](#postapiv1chat-threads) | | | GET | [/api/v1/chat-threads](#getapiv1chat-threads) | | | GET | [/api/v1/chats/{id}/details](#getapiv1chatsiddetails) | | | GET | [/api/v1/chats/details](#getapiv1chatsdetails) | | | POST | [/api/v1/chats](#postapiv1chats) | | | GET | [/api/v1/chats](#getapiv1chats) | | | DELETE | [/api/v1/chats/{id}](#deleteapiv1chatsid) | | | GET | [/api/v1/chats/{id}](#getapiv1chatsid) | | | PATCH | [/api/v1/chats/{id}](#patchapiv1chatsid) | | | POST | [/api/v1/components](#postapiv1components) | | | GET | [/api/v1/components](#getapiv1components) | | | DELETE | [/api/v1/components/{id}](#deleteapiv1componentsid) | | | GET | [/api/v1/components/{id}](#getapiv1componentsid) | | | PATCH | [/api/v1/components/{id}](#patchapiv1componentsid) | | | GET | [/api/v1/connections](#getapiv1connections) | | | POST | [/api/v1/connections/{id}/send-message](#postapiv1connectionsidsend-message) | | | POST | [/api/v1/datagrid-columns](#postapiv1datagrid-columns) | | | GET | [/api/v1/datagrid-columns](#getapiv1datagrid-columns) | | | DELETE | [/api/v1/datagrid-columns/{id}](#deleteapiv1datagrid-columnsid) | | | PATCH | [/api/v1/datagrid-columns/{id}](#patchapiv1datagrid-columnsid) | | | POST | [/api/v1/datagrid-rows](#postapiv1datagrid-rows) | | | DELETE | [/api/v1/datagrid-rows](#deleteapiv1datagrid-rows) | | | GET | [/api/v1/datagrid-rows](#getapiv1datagrid-rows) | | | DELETE | [/api/v1/datagrid-rows/{id}](#deleteapiv1datagrid-rowsid) | | | GET | [/api/v1/datagrid-rows/{id}](#getapiv1datagrid-rowsid) | | | PATCH | [/api/v1/datagrid-rows/{id}](#patchapiv1datagrid-rowsid) | | | PATCH | [/api/v1/datagrid-values/{id}](#patchapiv1datagrid-valuesid) | | | POST | [/api/v1/datagrids](#postapiv1datagrids) | | | GET | [/api/v1/datagrids](#getapiv1datagrids) | | | DELETE | [/api/v1/datagrids/{id}](#deleteapiv1datagridsid) | | | GET | [/api/v1/datagrids/{id}](#getapiv1datagridsid) | | | PATCH | [/api/v1/datagrids/{id}](#patchapiv1datagridsid) | | | GET | [/api/v1/dataset-item-blocks](#getapiv1dataset-item-blocks) | | | POST | [/api/v1/dataset-items](#postapiv1dataset-items) | | | GET | [/api/v1/dataset-items](#getapiv1dataset-items) | | | DELETE | [/api/v1/dataset-items/{id}](#deleteapiv1dataset-itemsid) | | | GET | [/api/v1/dataset-items/{id}](#getapiv1dataset-itemsid) | | | PATCH | [/api/v1/dataset-items/{id}](#patchapiv1dataset-itemsid) | | | POST | [/api/v1/datasets](#postapiv1datasets) | | | GET | [/api/v1/datasets](#getapiv1datasets) | | | DELETE | [/api/v1/datasets/{id}](#deleteapiv1datasetsid) | | | GET | [/api/v1/datasets/{id}](#getapiv1datasetsid) | | | PATCH | [/api/v1/datasets/{id}](#patchapiv1datasetsid) | | | GET | [/api/v1/executions/nestings](#getapiv1executionsnestings) | | | GET | [/api/v1/executions/{id}](#getapiv1executionsid) | | | GET | [/api/v1/executions](#getapiv1executions) | | | POST | [/api/v1/external-user-groups](#postapiv1external-user-groups) | | | GET | [/api/v1/external-user-groups](#getapiv1external-user-groups) | | | DELETE | [/api/v1/external-user-groups/{id}](#deleteapiv1external-user-groupsid) | | | GET | [/api/v1/external-user-groups/{id}](#getapiv1external-user-groupsid) | | | PATCH | [/api/v1/external-user-groups/{id}](#patchapiv1external-user-groupsid) | | | POST | [/api/v1/external-users/authenticate](#postapiv1external-usersauthenticate) | | | POST | [/api/v1/external-users](#postapiv1external-users) | | | GET | [/api/v1/external-users](#getapiv1external-users) | | | GET | [/api/v1/external-users/{id}](#getapiv1external-usersid) | | | PATCH | [/api/v1/external-users/{id}](#patchapiv1external-usersid) | | | GET | [/api/v1/llm-providers/options](#getapiv1llm-providersoptions) | | | POST | [/api/v1/llm-providers](#postapiv1llm-providers) | | | GET | [/api/v1/llm-providers](#getapiv1llm-providers) | | | DELETE | [/api/v1/llm-providers/{id}](#deleteapiv1llm-providersid) | | | GET | [/api/v1/llm-providers/{id}](#getapiv1llm-providersid) | | | PATCH | [/api/v1/llm-providers/{id}](#patchapiv1llm-providersid) | | | GET | [/api/v1/mcps/options](#getapiv1mcpsoptions) | | | GET | [/api/v1/mcps/tool-options/{toolkit}](#getapiv1mcpstool-optionstoolkit) | | | POST | [/api/v1/mcps](#postapiv1mcps) | | | GET | [/api/v1/mcps](#getapiv1mcps) | | | DELETE | [/api/v1/mcps/{id}](#deleteapiv1mcpsid) | | | GET | [/api/v1/mcps/{id}](#getapiv1mcpsid) | | | PATCH | [/api/v1/mcps/{id}](#patchapiv1mcpsid) | | | POST | [/api/v1/squads](#postapiv1squads) | | | GET | [/api/v1/squads](#getapiv1squads) | | | POST | [/api/v1/squads/{squadId}/agents](#postapiv1squadssquadidagents) | | | POST | [/api/v1/squads/{id}/execute](#postapiv1squadsidexecute) | | | DELETE | [/api/v1/squads/{id}](#deleteapiv1squadsid) | | | GET | [/api/v1/squads/{id}](#getapiv1squadsid) | | | PATCH | [/api/v1/squads/{id}](#patchapiv1squadsid) | | | DELETE | [/api/v1/squads/{squadId}/agents/{agentId}](#deleteapiv1squadssquadidagentsagentid) | | | GET | [/api/v1/squads/{squadId}/agents/{agentId}](#getapiv1squadssquadidagentsagentid) | | | PATCH | [/api/v1/squads/{squadId}/agents/{agentId}](#patchapiv1squadssquadidagentsagentid) | | | GET | [/api/v1/super-identities/responders](#getapiv1super-identitiesresponders) | | | POST | [/api/v1/tags](#postapiv1tags) | | | GET | [/api/v1/tags](#getapiv1tags) | | | DELETE | [/api/v1/tags/{id}](#deleteapiv1tagsid) | | | GET | [/api/v1/tags/{id}](#getapiv1tagsid) | | | PATCH | [/api/v1/tags/{id}](#patchapiv1tagsid) | | | POST | [/api/v1/tasks](#postapiv1tasks) | | | GET | [/api/v1/tasks](#getapiv1tasks) | | | DELETE | [/api/v1/tasks/{id}](#deleteapiv1tasksid) | | | GET | [/api/v1/tasks/{id}](#getapiv1tasksid) | | | PATCH | [/api/v1/tasks/{id}](#patchapiv1tasksid) | | | POST | [/api/v1/ticketing-teams](#postapiv1ticketing-teams) | | | GET | [/api/v1/ticketing-teams](#getapiv1ticketing-teams) | | | POST | [/api/v1/ticketing-teams/{ticketingTeamId}/users](#postapiv1ticketing-teamsticketingteamidusers) | | | GET | [/api/v1/ticketing-teams/{ticketingTeamId}/users](#getapiv1ticketing-teamsticketingteamidusers) | | | PATCH | [/api/v1/ticketing-teams/{ticketingTeamId}/users](#patchapiv1ticketing-teamsticketingteamidusers) | | | DELETE | [/api/v1/ticketing-teams/{id}](#deleteapiv1ticketing-teamsid) | | | GET | [/api/v1/ticketing-teams/{id}](#getapiv1ticketing-teamsid) | | | PATCH | [/api/v1/ticketing-teams/{id}](#patchapiv1ticketing-teamsid) | | | DELETE | [/api/v1/ticketing-teams/{ticketingTeamId}/users/{userId}](#deleteapiv1ticketing-teamsticketingteamidusersuserid) | | | GET | [/api/v1/tickets/{id}/details](#getapiv1ticketsiddetails) | | | GET | [/api/v1/tickets/details](#getapiv1ticketsdetails) | | | PATCH | [/api/v1/tickets/{id}/complete](#patchapiv1ticketsidcomplete) | | | POST | [/api/v1/tickets](#postapiv1tickets) | | | POST | [/api/v1/tickets/{ticketId}/tags](#postapiv1ticketsticketidtags) | | | DELETE | [/api/v1/tickets/{ticketId}/tags/{tagId}](#deleteapiv1ticketsticketidtagstagid) | | | PATCH | [/api/v1/tickets/{id}/takeover](#patchapiv1ticketsidtakeover) | | | PATCH | [/api/v1/tickets/{id}/assignee](#patchapiv1ticketsidassignee) | | | POST | [/api/v1/tiers](#postapiv1tiers) | | | GET | [/api/v1/tiers](#getapiv1tiers) | | | DELETE | [/api/v1/tiers/{id}](#deleteapiv1tiersid) | | | GET | [/api/v1/tiers/{id}](#getapiv1tiersid) | | | PATCH | [/api/v1/tiers/{id}](#patchapiv1tiersid) | | | POST | [/api/v1/tools](#postapiv1tools) | | | GET | [/api/v1/tools](#getapiv1tools) | | | DELETE | [/api/v1/tools/{id}](#deleteapiv1toolsid) | | | GET | [/api/v1/tools/{id}](#getapiv1toolsid) | | | GET | [/api/v1/versions/check-creation-balance](#getapiv1versionscheck-creation-balance) | | | POST | [/api/v1/versions/deploy](#postapiv1versionsdeploy) | | | GET | [/api/v1/versions/diff](#getapiv1versionsdiff) | | | GET | [/api/v1/versions](#getapiv1versions) | | | POST | [/api/v1/versions/rollback](#postapiv1versionsrollback) | | | GET | [/api/v1/voices/options](#getapiv1voicesoptions) | | ## Reference Table | Name | Path | Description | | --- | --- | --- | ## Path Details *** ### [POST]/api/v1/agents - Description Creates a new agent. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] } ``` #### Responses - 200 The agent was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 403 Plan limit exceeded. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/agents - Description Retrieves multiple agents. #### Parameters(Query) ```typescript joins?: Partial(enum[squads][]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript referenceIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // Search term to filter agents by name, internal name, role, or prompt. search?: string ``` ```typescript squadIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript versionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all agents for the workspace. `application/json` ```typescript undefined?: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string squadAgents: { createdAt: string updatedAt: string // A UUID v4 string that identifies an entity. agentId: string // A UUID v4 string that identifies an entity. squadId: string type: enum[member, main] squad: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string } }[] }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string })[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/agents/{agentId}/mcps - Description Creates a new MCP or attaches an existing one to an agent. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript undefined?: Partial({ mcp: { // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string } }) & Partial({ // A UUID v4 string that identifies an entity. mcpId: string }) ``` #### Responses - 200 The MCP was created or linked to the agent. `application/json` ```typescript { createdAt: string updatedAt: string // The id of the agent to link the MCP to. agentId: string // The id of the MCP to link to the agent. mcpId: string mcp: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string // The workspace ID that owns the MCP. workspaceId: string } } ``` - 400 Connection type is not compatible with MCP type. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The agent, MCP, or connection was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 MCP is already associated with this agent. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/agents/{agentId}/tools - Description Creates a new tool or attaches an existing one to an agent. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript undefined?: Partial({ tool: { // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string } }) & Partial({ // A UUID v4 string that identifies an entity. toolId: string }) ``` #### Responses - 200 The tool was created or linked to the agent. `application/json` ```typescript { createdAt: string updatedAt: string // The id of the agent to link the tool to. agentId: string // The id of the tool to link to the agent. toolId: string tool: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string } } ``` - 400 Invalid tool configuration. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The agent or tool was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/agents/{id}/execute - Description Executes an agent with provided messages. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { context?: string messages: { attachments?: { // A base64 encoded string with prefix. base64: string extension: enum[png] } | { // A base64 encoded string with prefix. base64: string extension: enum[pdf] name?: string }[] content: string role: Partial(string) & Partial(string) }[] // A JSON Schema definition object output: { properties: { } required?: string[] type: enum[object] } } ``` #### Responses - 200 The agent was executed. `application/json` ```typescript { attachmentsUrls?: string[] content: Partial(string) & Partial({ }) execution: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The total number of credits used by this execution. creditsUsed: number // The execution detail containing type-specific information. detail: Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this agent execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The execution detail subtype represented by this payload. type: enum[agent-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this squad execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The squad identifier. squadId: string // The execution detail subtype represented by this payload. type: enum[squad-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } events: { // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of workflow node. nodeType: string // The event subtype represented by this payload. type: enum[workflow-node] // The workflow node identifier. workflowNodeId: string }[] // The origin of this workflow execution. origin: Partial({ // The execution origin subtype represented by this payload. type: enum[webhook-request] // The workflow trigger identifier. workflowTriggerId: string }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agent-tool-request] // The workflow trigger identifier. workflowTriggerId: string }) // The execution detail subtype represented by this payload. type: enum[workflow-execution] // The workflow identifier. workflowId: string // The workflow implementation identifier. workflowImplementationId: string }) // When this execution ended. endedAt: string // Whether this execution has been purged. isPurged: boolean // The parent execution ID of this execution. parentId: string // The responder ID of this execution. responderId: string // When this execution started. startedAt: string // The status of the execution. status: enum[running, completed, failed, cancelled] // The workspace ID of this execution. workspaceId: string } } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Agent not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/agents/{id} - Description Removes an agent. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The agent was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Agent not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Precondition failed. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/agents/{id} - Description Retrieves an agent. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves an agent. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Agent not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/agents/{id} - Description Updates an agent. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime?: boolean // The internal name of the agent. For internal use only. internalName?: string // The number of iterations (steps) the agent can execute in a single execution. iterations?: number // The LLM model key to use for the agent. llm?: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId?: string // The name of the agent. name?: string // The picture of the agent. picture?: string // Whether the agent should plan before each execution. planning?: boolean // The main description of the agent's behavior. prompt?: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode?: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role?: string // The super identity ID associated with the agent. superIdentityId?: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature?: number // The timezone to use for the agent. If null, no timezone will be used. timezone?: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount?: integer // The TTS voice for audio responses. Null to disable. voiceId?: string } ``` #### Responses - 200 The agent was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Agent not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/agents/{agentId}/mcps/{mcpId} - Description Detaches an MCP from an agent. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The MCP was removed from the agent. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Agent or MCP not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/agents/{agentId}/tools/{toolId} - Description Detaches a tool from an agent. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The tool was removed from the agent. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Agent or tool not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/analytics/periodic-responder-chat-message-volume - Description Retrieves periodic responder chat message volume analytics. #### Parameters(Query) ```typescript granularity: enum[hourly, daily, weekly, monthly] ``` ```typescript rangeEnd?: string ``` ```typescript rangeStart?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Responder chat message volume analytics retrieved successfully. `application/json` ```typescript { channelId: string channelName: string channelType: enum[api, widget, waha, whatsapp, instagram] count: integer periodEnd: string periodStart: string responderEntity: enum[agents, squads] responderId: string responderName: string responderPicture: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/analytics/periodic-responder-credit-usage - Description Retrieves periodic responder credit usage analytics. #### Parameters(Query) ```typescript granularity: enum[hourly, daily, weekly, monthly] ``` ```typescript rangeEnd?: string ``` ```typescript rangeStart?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Responder credit usage analytics retrieved successfully. `application/json` ```typescript { credits: number periodEnd: string periodStart: string responderEntity: enum[agents, squads] responderId: string responderName: string responderPicture: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/analytics/periodic-user-chat-message-average - Description Retrieves periodic user chat message average analytics. #### Parameters(Query) ```typescript granularity: enum[hourly, daily, weekly, monthly] ``` ```typescript rangeEnd?: string ``` ```typescript rangeStart?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 User chat message average analytics retrieved successfully. `application/json` ```typescript { average: number channelId: string channelName: string channelType: enum[api, widget, waha, whatsapp, instagram] periodEnd: string periodStart: string responderEntity: enum[agents, squads] responderId: string responderName: string responderPicture: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/analytics/periodic-user-interactivity - Description Retrieves periodic user interactivity analytics. #### Parameters(Query) ```typescript granularity: enum[hourly, daily, weekly, monthly] ``` ```typescript rangeEnd?: string ``` ```typescript rangeStart?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 User interactivity analytics retrieved successfully. `application/json` ```typescript { channelId: string channelName: string channelType: enum[api, widget, waha, whatsapp, instagram] count: integer periodEnd: string periodStart: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/channels - Description Creates a new channel. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The delay between the last user message and the beginning of the response generation. delay: integer // The internal description of the channel. description: string detail: Partial({ // The initial message to be displayed when the API is used. initialMessage: string // The webhook URL that receives responses produced through the API channel. responseWebhookUrl: string // The channel subtype represented by this detail payload. type: enum[api] }) & Partial({ // Whether registering tools from the widget's parent page is allowed. allowClientSideMcp: boolean // The initial message to be displayed when the widget is opened. initialMessage: string // The level of detail to be included in the loading message when the widget is opened. loading: enum[private, named, explained] // Whether the widget should be opened automatically when the page is loaded. openOnLoad: boolean // The widget theme palette configuration for the channel. themes: { dark: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } light: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } } // The channel subtype represented by this detail payload. type: enum[widget] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[waha] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected WhatsApp account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[whatsapp] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Instagram account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[instagram] }) maxAssistantMessagesPerChatOwner: integer // The display name of the channel. name: string // A prompt to be passed down to the agent in the context of this channel. prompt: string // The super identity of the responder (agents or squads) of the channel responderId: string // Whether to display sender names in chat messages. showSenderName: boolean // The lifecycle status of the channel. status: enum[active, inactive] // The voice behavior mode configured for the channel. useVoice: enum[on-audio/without-transcription, on-audio/with-transcription, always/without-transcription, always/with-transcription, never] } ``` #### Responses - 200 The channel was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The delay between the last user message and the beginning of the response generation. delay: integer // The internal description of the channel. description: string detail: Partial({ // The initial message to be displayed when the API is used. initialMessage: string // The webhook URL that receives responses produced through the API channel. responseWebhookUrl: string // The channel subtype represented by this detail payload. type: enum[api] }) & Partial({ // Whether registering tools from the widget's parent page is allowed. allowClientSideMcp: boolean // The initial message to be displayed when the widget is opened. initialMessage: string // The level of detail to be included in the loading message when the widget is opened. loading: enum[private, named, explained] // Whether the widget should be opened automatically when the page is loaded. openOnLoad: boolean // The widget theme palette configuration for the channel. themes: { dark: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } light: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } } // The channel subtype represented by this detail payload. type: enum[widget] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[waha] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected WhatsApp account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[whatsapp] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Instagram account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[instagram] }) maxAssistantMessagesPerChatOwner: integer // The display name of the channel. name: string // A prompt to be passed down to the agent in the context of this channel. prompt: string // The super identity of the responder (agents or squads) of the channel responderId: string // Whether to display sender names in chat messages. showSenderName: boolean // The lifecycle status of the channel. status: enum[active, inactive] // The voice behavior mode configured for the channel. useVoice: enum[on-audio/without-transcription, on-audio/with-transcription, always/without-transcription, always/with-transcription, never] // The workspace ID that owns the channel. workspaceId: string } ``` - 400 Invalid channel configuration. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 403 Plan limit exceeded. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Resource not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 409 A channel for this connection already exists. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/channels - Description Retrieves multiple channels. #### Parameters(Query) ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript responderIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // Search term to filter channels by name, description, or prompt. search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all channels for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The delay between the last user message and the beginning of the response generation. delay: integer // The internal description of the channel. description: string detail: Partial({ // The initial message to be displayed when the API is used. initialMessage: string // The webhook URL that receives responses produced through the API channel. responseWebhookUrl: string // The channel subtype represented by this detail payload. type: enum[api] }) & Partial({ // Whether registering tools from the widget's parent page is allowed. allowClientSideMcp: boolean // The initial message to be displayed when the widget is opened. initialMessage: string // The level of detail to be included in the loading message when the widget is opened. loading: enum[private, named, explained] // Whether the widget should be opened automatically when the page is loaded. openOnLoad: boolean // The widget theme palette configuration for the channel. themes: { dark: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } light: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } } // The channel subtype represented by this detail payload. type: enum[widget] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[waha] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected WhatsApp account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[whatsapp] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Instagram account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[instagram] }) maxAssistantMessagesPerChatOwner: integer // The display name of the channel. name: string // A prompt to be passed down to the agent in the context of this channel. prompt: string // The super identity of the responder (agents or squads) of the channel responderId: string // Whether to display sender names in chat messages. showSenderName: boolean // The lifecycle status of the channel. status: enum[active, inactive] // The voice behavior mode configured for the channel. useVoice: enum[on-audio/without-transcription, on-audio/with-transcription, always/without-transcription, always/with-transcription, never] // The workspace ID that owns the channel. workspaceId: string }[] ``` - 400 Bad Request. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/channels/{id} - Description Removes a channel. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The channel was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Channel not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/channels/{id} - Description Retrieves a channel. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a channel. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The delay between the last user message and the beginning of the response generation. delay: integer // The internal description of the channel. description: string detail: Partial({ // The initial message to be displayed when the API is used. initialMessage: string // The webhook URL that receives responses produced through the API channel. responseWebhookUrl: string // The channel subtype represented by this detail payload. type: enum[api] }) & Partial({ // Whether registering tools from the widget's parent page is allowed. allowClientSideMcp: boolean // The initial message to be displayed when the widget is opened. initialMessage: string // The level of detail to be included in the loading message when the widget is opened. loading: enum[private, named, explained] // Whether the widget should be opened automatically when the page is loaded. openOnLoad: boolean // The widget theme palette configuration for the channel. themes: { dark: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } light: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } } // The channel subtype represented by this detail payload. type: enum[widget] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[waha] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected WhatsApp account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[whatsapp] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Instagram account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[instagram] }) maxAssistantMessagesPerChatOwner: integer // The display name of the channel. name: string // A prompt to be passed down to the agent in the context of this channel. prompt: string // The super identity of the responder (agents or squads) of the channel responderId: string // Whether to display sender names in chat messages. showSenderName: boolean // The lifecycle status of the channel. status: enum[active, inactive] // The voice behavior mode configured for the channel. useVoice: enum[on-audio/without-transcription, on-audio/with-transcription, always/without-transcription, always/with-transcription, never] // The workspace ID that owns the channel. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Channel not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/channels/{id} - Description Updates a channel. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The delay between the last user message and the beginning of the response generation. delay?: integer // The internal description of the channel. description?: string detail?: Partial({ // The initial message to be displayed when the API is used. initialMessage: string // The webhook URL that receives responses produced through the API channel. responseWebhookUrl: string // The channel subtype represented by this detail payload. type: enum[api] }) & Partial({ // Whether registering tools from the widget's parent page is allowed. allowClientSideMcp: boolean // The initial message to be displayed when the widget is opened. initialMessage: string // The level of detail to be included in the loading message when the widget is opened. loading: enum[private, named, explained] // Whether the widget should be opened automatically when the page is loaded. openOnLoad: boolean // The widget theme palette configuration for the channel. themes: { dark: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } light: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } } // The channel subtype represented by this detail payload. type: enum[widget] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[waha] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected WhatsApp account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[whatsapp] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Instagram account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[instagram] }) maxAssistantMessagesPerChatOwner?: integer // The display name of the channel. name?: string // A prompt to be passed down to the agent in the context of this channel. prompt?: string // The super identity of the responder (agents or squads) of the channel responderId?: string // Whether to display sender names in chat messages. showSenderName?: boolean // The lifecycle status of the channel. status?: enum[active, inactive] // The voice behavior mode configured for the channel. useVoice?: enum[on-audio/without-transcription, on-audio/with-transcription, always/without-transcription, always/with-transcription, never] } ``` #### Responses - 200 The channel was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The delay between the last user message and the beginning of the response generation. delay: integer // The internal description of the channel. description: string detail: Partial({ // The initial message to be displayed when the API is used. initialMessage: string // The webhook URL that receives responses produced through the API channel. responseWebhookUrl: string // The channel subtype represented by this detail payload. type: enum[api] }) & Partial({ // Whether registering tools from the widget's parent page is allowed. allowClientSideMcp: boolean // The initial message to be displayed when the widget is opened. initialMessage: string // The level of detail to be included in the loading message when the widget is opened. loading: enum[private, named, explained] // Whether the widget should be opened automatically when the page is loaded. openOnLoad: boolean // The widget theme palette configuration for the channel. themes: { dark: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } light: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } } // The channel subtype represented by this detail payload. type: enum[widget] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[waha] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected WhatsApp account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[whatsapp] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Instagram account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[instagram] }) maxAssistantMessagesPerChatOwner: integer // The display name of the channel. name: string // A prompt to be passed down to the agent in the context of this channel. prompt: string // The super identity of the responder (agents or squads) of the channel responderId: string // Whether to display sender names in chat messages. showSenderName: boolean // The lifecycle status of the channel. status: enum[active, inactive] // The voice behavior mode configured for the channel. useVoice: enum[on-audio/without-transcription, on-audio/with-transcription, always/without-transcription, always/with-transcription, never] // The workspace ID that owns the channel. workspaceId: string } ``` - 400 Invalid data provided. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Channel not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/chat-message-follow-ups - Description Creates a chat message follow-up. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The id of the chat this follow-up belongs to. chatId: string // The date and time when the follow-up message should be sent. dueDate: string // The follow-up message content. message: string } ``` #### Responses - 201 The chat message follow-up was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The id of the chat this follow-up belongs to. chatId: string // The id of the chat message this follow-up belongs to. chatMessageId: string // The date and time when the follow-up message should be sent. dueDate: string // The date and time when the follow-up went from pending to any other status. finishedAt: string // The follow-up message content. message: string // The reason why the follow-up failed. reason: string // The current status of the follow-up. status: enum[pending, sent, failed, cancelled] // The id of the chat message that triggered the follow-up. triggerChatMessageId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The chat was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 The chat has no messages or the last message is from the user. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/chat-message-follow-ups - Description Retrieves multiple chat message follow-ups. #### Parameters(Query) ```typescript chatIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript chatMessageIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript statuses?: Partial( // The current status of the follow-up. enum[pending, sent, failed, cancelled][]) & Partial(string) ``` ```typescript triggerChatMessageIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all chat message follow-ups for the specified filters. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The id of the chat this follow-up belongs to. chatId: string // The id of the chat message this follow-up belongs to. chatMessageId: string // The date and time when the follow-up message should be sent. dueDate: string // The date and time when the follow-up went from pending to any other status. finishedAt: string // The follow-up message content. message: string // The reason why the follow-up failed. reason: string // The current status of the follow-up. status: enum[pending, sent, failed, cancelled] // The id of the chat message that triggered the follow-up. triggerChatMessageId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/chat-message-follow-ups/{id} - Description Updates a chat message follow-up. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The id of the chat this follow-up belongs to. chatId?: string // The id of the chat message this follow-up belongs to. chatMessageId?: string // The date and time when the follow-up message should be sent. dueDate?: string // The date and time when the follow-up went from pending to any other status. finishedAt?: string // The follow-up message content. message?: string // The reason why the follow-up failed. reason?: string status?: enum[cancelled] // The id of the chat message that triggered the follow-up. triggerChatMessageId?: string } ``` #### Responses - 200 The chat message follow-up was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The id of the chat this follow-up belongs to. chatId: string // The id of the chat message this follow-up belongs to. chatMessageId: string // The date and time when the follow-up message should be sent. dueDate: string // The date and time when the follow-up went from pending to any other status. finishedAt: string // The follow-up message content. message: string // The reason why the follow-up failed. reason: string // The current status of the follow-up. status: enum[pending, sent, failed, cancelled] // The id of the chat message that triggered the follow-up. triggerChatMessageId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The chat message follow-up was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Only pending follow-ups can be updated. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/chat-messages - Description Creates a new chat message. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The chat ID associated with the message. chatId: string // The id of the chat thread that the message belongs to. chatThreadId: string content: string // External reference in the integrated system. externalId: string // A UUID v4 string that identifies an entity. senderId: string // The structured detail payload submitted when creating the chat message. detail: { attachments?: Partial({ // The file identifier or path. file: string // The attachment subtype represented by this payload. extension: enum[png] // The display name of the PNG file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment subtype represented by this payload. extension: enum[pdf] // The display name of the PDF file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment subtype represented by this payload. extension: enum[wav] // The mode of the audio attachment. "attachment" sends it as an attachment and "message" sends it as the main message. mode: enum[attachment, message] })[] } // The role allowed when creating the chat message. role: enum[user, support] } ``` #### Responses - 200 The chat message was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The chat ID associated with the message. chatId: string // The id of the chat thread that the message belongs to. chatThreadId: string // The content of the message. content: string // The structured detail payload associated with the message. detail: { attachments?: Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PNG image. description: string // The attachment subtype represented by this payload. extension: enum[png] // The display name of the PNG file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PDF file. description: string // The attachment subtype represented by this payload. extension: enum[pdf] // The display name of the PDF file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The attachment subtype represented by this payload. extension: enum[wav] // The mode of the audio attachment. "attachment" sends it as an attachment and "message" sends it as the main message. mode: enum[attachment, message] // The summary of the audio file. summary: string // The transcription of the audio file. transcription: string })[] delivery?: { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // External reference in the integrated system. externalId: string // The delivery status represented by this payload. status: enum[sent] } | { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // The delivery status represented by this payload. status: enum[failed] }[] } // External reference in the integrated system. externalId: string // The raw content of the message as it was generated by the assistant. rawContent: string // The role of the actor that produced the message. role: enum[user, assistant, support, system] // The super identity ID of the sender (agents, squads, users or external users) of the message. senderId: string } ``` - 400 Invalid data provided. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 403 You are not authorized to create the chat message. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Chat not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/chat-messages - Description Retrieves multiple chat messages. #### Parameters(Query) ```typescript // A UUID v4 string that identifies an entity. chatId: string ``` ```typescript // A UUID v4 string that identifies an entity. chatThreadId?: string ``` ```typescript joins?: Partial(enum[chat-message-follow-ups, senders][]) & Partial(string) ``` ```typescript pagination: { limit?: number //default: 250 } ``` ```typescript ticketIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all chat messages for the specified chat. `application/json` ```typescript undefined?: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The chat ID associated with the message. chatId: string // The id of the chat thread that the message belongs to. chatThreadId: string // The content of the message. content: string // The structured detail payload associated with the message. detail: { attachments?: Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PNG image. description: string // The attachment subtype represented by this payload. extension: enum[png] // The display name of the PNG file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PDF file. description: string // The attachment subtype represented by this payload. extension: enum[pdf] // The display name of the PDF file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The attachment subtype represented by this payload. extension: enum[wav] // The mode of the audio attachment. "attachment" sends it as an attachment and "message" sends it as the main message. mode: enum[attachment, message] // The summary of the audio file. summary: string // The transcription of the audio file. transcription: string })[] delivery?: { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // External reference in the integrated system. externalId: string // The delivery status represented by this payload. status: enum[sent] } | { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // The delivery status represented by this payload. status: enum[failed] }[] } // External reference in the integrated system. externalId: string // The raw content of the message as it was generated by the assistant. rawContent: string // The role of the actor that produced the message. role: enum[user, assistant, support, system] // The super identity ID of the sender (agents, squads, users or external users) of the message. senderId: string chatMessageFollowUp: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The id of the chat this follow-up belongs to. chatId: string // The id of the chat message this follow-up belongs to. chatMessageId: string // The date and time when the follow-up message should be sent. dueDate: string // The date and time when the follow-up went from pending to any other status. finishedAt: string // The follow-up message content. message: string // The reason why the follow-up failed. reason: string // The current status of the follow-up. status: enum[pending, sent, failed, cancelled] // The id of the chat message that triggered the follow-up. triggerChatMessageId: string } senderSuperIdentity: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string entity: enum[agents, squads, users, externalUsers, workflows] sender: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The brand ID associated with the user. brandId: string // The external client reference ID associated with the user. clientReferenceId: string // The email address of the user. email: string // The email verification status of the user. emailStatus: enum[pending, verified] // When the user first accessed the platform. firstAccessAt: string // The GTM parameters to be used in tracking events for the user. gtm: { } // The preferred language configured for the user. language: enum[enUs, ptBr] // When the user last authenticated. lastAuthenticationAt: string // The display name of the user. name: string phoneNumber: string // The picture associated with the user. picture: string // The super identity ID associated with the user. superIdentityId: string }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // Whether the external user is blocked. blocked: boolean // The ID of the channel associated with the external user. channelId: string // External reference in the integrated system. externalId: string // The ID of the external user group associated with the external user. externalUserGroupId: string // A unique identifier of the external user (usernames, emails, phone numbers and etc). identifier: string // The display name of the external user. name: string // The ID of the super identity associated with the external user. superIdentityId: string // The ID of the tier associated with the external user. tierId: string // The ID of the workspace associated with the external user. workspaceId: string }) } }[]) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The chat ID associated with the message. chatId: string // The id of the chat thread that the message belongs to. chatThreadId: string // The content of the message. content: string // The structured detail payload associated with the message. detail: { attachments?: Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PNG image. description: string // The attachment subtype represented by this payload. extension: enum[png] // The display name of the PNG file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PDF file. description: string // The attachment subtype represented by this payload. extension: enum[pdf] // The display name of the PDF file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The attachment subtype represented by this payload. extension: enum[wav] // The mode of the audio attachment. "attachment" sends it as an attachment and "message" sends it as the main message. mode: enum[attachment, message] // The summary of the audio file. summary: string // The transcription of the audio file. transcription: string })[] delivery?: { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // External reference in the integrated system. externalId: string // The delivery status represented by this payload. status: enum[sent] } | { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // The delivery status represented by this payload. status: enum[failed] }[] } // External reference in the integrated system. externalId: string // The raw content of the message as it was generated by the assistant. rawContent: string // The role of the actor that produced the message. role: enum[user, assistant, support, system] // The super identity ID of the sender (agents, squads, users or external users) of the message. senderId: string senderSuperIdentity: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string entity: enum[agents, squads, users, externalUsers, workflows] sender: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The brand ID associated with the user. brandId: string // The external client reference ID associated with the user. clientReferenceId: string // The email address of the user. email: string // The email verification status of the user. emailStatus: enum[pending, verified] // When the user first accessed the platform. firstAccessAt: string // The GTM parameters to be used in tracking events for the user. gtm: { } // The preferred language configured for the user. language: enum[enUs, ptBr] // When the user last authenticated. lastAuthenticationAt: string // The display name of the user. name: string phoneNumber: string // The picture associated with the user. picture: string // The super identity ID associated with the user. superIdentityId: string }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // Whether the external user is blocked. blocked: boolean // The ID of the channel associated with the external user. channelId: string // External reference in the integrated system. externalId: string // The ID of the external user group associated with the external user. externalUserGroupId: string // A unique identifier of the external user (usernames, emails, phone numbers and etc). identifier: string // The display name of the external user. name: string // The ID of the super identity associated with the external user. superIdentityId: string // The ID of the tier associated with the external user. tierId: string // The ID of the workspace associated with the external user. workspaceId: string }) } }[]) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The chat ID associated with the message. chatId: string // The id of the chat thread that the message belongs to. chatThreadId: string // The content of the message. content: string // The structured detail payload associated with the message. detail: { attachments?: Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PNG image. description: string // The attachment subtype represented by this payload. extension: enum[png] // The display name of the PNG file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PDF file. description: string // The attachment subtype represented by this payload. extension: enum[pdf] // The display name of the PDF file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The attachment subtype represented by this payload. extension: enum[wav] // The mode of the audio attachment. "attachment" sends it as an attachment and "message" sends it as the main message. mode: enum[attachment, message] // The summary of the audio file. summary: string // The transcription of the audio file. transcription: string })[] delivery?: { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // External reference in the integrated system. externalId: string // The delivery status represented by this payload. status: enum[sent] } | { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // The delivery status represented by this payload. status: enum[failed] }[] } // External reference in the integrated system. externalId: string // The raw content of the message as it was generated by the assistant. rawContent: string // The role of the actor that produced the message. role: enum[user, assistant, support, system] // The super identity ID of the sender (agents, squads, users or external users) of the message. senderId: string chatMessageFollowUp: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The id of the chat this follow-up belongs to. chatId: string // The id of the chat message this follow-up belongs to. chatMessageId: string // The date and time when the follow-up message should be sent. dueDate: string // The date and time when the follow-up went from pending to any other status. finishedAt: string // The follow-up message content. message: string // The reason why the follow-up failed. reason: string // The current status of the follow-up. status: enum[pending, sent, failed, cancelled] // The id of the chat message that triggered the follow-up. triggerChatMessageId: string } }[]) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The chat ID associated with the message. chatId: string // The id of the chat thread that the message belongs to. chatThreadId: string // The content of the message. content: string // The structured detail payload associated with the message. detail: { attachments?: Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PNG image. description: string // The attachment subtype represented by this payload. extension: enum[png] // The display name of the PNG file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The description of the PDF file. description: string // The attachment subtype represented by this payload. extension: enum[pdf] // The display name of the PDF file. name: string }) & Partial({ // The file identifier or path. file: string // The attachment ID associated with this payload. id: string // The attachment subtype represented by this payload. extension: enum[wav] // The mode of the audio attachment. "attachment" sends it as an attachment and "message" sends it as the main message. mode: enum[attachment, message] // The summary of the audio file. summary: string // The transcription of the audio file. transcription: string })[] delivery?: { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // External reference in the integrated system. externalId: string // The delivery status represented by this payload. status: enum[sent] } | { // The content payload delivered through the external provider. content: Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] // The text chunk included in the delivery payload. text: string }) & Partial({ // The text chunk included in the delivery payload. text: string }) & Partial({ // A UUID v4 string that identifies an entity. attachmentsIds?: string[] }) // The external provider that received the delivery payload. provider: enum[waha, whatsapp, instagram] // When the delivery payload was recorded. timestamp: string // The delivery status represented by this payload. status: enum[failed] }[] } // External reference in the integrated system. externalId: string // The raw content of the message as it was generated by the assistant. rawContent: string // The role of the actor that produced the message. role: enum[user, assistant, support, system] // The super identity ID of the sender (agents, squads, users or external users) of the message. senderId: string }[]) ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Chat not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/chat-messages/export - Description Exports chat messages for a given period. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The end date of the export period. Defaults to current date. rangeEnd?: string // The start date of the export period. rangeStart: string // A safe callback URL that must be HTTPS and point to a public server. callbackUrl: string language?: enum[enUs, ptBr] //default: enUs } ``` #### Responses - 200 Export started. A POST will be made to callbackUrl when ready. `application/json` ```typescript { message: string } ``` - 412 The export period exceeds the maximum of 6 months. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/chat-threads - Description Creates a new chat thread. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. chatId: string // A UUID v4 string that identifies an entity. chatMessageId: string } ``` #### Responses - 200 The chat thread was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. chatId: string // A UUID v4 string that identifies an entity. chatMessageId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Chat or chat message not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/chat-threads - Description Retrieves multiple chat threads. #### Parameters(Query) ```typescript // A UUID v4 string that identifies an entity. chatId: string ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all chat threads for the specified chat. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. chatId: string // A UUID v4 string that identifies an entity. chatMessageId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/chats/{id}/details - Description Retrieves a chat with details. #### Parameters(Query) ```typescript responderVersionId?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a chat. `application/json` ```typescript { // The channel ID associated with the chat. channelId: string // The display name of the channel associated with the chat. channelName: string // The type of the channel associated with the chat. channelType: enum[api, widget, waha, whatsapp, instagram, ] // When the chat was created. createdAt: string // The chat ID represented by this row. id: string // Whether the external chat owner is blocked. isOwnerBlocked: boolean // Whether the chat has been soft removed. isRemoved: boolean // The content preview of the latest message in the chat. lastMessageContent: string // When the latest message in the chat was created. lastMessageCreatedAt: string // The role of the latest message in the chat. lastMessageRole: enum[user, assistant, support, system, ] // The email of the chat owner when the owner is a platform user. ownerEmail: string // The external user ID that owns the chat. ownerId: string // The identifier of the chat owner when the owner is an external user. ownerIdentifier: string // The display name of the chat owner resolved from external users or users. ownerName: string // The content preview of the message immediately before the latest one. penultimateMessageContent: string // When the message immediately before the latest one was created. penultimateMessageCreatedAt: string // The role of the message immediately before the latest one. penultimateMessageRole: enum[user, assistant, support, system, ] // The shared memory snapshot stored for the chat. publicMemory: { } // The responder entity type currently assigned to the chat. responderEntity: enum[agents, squads] // The responder ID currently assigned to the chat. responderId: string // The display name of the responder assigned to the chat. responderName: string // The picture of the responder assigned to the chat. responderPicture: string // The version ID of the responder entity for this chat. responderVersionId: string // The version number of the responder entity for this chat. responderVersionNumber: integer // The ticket ID currently linked to the chat, when one exists. ticketId: string // The status of the ticket currently linked to the chat, when one exists. ticketStatus: enum[pending, ongoing, completed, ] // The title of the chat. title: string // The workspace ID associated with the chat. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Chat not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/chats/details - Description Retrieves multiple chats with details. #### Parameters(Query) ```typescript channelIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript responderIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript responderVersionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all chats for the workspace. `application/json` ```typescript { // The channel ID associated with the chat. channelId: string // The display name of the channel associated with the chat. channelName: string // The type of the channel associated with the chat. channelType: enum[api, widget, waha, whatsapp, instagram, ] // When the chat was created. createdAt: string // The chat ID represented by this row. id: string // Whether the external chat owner is blocked. isOwnerBlocked: boolean // Whether the chat has been soft removed. isRemoved: boolean // The content preview of the latest message in the chat. lastMessageContent: string // When the latest message in the chat was created. lastMessageCreatedAt: string // The role of the latest message in the chat. lastMessageRole: enum[user, assistant, support, system, ] // The email of the chat owner when the owner is a platform user. ownerEmail: string // The external user ID that owns the chat. ownerId: string // The identifier of the chat owner when the owner is an external user. ownerIdentifier: string // The display name of the chat owner resolved from external users or users. ownerName: string // The content preview of the message immediately before the latest one. penultimateMessageContent: string // When the message immediately before the latest one was created. penultimateMessageCreatedAt: string // The role of the message immediately before the latest one. penultimateMessageRole: enum[user, assistant, support, system, ] // The shared memory snapshot stored for the chat. publicMemory: { } // The responder entity type currently assigned to the chat. responderEntity: enum[agents, squads] // The responder ID currently assigned to the chat. responderId: string // The display name of the responder assigned to the chat. responderName: string // The picture of the responder assigned to the chat. responderPicture: string // The version ID of the responder entity for this chat. responderVersionId: string // The version number of the responder entity for this chat. responderVersionNumber: integer // The ticket ID currently linked to the chat, when one exists. ticketId: string // The status of the ticket currently linked to the chat, when one exists. ticketStatus: enum[pending, ongoing, completed, ] // The title of the chat. title: string // The workspace ID associated with the chat. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/chats - Description Creates a new chat. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. channelId: string // The super identity ID of the chat owner. Can refer to users.superIdentityId or externalUsers.superIdentityId. ownerId: string privateMemory: { } publicMemory: { } title: string } ``` #### Responses - 200 The chat was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // A UUID v4 string that identifies an entity. channelId: string // A UUID v4 string that identifies an entity. currentResponderId: string lastChatMessageCreatedAt: string // The super identity ID of the chat owner. Can refer to users.superIdentityId or externalUsers.superIdentityId. ownerId: string privateMemory: { } publicMemory: { } // The super identity ID of the current chat responder. Can refer to agents.superIdentityId or squads.superIdentityId. responderId: string title: string // A UUID v4 string that identifies an entity. workspaceId: string } ``` - 400 Invalid data provided. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Channel or responder not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/chats - Description Retrieves multiple chats. #### Parameters(Query) ```typescript channelIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript channelTypes?: Partial(enum[widget, waha, whatsapp, instagram, api][]) & Partial(string) ``` ```typescript lastChatMessageCreatedAtEnd?: string ``` ```typescript lastChatMessageCreatedAtStart?: string ``` ```typescript ownerIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript responderIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript responderVersionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all chats for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // A UUID v4 string that identifies an entity. channelId: string // A UUID v4 string that identifies an entity. currentResponderId: string lastChatMessageCreatedAt: string // The super identity ID of the chat owner. Can refer to users.superIdentityId or externalUsers.superIdentityId. ownerId: string privateMemory: { } publicMemory: { } // The super identity ID of the current chat responder. Can refer to agents.superIdentityId or squads.superIdentityId. responderId: string title: string // A UUID v4 string that identifies an entity. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/chats/{id} - Description Removes a chat. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The chat was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Chat not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/chats/{id} - Description Retrieves a chat. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a chat. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // A UUID v4 string that identifies an entity. channelId: string // A UUID v4 string that identifies an entity. currentResponderId: string lastChatMessageCreatedAt: string // The super identity ID of the chat owner. Can refer to users.superIdentityId or externalUsers.superIdentityId. ownerId: string privateMemory: { } publicMemory: { } // The super identity ID of the current chat responder. Can refer to agents.superIdentityId or squads.superIdentityId. responderId: string title: string // A UUID v4 string that identifies an entity. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Chat not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/chats/{id} - Description Updates a chat. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. currentResponderId?: string lastChatMessageCreatedAt?: string privateMemory: { } publicMemory: { } title?: string } ``` #### Responses - 200 The chat was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // A UUID v4 string that identifies an entity. channelId: string // A UUID v4 string that identifies an entity. currentResponderId: string lastChatMessageCreatedAt: string // The super identity ID of the chat owner. Can refer to users.superIdentityId or externalUsers.superIdentityId. ownerId: string privateMemory: { } publicMemory: { } // The super identity ID of the current chat responder. Can refer to agents.superIdentityId or squads.superIdentityId. responderId: string title: string // A UUID v4 string that identifies an entity. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The chat was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/components - Description Creates a new component. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The detail configuration of the component. detail: Partial({ type: enum[boolean] value: boolean }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[string] value: string }) // The unique key identifier for this component within the workspace. key: string } ``` #### Responses - 200 The component was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The detail configuration of the component. detail: Partial({ type: enum[boolean] value: boolean }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[string] value: string }) // The unique key identifier for this component within the workspace. key: string // The workspace that owns this component. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 409 Component key already exists. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/components - Description Retrieves multiple components. #### Parameters(Query) ```typescript ids?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter components by key. search?: string ``` ```typescript versionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all components for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The detail configuration of the component. detail: Partial({ type: enum[boolean] value: boolean }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[string] value: string }) // The unique key identifier for this component within the workspace. key: string // The workspace that owns this component. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/components/{id} - Description Removes a component. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The component was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Component not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/components/{id} - Description Retrieves a component. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a component. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The detail configuration of the component. detail: Partial({ type: enum[boolean] value: boolean }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[string] value: string }) // The unique key identifier for this component within the workspace. key: string // The workspace that owns this component. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Component not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/components/{id} - Description Updates a component. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The detail configuration of the component. detail?: Partial({ type: enum[boolean] value: boolean }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[string] value: string }) } ``` #### Responses - 200 The component was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The detail configuration of the component. detail: Partial({ type: enum[boolean] value: boolean }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[string] value: string }) // The unique key identifier for this component within the workspace. key: string // The workspace that owns this component. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Component not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 409 Component key already exists. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/connections - Description Retrieves multiple connections. #### Parameters(Query) ```typescript joins?: Partial(enum[channels][]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter connections by name or description. search?: string ``` ```typescript // The type of the detail of the connection. type?: Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all connections for the workspace. `application/json` ```typescript undefined?: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The internal description of the connection. description: string detail: Partial({ id: string status: enum[pending, active, failed] type: enum[composio-airtable] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-asana] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-bannerbear] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-browseai] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-calendly] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-clickup] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-discord] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-dropbox] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-facebook] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-figma] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-genderize] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-github] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-gitlab] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-gmail] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-analytics] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-calendar] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-docs] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-drive] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-maps] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-meet] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-sheets] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-slides] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-tasks] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-hubspot] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-hugging-face] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-instagram] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-linear] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-linkedin] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-mailersend] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-manus] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-mem0] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-meta-ads] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-microsoft-clarity] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-miro] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-mixpanel] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-monday] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-notion] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-one-drive] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-openweather-api] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-outlook] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-polygon-io] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-postman] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-prisma] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-pushbullet] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-reddit] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-resend] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-salesforce] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-scrape-do] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-search-api] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-sendgrid] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-sentry] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-serpapi] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-short-io] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-short-menu] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-slack] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-slackbot] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-stripe] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-supabase] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-tavily] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-teams] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-telegram] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-ticktick] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-todoist] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-trello] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-twitter] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-typeform] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-youtube] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-zenrows] }) & Partial({ // The provider account ID associated with the Instagram connection detail. accountId: string // The provider authorization code associated with the Instagram connection detail. code: string // The provider ID associated with the Instagram connection detail. id: string // The display name returned by the provider for the Instagram connection detail. name: string // The reason associated with the current Instagram connection status, when one exists. reason?: string // The lifecycle status of the Instagram connection detail. status: enum[pending, active, failed] // The access token associated with the Instagram connection detail. token: string // The connection detail subtype represented by this payload. type: enum[instagram] }) & Partial({ id: string instanceId: number lid: string phoneNumber: string reason?: string status: enum[pending, active, failed, inactive] type: enum[waha] }) & Partial({ // The provider authorization code associated with the WhatsApp connection detail. code: string // The provider ID associated with the WhatsApp connection detail. id: string // The display name returned by the provider for the WhatsApp connection detail. name: string // The phone number associated with the WhatsApp connection detail. phoneNumber: string // The provider phone number ID associated with the WhatsApp connection detail. phoneNumberId: string // The reason associated with the current WhatsApp connection status, when one exists. reason?: string // The lifecycle status of the WhatsApp connection detail. status: enum[pending, active, failed] // The access token associated with the WhatsApp connection detail. token: string // The connection detail subtype represented by this payload. type: enum[whatsapp] // The WABA ID associated with the WhatsApp connection detail. wabaId: string }) // The display name of the connection. name: string // The optional reference ID associated with the connection. referenceId: string // The workspace ID that owns the connection. workspaceId: string channel: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The delay between the last user message and the beginning of the response generation. delay: integer // The internal description of the channel. description: string detail: Partial({ // The initial message to be displayed when the API is used. initialMessage: string // The webhook URL that receives responses produced through the API channel. responseWebhookUrl: string // The channel subtype represented by this detail payload. type: enum[api] }) & Partial({ // Whether registering tools from the widget's parent page is allowed. allowClientSideMcp: boolean // The initial message to be displayed when the widget is opened. initialMessage: string // The level of detail to be included in the loading message when the widget is opened. loading: enum[private, named, explained] // Whether the widget should be opened automatically when the page is loaded. openOnLoad: boolean // The widget theme palette configuration for the channel. themes: { dark: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } light: { ownerMessageBackground: string ownerMessageColor: string responderMessageBackground: string responderMessageColor: string } } // The channel subtype represented by this detail payload. type: enum[widget] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Waha (WhatsApp) account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[waha] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected WhatsApp account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[whatsapp] }) & Partial({ // The backing connection ID used by this channel, when one exists. connectionId: string // The reaction-based takeover policy configured for the channel. reactionTakeover: { handoverEmojis?: enum[✅, ✔️, ☑️, 📥, 📩, 📤, 👍, 🙌, 🤝, 👌, ❤️][] // Whether the reaction takeover is enabled. status: boolean } // Weather longer messages should be split when delivering them to the connected Instagram account. splitLongerMessages: boolean // The channel subtype represented by this detail payload. type: enum[instagram] }) maxAssistantMessagesPerChatOwner: integer // The display name of the channel. name: string // A prompt to be passed down to the agent in the context of this channel. prompt: string // The super identity of the responder (agents or squads) of the channel responderId: string // Whether to display sender names in chat messages. showSenderName: boolean // The lifecycle status of the channel. status: enum[active, inactive] // The voice behavior mode configured for the channel. useVoice: enum[on-audio/without-transcription, on-audio/with-transcription, always/without-transcription, always/with-transcription, never] // The workspace ID that owns the channel. workspaceId: string } }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The internal description of the connection. description: string detail: Partial({ id: string status: enum[pending, active, failed] type: enum[composio-airtable] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-asana] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-bannerbear] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-browseai] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-calendly] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-clickup] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-discord] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-dropbox] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-facebook] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-figma] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-genderize] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-github] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-gitlab] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-gmail] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-analytics] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-calendar] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-docs] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-drive] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-maps] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-meet] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-sheets] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-slides] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-google-tasks] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-hubspot] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-hugging-face] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-instagram] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-linear] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-linkedin] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-mailersend] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-manus] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-mem0] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-meta-ads] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-microsoft-clarity] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-miro] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-mixpanel] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-monday] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-notion] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-one-drive] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-openweather-api] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-outlook] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-polygon-io] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-postman] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-prisma] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-pushbullet] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-reddit] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-resend] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-salesforce] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-scrape-do] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-search-api] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-sendgrid] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-sentry] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-serpapi] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-short-io] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-short-menu] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-slack] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-slackbot] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-stripe] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-supabase] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-tavily] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-teams] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-telegram] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-ticktick] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-todoist] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-trello] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-twitter] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-typeform] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-youtube] }) & Partial({ id: string status: enum[pending, active, failed] type: enum[composio-zenrows] }) & Partial({ // The provider account ID associated with the Instagram connection detail. accountId: string // The provider authorization code associated with the Instagram connection detail. code: string // The provider ID associated with the Instagram connection detail. id: string // The display name returned by the provider for the Instagram connection detail. name: string // The reason associated with the current Instagram connection status, when one exists. reason?: string // The lifecycle status of the Instagram connection detail. status: enum[pending, active, failed] // The access token associated with the Instagram connection detail. token: string // The connection detail subtype represented by this payload. type: enum[instagram] }) & Partial({ id: string instanceId: number lid: string phoneNumber: string reason?: string status: enum[pending, active, failed, inactive] type: enum[waha] }) & Partial({ // The provider authorization code associated with the WhatsApp connection detail. code: string // The provider ID associated with the WhatsApp connection detail. id: string // The display name returned by the provider for the WhatsApp connection detail. name: string // The phone number associated with the WhatsApp connection detail. phoneNumber: string // The provider phone number ID associated with the WhatsApp connection detail. phoneNumberId: string // The reason associated with the current WhatsApp connection status, when one exists. reason?: string // The lifecycle status of the WhatsApp connection detail. status: enum[pending, active, failed] // The access token associated with the WhatsApp connection detail. token: string // The connection detail subtype represented by this payload. type: enum[whatsapp] // The WABA ID associated with the WhatsApp connection detail. wabaId: string }) // The display name of the connection. name: string // The optional reference ID associated with the connection. referenceId: string // The workspace ID that owns the connection. workspaceId: string })[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/connections/{id}/send-message - Description Sends a message through a connection. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { content: Partial({ text: string }) & Partial({ attachments?: Partial({ // A base64 encoded string with prefix. base64: string extension: enum[png] // A UUID v4 string that identifies an entity. id: string name: string }) & Partial({ // A base64 encoded string with prefix. base64: string extension: enum[pdf] // A UUID v4 string that identifies an entity. id: string name: string }) & Partial({ // A base64 encoded string with prefix. base64: string extension: enum[wav] // A UUID v4 string that identifies an entity. id: string mode: enum[message] }) & Partial({ // A base64 encoded string with prefix. base64: string extension: enum[wav] // A UUID v4 string that identifies an entity. id: string mode: enum[attachment] name: string })[] }) & Partial({ attachments?: Partial({ // A base64 encoded string with prefix. base64: string extension: enum[png] // A UUID v4 string that identifies an entity. id: string name: string }) & Partial({ // A base64 encoded string with prefix. base64: string extension: enum[pdf] // A UUID v4 string that identifies an entity. id: string name: string }) & Partial({ // A base64 encoded string with prefix. base64: string extension: enum[wav] // A UUID v4 string that identifies an entity. id: string mode: enum[message] }) & Partial({ // A base64 encoded string with prefix. base64: string extension: enum[wav] // A UUID v4 string that identifies an entity. id: string mode: enum[attachment] name: string })[] text: string }) externalId: string identifier: string } ``` #### Responses - 200 Message sent successfully. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 404 Connection not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 500 Failed to send message. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/datagrid-columns - Description Creates a new datagrid column. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The datagrid ID associated with the column. datagridId: string // The description of the column. Will be used by the agent to understand how to interact with it. description: string detail: Partial({ semanticSearch: boolean type: enum[string] }) & Partial({ type: enum[number] }) & Partial({ type: enum[boolean] }) // The display name of the datagrid column. name: string } ``` #### Responses - 200 The datagrid column was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The datagrid ID associated with the column. datagridId: string // The description of the column. Will be used by the agent to understand how to interact with it. description: string detail: Partial({ semanticSearch: boolean type: enum[string] }) & Partial({ type: enum[number] }) & Partial({ type: enum[boolean] }) // The display name of the datagrid column. name: string } ``` - 400 Invalid datagrid column configuration. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Datagrid not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Precondition failed. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/datagrid-columns - Description Retrieves multiple datagrid columns. #### Parameters(Query) ```typescript // A UUID v4 string that identifies an entity. datagridId: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all datagrid columns for the specified datagrid. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The datagrid ID associated with the column. datagridId: string // The description of the column. Will be used by the agent to understand how to interact with it. description: string detail: Partial({ semanticSearch: boolean type: enum[string] }) & Partial({ type: enum[number] }) & Partial({ type: enum[boolean] }) // The display name of the datagrid column. name: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Datagrid not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/datagrid-columns/{id} - Description Removes a datagrid column. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The datagrid column was removed along with all associated values. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Datagrid column not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/datagrid-columns/{id} - Description Updates a datagrid column. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The description of the column. Will be used by the agent to understand how to interact with it. description?: string detail?: Partial({ semanticSearch: boolean type: enum[string] }) & Partial({ type: enum[number] }) & Partial({ type: enum[boolean] }) // The display name of the datagrid column. name?: string } ``` #### Responses - 200 The datagrid column was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The datagrid ID associated with the column. datagridId: string // The description of the column. Will be used by the agent to understand how to interact with it. description: string detail: Partial({ semanticSearch: boolean type: enum[string] }) & Partial({ type: enum[number] }) & Partial({ type: enum[boolean] }) // The display name of the datagrid column. name: string } ``` - 400 Invalid request - data type cannot be changed. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The datagrid column was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Precondition failed. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/datagrid-rows - Description Creates a new datagrid row. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. datagridId: string position: integer } ``` #### Responses - 200 The datagrid row was created with default values for all columns. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. datagridId: string position: integer } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Datagrid not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Precondition failed. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/datagrid-rows - Description Removes multiple datagrid rows. #### Parameters(Query) ```typescript ids?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The datagrid rows were removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/datagrid-rows - Description Retrieves multiple datagrid rows. #### Parameters(Query) ```typescript datagridColumnIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // A UUID v4 string that identifies an entity. datagridId: string ``` ```typescript mode?: enum[semantic, similarity] //default: semantic ``` ```typescript operator?: enum[ilike, not ilike] //default: ilike ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all datagrid rows for the specified datagrid. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. datagridId: string position: integer datagridValues: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. datagridColumnId: string // A UUID v4 string that identifies an entity. datagridId: string // A UUID v4 string that identifies an entity. datagridRowId: string detail: Partial({ type: enum[string] value: string }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[boolean] value: boolean }) }[] }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Datagrid not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/datagrid-rows/{id} - Description Removes a datagrid row. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The datagrid row was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Datagrid row not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/datagrid-rows/{id} - Description Retrieves a datagrid row. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a datagrid row. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. datagridId: string position: integer datagridValues: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. datagridColumnId: string // A UUID v4 string that identifies an entity. datagridId: string // A UUID v4 string that identifies an entity. datagridRowId: string detail: Partial({ type: enum[string] value: string }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[boolean] value: boolean }) }[] } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Datagrid row not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/datagrid-rows/{id} #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { position?: integer } ``` #### Responses - 200 The datagrid row was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. datagridId: string position: integer } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The datagrid row was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/datagrid-values/{id} - Description Updates a datagrid value. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { detail?: Partial({ type: enum[string] value: string }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[boolean] value: boolean }) } ``` #### Responses - 200 The datagrid value was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. datagridColumnId: string // A UUID v4 string that identifies an entity. datagridId: string // A UUID v4 string that identifies an entity. datagridRowId: string detail: Partial({ type: enum[string] value: string }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[boolean] value: boolean }) } ``` - 400 Invalid datagrid value configuration. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The datagrid value was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/datagrids - Description Creates a new datagrid. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The internal description of the datagrid. description: string // The display name of the datagrid. name: string // The workspace ID that owns the datagrid. workspaceId: string } ``` #### Responses - 200 The datagrid was created with default columns and example data. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // When the content of the datagrid was last updated. contentUpdatedAt: string // The internal description of the datagrid. description: string // The display name of the datagrid. name: string // The workspace ID that owns the datagrid. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 403 Plan limit exceeded. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/datagrids - Description Retrieves multiple datagrids. #### Parameters(Query) ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter datagrids by name or description. search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all datagrids for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // When the content of the datagrid was last updated. contentUpdatedAt: string // The internal description of the datagrid. description: string // The display name of the datagrid. name: string // The workspace ID that owns the datagrid. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/datagrids/{id} - Description Removes a datagrid. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The datagrid was removed along with all associated columns, rows, and values. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Datagrid not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/datagrids/{id} - Description Retrieves a datagrid. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a datagrid. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // When the content of the datagrid was last updated. contentUpdatedAt: string // The internal description of the datagrid. description: string // The display name of the datagrid. name: string // The workspace ID that owns the datagrid. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Datagrid not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/datagrids/{id} - Description Updates a datagrid. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The internal description of the datagrid. description?: string // The display name of the datagrid. name?: string } ``` #### Responses - 200 The datagrid was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // When the content of the datagrid was last updated. contentUpdatedAt: string // The internal description of the datagrid. description: string // The display name of the datagrid. name: string // The workspace ID that owns the datagrid. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The datagrid was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/dataset-item-blocks - Description Retrieves multiple dataset item blocks. #### Parameters(Query) ```typescript // A UUID v4 string that identifies an entity. datasetId: string ``` ```typescript datasetItemIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript mode?: enum[semantic, similarity] //default: semantic ``` ```typescript operator?: enum[ilike, not ilike] //default: ilike ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all dataset item blocks for the specified dataset. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The content stored in the dataset item block. content: string // The dataset item ID associated with the block. datasetItemId: string // The display name of the dataset item block. name: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Dataset not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/dataset-items - Description Creates a new dataset item. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The dataset ID associated with the dataset item. datasetId: string // A base64 encoded string with prefix. file: string } ``` #### Responses - 200 The dataset item was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The dataset ID associated with the dataset item. datasetId: string // The internal description of the dataset item. description: string // The file payload or file reference associated with the dataset item. file: string // The display name of the dataset item. name: string // The processing status of the dataset item. status: enum[pending, processing, completed, failed] } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 403 Plan limit exceeded. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Dataset not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/dataset-items - Description Retrieves multiple dataset items. #### Parameters(Query) ```typescript datasetId: string ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter dataset items by name or description. search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all dataset items for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The dataset ID associated with the dataset item. datasetId: string // The internal description of the dataset item. description: string // The file payload or file reference associated with the dataset item. file: string // The display name of the dataset item. name: string // The processing status of the dataset item. status: enum[pending, processing, completed, failed] }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/dataset-items/{id} - Description Removes a dataset item. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The dataset item was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Dataset item not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/dataset-items/{id} - Description Retrieves a dataset item. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a dataset item. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The dataset ID associated with the dataset item. datasetId: string // The internal description of the dataset item. description: string // The file payload or file reference associated with the dataset item. file: string // The display name of the dataset item. name: string // The processing status of the dataset item. status: enum[pending, processing, completed, failed] content: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Dataset item not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/dataset-items/{id} - Description Updates a dataset item. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The internal description of the dataset item. description?: string // The file payload or file reference associated with the dataset item. file?: string // The display name of the dataset item. name?: string // The processing status of the dataset item. status?: enum[pending, processing, completed, failed] content?: string } ``` #### Responses - 200 The dataset item was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The dataset ID associated with the dataset item. datasetId: string // The internal description of the dataset item. description: string // The file payload or file reference associated with the dataset item. file: string // The display name of the dataset item. name: string // The processing status of the dataset item. status: enum[pending, processing, completed, failed] } ``` - 400 Invalid dataset item configuration. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 403 Plan limit exceeded. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The dataset item was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/datasets - Description Creates a new dataset. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The internal description of the dataset. description: string // The display name of the dataset. name: string } ``` #### Responses - 200 The dataset was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // When the dataset content was last updated. contentUpdatedAt: string // The internal description of the dataset. description: string // The display name of the dataset. name: string // The workspace ID that owns the dataset. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 403 Plan limit exceeded. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/datasets - Description Retrieves multiple datasets. #### Parameters(Query) ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter datasets by name or description. search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all datasets for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // When the dataset content was last updated. contentUpdatedAt: string // The internal description of the dataset. description: string // The display name of the dataset. name: string // The workspace ID that owns the dataset. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/datasets/{id} - Description Removes a dataset. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The dataset was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Dataset not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/datasets/{id} - Description Retrieves a dataset. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a dataset. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // When the dataset content was last updated. contentUpdatedAt: string // The internal description of the dataset. description: string // The display name of the dataset. name: string // The workspace ID that owns the dataset. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Dataset not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/datasets/{id} - Description Updates a dataset. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // When the dataset content was last updated. contentUpdatedAt?: string // The internal description of the dataset. description?: string // The display name of the dataset. name?: string } ``` #### Responses - 200 The dataset was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // When the dataset content was last updated. contentUpdatedAt: string // The internal description of the dataset. description: string // The display name of the dataset. name: string // The workspace ID that owns the dataset. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Dataset not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/executions/nestings - Description Retrieves an execution with its children. #### Parameters(Query) ```typescript // A UUID v4 string that identifies an entity. chatMessageId?: string ``` ```typescript // A UUID v4 string that identifies an entity. executionId?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves an execution with its children. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The total number of credits used by this execution. creditsUsed: number // The execution detail containing type-specific information. detail: Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this agent execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The execution detail subtype represented by this payload. type: enum[agent-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this squad execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The squad identifier. squadId: string // The execution detail subtype represented by this payload. type: enum[squad-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } events: { // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of workflow node. nodeType: string // The event subtype represented by this payload. type: enum[workflow-node] // The workflow node identifier. workflowNodeId: string }[] // The origin of this workflow execution. origin: Partial({ // The execution origin subtype represented by this payload. type: enum[webhook-request] // The workflow trigger identifier. workflowTriggerId: string }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agent-tool-request] // The workflow trigger identifier. workflowTriggerId: string }) // The execution detail subtype represented by this payload. type: enum[workflow-execution] // The workflow identifier. workflowId: string // The workflow implementation identifier. workflowImplementationId: string }) // When this execution ended. endedAt: string // Whether this execution has been purged. isPurged: boolean // The parent execution ID of this execution. parentId: string // The responder ID of this execution. responderId: string // When this execution started. startedAt: string // The status of the execution. status: enum[running, completed, failed, cancelled] // The workspace ID of this execution. workspaceId: string children: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The total number of credits used by this execution. creditsUsed: number // The execution detail containing type-specific information. detail: Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this agent execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The execution detail subtype represented by this payload. type: enum[agent-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this squad execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The squad identifier. squadId: string // The execution detail subtype represented by this payload. type: enum[squad-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } events: { // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of workflow node. nodeType: string // The event subtype represented by this payload. type: enum[workflow-node] // The workflow node identifier. workflowNodeId: string }[] // The origin of this workflow execution. origin: Partial({ // The execution origin subtype represented by this payload. type: enum[webhook-request] // The workflow trigger identifier. workflowTriggerId: string }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agent-tool-request] // The workflow trigger identifier. workflowTriggerId: string }) // The execution detail subtype represented by this payload. type: enum[workflow-execution] // The workflow identifier. workflowId: string // The workflow implementation identifier. workflowImplementationId: string }) // When this execution ended. endedAt: string // Whether this execution has been purged. isPurged: boolean // The parent execution ID of this execution. parentId: string // The responder ID of this execution. responderId: string // When this execution started. startedAt: string // The status of the execution. status: enum[running, completed, failed, cancelled] // The workspace ID of this execution. workspaceId: string children: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The total number of credits used by this execution. creditsUsed: number // The execution detail containing type-specific information. detail: Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this agent execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The execution detail subtype represented by this payload. type: enum[agent-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this squad execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The squad identifier. squadId: string // The execution detail subtype represented by this payload. type: enum[squad-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } events: { // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of workflow node. nodeType: string // The event subtype represented by this payload. type: enum[workflow-node] // The workflow node identifier. workflowNodeId: string }[] // The origin of this workflow execution. origin: Partial({ // The execution origin subtype represented by this payload. type: enum[webhook-request] // The workflow trigger identifier. workflowTriggerId: string }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agent-tool-request] // The workflow trigger identifier. workflowTriggerId: string }) // The execution detail subtype represented by this payload. type: enum[workflow-execution] // The workflow identifier. workflowId: string // The workflow implementation identifier. workflowImplementationId: string }) // When this execution ended. endedAt: string // Whether this execution has been purged. isPurged: boolean // The parent execution ID of this execution. parentId: string // The responder ID of this execution. responderId: string // When this execution started. startedAt: string // The status of the execution. status: enum[running, completed, failed, cancelled] // The workspace ID of this execution. workspaceId: string [] }[] }[] } ``` - 400 At least one of executionId or chatMessageId must be provided. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Execution not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 The chat message is a follow-up response without executions; use the trigger chat message. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/executions/{id} - Description Retrieves an execution. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves an execution. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The total number of credits used by this execution. creditsUsed: number // The execution detail containing type-specific information. detail: Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this agent execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The execution detail subtype represented by this payload. type: enum[agent-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this squad execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The squad identifier. squadId: string // The execution detail subtype represented by this payload. type: enum[squad-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } events: { // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of workflow node. nodeType: string // The event subtype represented by this payload. type: enum[workflow-node] // The workflow node identifier. workflowNodeId: string }[] // The origin of this workflow execution. origin: Partial({ // The execution origin subtype represented by this payload. type: enum[webhook-request] // The workflow trigger identifier. workflowTriggerId: string }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agent-tool-request] // The workflow trigger identifier. workflowTriggerId: string }) // The execution detail subtype represented by this payload. type: enum[workflow-execution] // The workflow identifier. workflowId: string // The workflow implementation identifier. workflowImplementationId: string }) // When this execution ended. endedAt: string // Whether this execution has been purged. isPurged: boolean // The parent execution ID of this execution. parentId: string // The responder ID of this execution. responderId: string // When this execution started. startedAt: string // The status of the execution. status: enum[running, completed, failed, cancelled] // The workspace ID of this execution. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Execution not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/executions - Description Retrieves multiple executions. #### Parameters(Query) ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript responderIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all executions for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The total number of credits used by this execution. creditsUsed: number // The execution detail containing type-specific information. detail: Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this agent execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The execution detail subtype represented by this payload. type: enum[agent-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this squad execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The squad identifier. squadId: string // The execution detail subtype represented by this payload. type: enum[squad-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } events: { // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of workflow node. nodeType: string // The event subtype represented by this payload. type: enum[workflow-node] // The workflow node identifier. workflowNodeId: string }[] // The origin of this workflow execution. origin: Partial({ // The execution origin subtype represented by this payload. type: enum[webhook-request] // The workflow trigger identifier. workflowTriggerId: string }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agent-tool-request] // The workflow trigger identifier. workflowTriggerId: string }) // The execution detail subtype represented by this payload. type: enum[workflow-execution] // The workflow identifier. workflowId: string // The workflow implementation identifier. workflowImplementationId: string }) // When this execution ended. endedAt: string // Whether this execution has been purged. isPurged: boolean // The parent execution ID of this execution. parentId: string // The responder ID of this execution. responderId: string // When this execution started. startedAt: string // The status of the execution. status: enum[running, completed, failed, cancelled] // The workspace ID of this execution. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/external-user-groups - Description Creates a new external user group. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // External reference in the integrated system. externalId: string // The display name of the external user group. name: string // The tier associated with the external user group. tierId: string } ``` #### Responses - 200 The external user group was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // External reference in the integrated system. externalId: string // The display name of the external user group. name: string // The tier associated with the external user group. tierId: string // The workspace that owns the external user group. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Tier not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 409 External user group external id already exists in this workspace. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/external-user-groups - Description Retrieves multiple external user groups. #### Parameters(Query) ```typescript externalId?: string ``` ```typescript ids?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter external user groups by name or external ids. search?: string ``` ```typescript tierIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all external user groups for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // External reference in the integrated system. externalId: string // The display name of the external user group. name: string // The tier associated with the external user group. tierId: string // The workspace that owns the external user group. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/external-user-groups/{id} - Description Removes an external user group. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The external user group was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 External user group not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/external-user-groups/{id} - Description Retrieves an external user group. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves an external user group. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // External reference in the integrated system. externalId: string // The display name of the external user group. name: string // The tier associated with the external user group. tierId: string // The workspace that owns the external user group. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 External user group not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/external-user-groups/{id} - Description Updates an external user group. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // External reference in the integrated system. externalId?: string // The display name of the external user group. name?: string // The tier associated with the external user group. tierId?: string } ``` #### Responses - 200 The external user group was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // External reference in the integrated system. externalId: string // The display name of the external user group. name: string // The tier associated with the external user group. tierId: string // The workspace that owns the external user group. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 External user group or tier not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 409 External user group external id already exists in this workspace. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/external-users/authenticate - Description Authenticates an external user. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. channelId: string externalId: string // A UUID v4 string that identifies an entity. id: string identifier: string } ``` #### Responses - 200 The external user was authenticated and access token generated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // Whether the external user is blocked. blocked: boolean // The ID of the channel associated with the external user. channelId: string // External reference in the integrated system. externalId: string // The ID of the external user group associated with the external user. externalUserGroupId: string // A unique identifier of the external user (usernames, emails, phone numbers and etc). identifier: string // The display name of the external user. name: string // The ID of the super identity associated with the external user. superIdentityId: string // The ID of the tier associated with the external user. tierId: string // The ID of the workspace associated with the external user. workspaceId: string accessToken: string } ``` - 400 Invalid data provided. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Channel not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/external-users - Description Creates a new external user. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The ID of the channel associated with the external user. channelId: string // External reference in the integrated system. externalId: string // The ID of the external user group associated with the external user. externalUserGroupId: string // A unique identifier of the external user (usernames, emails, phone numbers and etc). identifier: string // The display name of the external user. name: string // The ID of the tier associated with the external user. tierId: string } ``` #### Responses - 200 The external user was created and access token generated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // Whether the external user is blocked. blocked: boolean // The ID of the channel associated with the external user. channelId: string // External reference in the integrated system. externalId: string // The ID of the external user group associated with the external user. externalUserGroupId: string // A unique identifier of the external user (usernames, emails, phone numbers and etc). identifier: string // The display name of the external user. name: string // The ID of the super identity associated with the external user. superIdentityId: string // The ID of the tier associated with the external user. tierId: string // The ID of the workspace associated with the external user. workspaceId: string } ``` - 400 Invalid data provided. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Channel not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/external-users - Description Retrieves multiple external users. #### Parameters(Query) ```typescript channelIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript externalUserGroupIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript search?: string ``` ```typescript superIdentityIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript tierIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all external users for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // Whether the external user is blocked. blocked: boolean // The ID of the channel associated with the external user. channelId: string // External reference in the integrated system. externalId: string // The ID of the external user group associated with the external user. externalUserGroupId: string // A unique identifier of the external user (usernames, emails, phone numbers and etc). identifier: string // The display name of the external user. name: string // The ID of the super identity associated with the external user. superIdentityId: string // The ID of the tier associated with the external user. tierId: string // The ID of the workspace associated with the external user. workspaceId: string }[] ``` - 400 Bad Request. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/external-users/{id} - Description Retrieves an external user. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves an external user. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // Whether the external user is blocked. blocked: boolean // The ID of the channel associated with the external user. channelId: string // External reference in the integrated system. externalId: string // The ID of the external user group associated with the external user. externalUserGroupId: string // A unique identifier of the external user (usernames, emails, phone numbers and etc). identifier: string // The display name of the external user. name: string // The ID of the super identity associated with the external user. superIdentityId: string // The ID of the tier associated with the external user. tierId: string // The ID of the workspace associated with the external user. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 External user not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/external-users/{id} - Description Updates an external user. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // Whether the external user is blocked. blocked?: boolean // External reference in the integrated system. externalId?: string // The ID of the external user group associated with the external user. externalUserGroupId?: string // A unique identifier of the external user (usernames, emails, phone numbers and etc). identifier?: string // The display name of the external user. name?: string // The ID of the tier associated with the external user. tierId?: string } ``` #### Responses - 200 The external user was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // Whether the external user is blocked. blocked: boolean // The ID of the channel associated with the external user. channelId: string // External reference in the integrated system. externalId: string // The ID of the external user group associated with the external user. externalUserGroupId: string // A unique identifier of the external user (usernames, emails, phone numbers and etc). identifier: string // The display name of the external user. name: string // The ID of the super identity associated with the external user. superIdentityId: string // The ID of the tier associated with the external user. tierId: string // The ID of the workspace associated with the external user. workspaceId: string } ``` - 400 Invalid data provided. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 External user not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/llm-providers/options - Description Retrieves multiple LLM provider options. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all available LLM models. `application/json` ```typescript { aiLab: string artificialAnalysisReference: string cost: integer indicators: { bestCostBenefit: boolean bestOverall: boolean defaultChoice: boolean deprecated: boolean fast: boolean greatForTooling: boolean score: integer smart: boolean } label: string name: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] provider: enum[openai, anthropic, google-ai, openrouter] }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/llm-providers - Description Creates a new LLM provider. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The API key used to authenticate with the LLM provider. apiKey: string // The internal description of the LLM provider configuration. description: string // The display name of the LLM provider configuration. name: string // The upstream LLM provider type configured for this record. type: enum[openai, anthropic, google-ai, openrouter] } ``` #### Responses - 200 The LLM provider was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The API key used to authenticate with the LLM provider. apiKey: string // The internal description of the LLM provider configuration. description: string // The display name of the LLM provider configuration. name: string // The optional reference ID associated with the LLM provider configuration. referenceId: string // The upstream LLM provider type configured for this record. type: enum[openai, anthropic, google-ai, openrouter] // The workspace ID that owns the LLM provider configuration. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/llm-providers - Description Retrieves multiple LLM providers. #### Parameters(Query) ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript types?: Partial(enum[openai, anthropic, google-ai, openrouter][]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all LLM providers for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The API key used to authenticate with the LLM provider. apiKey: string // The internal description of the LLM provider configuration. description: string // The display name of the LLM provider configuration. name: string // The optional reference ID associated with the LLM provider configuration. referenceId: string // The upstream LLM provider type configured for this record. type: enum[openai, anthropic, google-ai, openrouter] // The workspace ID that owns the LLM provider configuration. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/llm-providers/{id} - Description Removes an LLM provider. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The LLM provider was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 LLM provider not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/llm-providers/{id} #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves an LLM provider. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The API key used to authenticate with the LLM provider. apiKey: string // The internal description of the LLM provider configuration. description: string // The display name of the LLM provider configuration. name: string // The optional reference ID associated with the LLM provider configuration. referenceId: string // The upstream LLM provider type configured for this record. type: enum[openai, anthropic, google-ai, openrouter] // The workspace ID that owns the LLM provider configuration. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 LLM provider not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/llm-providers/{id} - Description Updates an LLM provider. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The API key used to authenticate with the LLM provider. apiKey?: string // The internal description of the LLM provider configuration. description?: string // The display name of the LLM provider configuration. name?: string // The optional reference ID associated with the LLM provider configuration. referenceId?: string } ``` #### Responses - 200 The LLM provider was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The API key used to authenticate with the LLM provider. apiKey: string // The internal description of the LLM provider configuration. description: string // The display name of the LLM provider configuration. name: string // The optional reference ID associated with the LLM provider configuration. referenceId: string // The upstream LLM provider type configured for this record. type: enum[openai, anthropic, google-ai, openrouter] // The workspace ID that owns the LLM provider configuration. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 LLM provider not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/mcps/options - Description Retrieves available MCP options. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all available MCP options. `application/json` ```typescript { type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/mcps/tool-options/{toolkit} - Description Retrieves available MCP tool options for a toolkit. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves MCP tool options for the given toolkit. `application/json` ```typescript { tools: { description: string // A JSON Schema definition object inputParameters: { properties: { } required?: string[] type: enum[object] } name: string // A JSON Schema definition object outputParameters: { properties: { } required?: string[] type: enum[object] } }[] } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/mcps - Description Creates a new MCP. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string } ``` #### Responses - 200 The MCP was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string // The workspace ID that owns the MCP. workspaceId: string } ``` - 400 Connection type is not compatible with MCP type. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Connection not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/mcps - Description Retrieves multiple MCPs. #### Parameters(Query) ```typescript agentIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript connectionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript joins?: Partial(enum[agents][]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter MCPs by name or description. search?: string ``` ```typescript versionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all MCPs for the workspace. `application/json` ```typescript undefined?: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string // The workspace ID that owns the MCP. workspaceId: string agentMcps: { createdAt: string updatedAt: string // The id of the agent to link the MCP to. agentId: string // The id of the MCP to link to the agent. mcpId: string agent: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } }[] }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string // The workspace ID that owns the MCP. workspaceId: string })[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/mcps/{id} - Description Removes an MCP. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The MCP was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 MCP not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/mcps/{id} - Description Retrieves an MCP. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves an MCP. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string // The workspace ID that owns the MCP. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 MCP not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/mcps/{id} - Description Updates an MCP. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The id of the connection the MCP will be used through. connectionId?: string // The internal description of the MCP. description?: string detail?: Partial({ tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] }) // The display name of the MCP. name?: string } ``` #### Responses - 200 The MCP was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string // The workspace ID that owns the MCP. workspaceId: string } ``` - 400 Connection type is not compatible with MCP type. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 MCP or connection not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/squads - Description Creates a new squad. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string } ``` #### Responses - 200 The squad was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 403 Plan limit exceeded. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/squads - Description Retrieves multiple squads. #### Parameters(Query) ```typescript agentIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript joins?: Partial(enum[agents][]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript referenceIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // Search term to filter squads by name or description. search?: string ``` ```typescript versionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all squads for the workspace. `application/json` ```typescript undefined?: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string squadAgents: { createdAt: string updatedAt: string // A UUID v4 string that identifies an entity. agentId: string // A UUID v4 string that identifies an entity. squadId: string type: enum[member, main] agent: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } }[] }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string })[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/squads/{squadId}/agents - Description Creates a new agent or attaches an existing one to a squad. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript undefined?: Partial({ type: enum[member, main] agent: { // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] } }) & Partial({ // A UUID v4 string that identifies an entity. agentId: string type: enum[member, main] }) ``` #### Responses - 200 The agent was created. `application/json` ```typescript { createdAt: string updatedAt: string // A UUID v4 string that identifies an entity. agentId: string // A UUID v4 string that identifies an entity. squadId: string type: enum[member, main] agent: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 403 Plan limit exceeded. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The agent was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Agent is already associated with this squad. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/squads/{id}/execute - Description Executes a squad with provided messages. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { context?: string messages: { attachments?: { // A base64 encoded string with prefix. base64: string extension: enum[png] } | { // A base64 encoded string with prefix. base64: string extension: enum[pdf] name?: string }[] content: string role: Partial(string) & Partial(string) }[] // A JSON Schema definition object output: { properties: { } required?: string[] type: enum[object] } } ``` #### Responses - 200 The squad was executed. `application/json` ```typescript { attachmentsUrls?: string[] content: Partial(string) & Partial({ }) execution: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The total number of credits used by this execution. creditsUsed: number // The execution detail containing type-specific information. detail: Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this agent execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The execution detail subtype represented by this payload. type: enum[agent-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } // The agent identifier. agentId: string events?: Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The model key used during the iteration event. llm: string // The provider metadata associated with the iteration event. llmProvider: { // The provider ID associated with the iteration event, when one exists. id: string // The display name of the provider associated with the iteration event. name: string } // The event subtype represented by this payload. type: enum[iteration] }) & Partial({ // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of tool called. toolType: string // The event subtype represented by this payload. type: enum[tool-call] })[] // The origin of this squad execution. origin: Partial({ // The API key identifier. apiKeyId: string // The execution origin subtype represented by this payload. type: enum[api] }) & Partial({ // The chat message identifier. chatMessageId: string // The execution origin subtype represented by this payload. type: enum[chat-message] }) & Partial({ // The agent identifier. agentId: string // The execution origin subtype represented by this payload. type: enum[delegation] }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agentic-execution-node] // The workflow node identifier. workflowNodeId: string }) // The squad identifier. squadId: string // The execution detail subtype represented by this payload. type: enum[squad-execution] }) & Partial({ // The input data for this execution. input: { } // The output data for this execution. output: { } events: { // The number of credits used by this event. creditsUsed: number // When this event ended. endedAt: string // The event identifier. id: string // The input data for this event. input?: Partial() & Partial({ }) // The label for this event. label: string // The output data for this event. output: { } // When this event started. startedAt: string // The status of the event. status: enum[running, completed, failed] // The child execution identifier. childExecutionId: string // The type of workflow node. nodeType: string // The event subtype represented by this payload. type: enum[workflow-node] // The workflow node identifier. workflowNodeId: string }[] // The origin of this workflow execution. origin: Partial({ // The execution origin subtype represented by this payload. type: enum[webhook-request] // The workflow trigger identifier. workflowTriggerId: string }) & Partial({ // The execution origin subtype represented by this payload. type: enum[agent-tool-request] // The workflow trigger identifier. workflowTriggerId: string }) // The execution detail subtype represented by this payload. type: enum[workflow-execution] // The workflow identifier. workflowId: string // The workflow implementation identifier. workflowImplementationId: string }) // When this execution ended. endedAt: string // Whether this execution has been purged. isPurged: boolean // The parent execution ID of this execution. parentId: string // The responder ID of this execution. responderId: string // When this execution started. startedAt: string // The status of the execution. status: enum[running, completed, failed, cancelled] // The workspace ID of this execution. workspaceId: string } } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Squad not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Flat collaboration mode is exclusive for chats. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/squads/{id} - Description Removes a squad. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The squad was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Squad not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/squads/{id} - Description Retrieves a squad. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a squad. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Squad not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/squads/{id} - Description Updates a squad. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The internal description of the squad. description?: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode?: enum[hierarchical, flat] // The display name of the squad. name?: string // The picture associated with the squad. picture?: string // The super identity ID associated with the squad. superIdentityId?: string } ``` #### Responses - 200 The squad was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Squad not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/squads/{squadId}/agents/{agentId} - Description Detaches an agent from a squad. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The squad agent relationship was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Squad agent relationship not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Precondition failed. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/squads/{squadId}/agents/{agentId} - Description Retrieves agents in a squad. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a squad agent. `application/json` ```typescript { createdAt: string updatedAt: string // A UUID v4 string that identifies an entity. agentId: string // A UUID v4 string that identifies an entity. squadId: string type: enum[member, main] agent: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Squad agent not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/squads/{squadId}/agents/{agentId} - Description Updates agents in a squad. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { type?: enum[member, main] agent: { // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime?: boolean // The internal name of the agent. For internal use only. internalName?: string // The number of iterations (steps) the agent can execute in a single execution. iterations?: number // The LLM model key to use for the agent. llm?: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId?: string // The name of the agent. name?: string // The picture of the agent. picture?: string // Whether the agent should plan before each execution. planning?: boolean // The main description of the agent's behavior. prompt?: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode?: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role?: string // The super identity ID associated with the agent. superIdentityId?: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature?: number // The timezone to use for the agent. If null, no timezone will be used. timezone?: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount?: integer // The TTS voice for audio responses. Null to disable. voiceId?: string } } ``` #### Responses - 200 The squad agent was updated. `application/json` ```typescript { createdAt: string updatedAt: string // A UUID v4 string that identifies an entity. agentId: string // A UUID v4 string that identifies an entity. squadId: string type: enum[member, main] agent: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The squad agent was not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/super-identities/responders - Description Retrieves multiple responders super identities. #### Parameters(Query) ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript responderEntities?: Partial(enum[agents, squads, workflows][]) & Partial(string) ``` ```typescript // Search term to filter super identities by reference, entity, or id. search?: string ``` ```typescript versionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all responders super identities for the workspace. `application/json` ```typescript undefined?: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string entity: enum[agents] }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string entity: enum[squads] }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // Whether the workflow is currently active. active: boolean // When the workflow content was last updated. contentUpdatedAt: string // When the workflow was last deployed. deployedAt: string // The workflow implementation ID currently deployed for the workflow. deployedImplementationId: string // The internal description of the workflow. description: string // The display name of the workflow. name: string // The lifecycle status of the workflow. status: enum[draft, deployed, archived] // The super identity ID associated with the workflow. superIdentityId: string // The workspace ID that owns the workflow. workspaceId: string entity: enum[workflows] })[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/tags - Description Creates a new tag. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The color of the tag. color: enum[default, gray, red, orange, yellow, green, blue, purple, pink, brown] // The description of the tag. description: string // The display name of the tag. name: string } ``` #### Responses - 200 The tag was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The number of active tickets for this tag. activeTicketCount: integer // The color of the tag. color: enum[default, gray, red, orange, yellow, green, blue, purple, pink, brown] // The description of the tag. description: string // The display name of the tag. name: string // The workspace that owns this tag. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tags - Description Retrieves multiple tags. #### Parameters(Query) ```typescript ids?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter tags by name or description. search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all tags for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The number of active tickets for this tag. activeTicketCount: integer // The color of the tag. color: enum[default, gray, red, orange, yellow, green, blue, purple, pink, brown] // The description of the tag. description: string // The display name of the tag. name: string // The workspace that owns this tag. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/tags/{id} - Description Removes a tag. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The tag was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Tag not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tags/{id} - Description Retrieves a tag. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a tag. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The number of active tickets for this tag. activeTicketCount: integer // The color of the tag. color: enum[default, gray, red, orange, yellow, green, blue, purple, pink, brown] // The description of the tag. description: string // The display name of the tag. name: string // The workspace that owns this tag. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Tag not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/tags/{id} - Description Updates a tag. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The number of active tickets for this tag. activeTicketCount?: integer // The color of the tag. color?: enum[default, gray, red, orange, yellow, green, blue, purple, pink, brown] // The description of the tag. description?: string // The display name of the tag. name?: string } ``` #### Responses - 200 The tag was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The number of active tickets for this tag. activeTicketCount: integer // The color of the tag. color: enum[default, gray, red, orange, yellow, green, blue, purple, pink, brown] // The description of the tag. description: string // The display name of the tag. name: string // The workspace that owns this tag. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Tag not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/tasks - Description Creates a new task. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The agent ID associated with the task. agentId: string // The condition that must be met for the task to be executed. condition: string // The display name of the task. name: string // What will be set as the main object of the agent when the task is selected. prompt: string // The lifecycle status of the task. status: enum[active, inactive] } ``` #### Responses - 200 The task was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The agent ID associated with the task. agentId: string // The condition that must be met for the task to be executed. condition: string // The display name of the task. name: string // What will be set as the main object of the agent when the task is selected. prompt: string // The lifecycle status of the task. status: enum[active, inactive] } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Agent not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tasks - Description Retrieves multiple tasks. #### Parameters(Query) ```typescript agentIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript versionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all tasks for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The agent ID associated with the task. agentId: string // The condition that must be met for the task to be executed. condition: string // The display name of the task. name: string // What will be set as the main object of the agent when the task is selected. prompt: string // The lifecycle status of the task. status: enum[active, inactive] }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/tasks/{id} - Description Removes a task. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The task was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Task not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tasks/{id} - Description Retrieves a task. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a task. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The agent ID associated with the task. agentId: string // The condition that must be met for the task to be executed. condition: string // The display name of the task. name: string // What will be set as the main object of the agent when the task is selected. prompt: string // The lifecycle status of the task. status: enum[active, inactive] } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Task not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/tasks/{id} - Description Updates a task. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The condition that must be met for the task to be executed. condition?: string // The display name of the task. name?: string // What will be set as the main object of the agent when the task is selected. prompt?: string // The lifecycle status of the task. status?: enum[active, inactive] } ``` #### Responses - 200 The task was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The agent ID associated with the task. agentId: string // The condition that must be met for the task to be executed. condition: string // The display name of the task. name: string // What will be set as the main object of the agent when the task is selected. prompt: string // The lifecycle status of the task. status: enum[active, inactive] } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Task not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/ticketing-teams - Description Creates a new ticketing team. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The internal description of the ticketing team. description: string // The display name of the ticketing team. name: string // The picture associated with the ticketing team. picture: string } ``` #### Responses - 200 The ticketing team was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The internal description of the ticketing team. description: string // The display name of the ticketing team. name: string // The picture associated with the ticketing team. picture: string // The workspace ID that owns the ticketing team. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/ticketing-teams - Description Retrieves multiple ticketing teams. #### Parameters(Query) ```typescript joins?: Partial(enum[tools-agents][]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all ticketing teams for the workspace. `application/json` ```typescript undefined?: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The internal description of the ticketing team. description: string // The display name of the ticketing team. name: string // The picture associated with the ticketing team. picture: string // The workspace ID that owns the ticketing team. workspaceId: string tools: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string agentTools: { createdAt: string updatedAt: string // The id of the agent to link the tool to. agentId: string // The id of the tool to link to the agent. toolId: string agent: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } }[] }[] }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The internal description of the ticketing team. description: string // The display name of the ticketing team. name: string // The picture associated with the ticketing team. picture: string // The workspace ID that owns the ticketing team. workspaceId: string })[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/ticketing-teams/{ticketingTeamId}/users - Description Creates new users or attaches existing ones to a ticketing team. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. userId: string } ``` #### Responses - 200 The ticketing team user was created. `application/json` ```typescript { createdAt: string updatedAt: string activeTickets: integer roundRobinDistribution: integer status: enum[active, inactive] // A UUID v4 string that identifies an entity. ticketingTeamId: string // A UUID v4 string that identifies an entity. userId: string } ``` - 400 Round robin distribution does not total exactly 100%. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticketing team or user not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 User is already a member of this ticketing team. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/ticketing-teams/{ticketingTeamId}/users - Description Retrieves multiple users in a ticketing team. #### Parameters(Query) ```typescript joins?: Partial(enum[users, workspace-users][]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all ticketing team users. `application/json` ```typescript { createdAt: string updatedAt: string activeTickets: integer roundRobinDistribution: integer status: enum[active, inactive] // A UUID v4 string that identifies an entity. ticketingTeamId: string // A UUID v4 string that identifies an entity. userId: string user: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The brand ID associated with the user. brandId: string // The external client reference ID associated with the user. clientReferenceId: string // The email address of the user. email: string // The email verification status of the user. emailStatus: enum[pending, verified] // When the user first accessed the platform. firstAccessAt: string // The GTM parameters to be used in tracking events for the user. gtm: { } // The preferred language configured for the user. language: enum[enUs, ptBr] // When the user last authenticated. lastAuthenticationAt: string // The display name of the user. name: string phoneNumber: string // The picture associated with the user. picture: string // The super identity ID associated with the user. superIdentityId: string } workspaceUser: { createdAt: string updatedAt: string inviteStatus: enum[pending, accepted, rejected] isRemoved: boolean role: enum[member, admin, owner, ops] ticketingAvailability: enum[available, unavailable] // A UUID v4 string that identifies an entity. userId: string // A UUID v4 string that identifies an entity. workspaceId: string } }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticketing team not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/ticketing-teams/{ticketingTeamId}/users - Description Updates multiple users in a ticketing team. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { users: { roundRobinDistribution: integer status: enum[active, inactive] // A UUID v4 string that identifies an entity. userId: string }[] } ``` #### Responses - 200 The ticketing team users were updated. `application/json` ```typescript { createdAt: string updatedAt: string activeTickets: integer roundRobinDistribution: integer status: enum[active, inactive] // A UUID v4 string that identifies an entity. ticketingTeamId: string // A UUID v4 string that identifies an entity. userId: string }[] ``` - 400 Round robin distribution does not total exactly 100%. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticketing team or user not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/ticketing-teams/{id} - Description Removes a ticketing team. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The ticketing team was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticketing team not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/ticketing-teams/{id} - Description Retrieves a ticketing team. #### Parameters(Query) ```typescript joins?: Partial(enum[agents][]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a ticketing team. `application/json` ```typescript undefined?: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The internal description of the ticketing team. description: string // The display name of the ticketing team. name: string // The picture associated with the ticketing team. picture: string // The workspace ID that owns the ticketing team. workspaceId: string tools: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string agentTools: { createdAt: string updatedAt: string // The id of the agent to link the tool to. agentId: string // The id of the tool to link to the agent. toolId: string agent: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } }[] }[] }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The internal description of the ticketing team. description: string // The display name of the ticketing team. name: string // The picture associated with the ticketing team. picture: string // The workspace ID that owns the ticketing team. workspaceId: string }) ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticketing team not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/ticketing-teams/{id} - Description Updates a ticketing team. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The internal description of the ticketing team. description?: string // The display name of the ticketing team. name?: string // The picture associated with the ticketing team. picture?: string } ``` #### Responses - 200 The ticketing team was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean updatedAt: string // The internal description of the ticketing team. description: string // The display name of the ticketing team. name: string // The picture associated with the ticketing team. picture: string // The workspace ID that owns the ticketing team. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticketing team not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/ticketing-teams/{ticketingTeamId}/users/{userId} - Description Detaches a user from a ticketing team. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The ticketing team user was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticketing team user relationship not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tickets/{id}/details - Description Retrieves a ticket with details. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a ticket. `application/json` ```typescript { // The email of the user currently assigned to the ticket. assigneeEmail: string // The user ID currently assigned to the ticket. assigneeId: string // The display name of the user currently assigned to the ticket. assigneeName: string // The picture of the user currently assigned to the ticket. assigneePicture: string // The channel ID associated with the ticket chat. channelId: string // The display name of the channel associated with the ticket chat. channelName: string // The type of the channel associated with the ticket chat. channelType: enum[api, widget, waha, whatsapp, instagram, ] // The chat ID associated with the ticket. chatId: string // Whether the chat associated with the ticket has been soft removed. chatIsRemoved: boolean // The chat owner super identity ID associated with the ticket chat. chatOwnerId: string // The shared chat memory snapshot associated with the ticket. chatPublicMemory: { } // When the ticket was completed. completedAt: string // When the ticket was created. createdAt: string // The ticket ID represented by this row. id: string // Whether the external chat owner is blocked. isOwnerBlocked: boolean // When the ticket entered the ongoing state. ongoingAt: string // The email of the chat owner when the owner is a platform user. ownerEmail: string // The owner entity type associated with the chat owner super identity. ownerEntity: enum[externalUsers, users] // The identifier of the chat owner when the owner is an external user. ownerIdentifier: string // The display name of the chat owner resolved from external users or users. ownerName: string // The number of pending chat messages still waiting on the ticket. pendingChatMessages: integer // The responder entity type assigned to the ticket chat. responderEntity: enum[agents, squads] // The responder ID assigned to the ticket chat. responderId: string // The display name of the responder assigned to the ticket chat. responderName: string // The picture of the responder assigned to the ticket chat. responderPicture: string // The version ID of the responder entity for this ticket chat. responderVersionId: string // The version number of the responder entity for this ticket chat. responderVersionNumber: integer // The lifecycle status of the ticket. status: enum[pending, ongoing, completed] // The short summary of the ticket. summary: string tags: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The number of active tickets for this tag. activeTicketCount: integer // The color of the tag. color: enum[default, gray, red, orange, yellow, green, blue, purple, pink, brown] // The description of the tag. description: string // The display name of the tag. name: string // The workspace that owns this tag. workspaceId: string }[] // The ticketing team ID currently assigned to the ticket. ticketingTeamId: string // The display name of the ticketing team currently assigned to the ticket. ticketingTeamName: string // The picture of the ticketing team currently assigned to the ticket. ticketingTeamPicture: string // The workspace ID associated with the ticket. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticket not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tickets/details - Description Retrieves multiple tickets with details. #### Parameters(Query) ```typescript assigneeIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript chatIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript includeRemoved?: boolean ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript responderIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript responderVersionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript search?: string ``` ```typescript status: enum[pending, ongoing, completed] ``` ```typescript tagIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all tickets for the workspace. `application/json` ```typescript { // The email of the user currently assigned to the ticket. assigneeEmail: string // The user ID currently assigned to the ticket. assigneeId: string // The display name of the user currently assigned to the ticket. assigneeName: string // The picture of the user currently assigned to the ticket. assigneePicture: string // The channel ID associated with the ticket chat. channelId: string // The display name of the channel associated with the ticket chat. channelName: string // The type of the channel associated with the ticket chat. channelType: enum[api, widget, waha, whatsapp, instagram, ] // The chat ID associated with the ticket. chatId: string // Whether the chat associated with the ticket has been soft removed. chatIsRemoved: boolean // The chat owner super identity ID associated with the ticket chat. chatOwnerId: string // The shared chat memory snapshot associated with the ticket. chatPublicMemory: { } // When the ticket was completed. completedAt: string // When the ticket was created. createdAt: string // The ticket ID represented by this row. id: string // Whether the external chat owner is blocked. isOwnerBlocked: boolean // When the ticket entered the ongoing state. ongoingAt: string // The email of the chat owner when the owner is a platform user. ownerEmail: string // The owner entity type associated with the chat owner super identity. ownerEntity: enum[externalUsers, users] // The identifier of the chat owner when the owner is an external user. ownerIdentifier: string // The display name of the chat owner resolved from external users or users. ownerName: string // The number of pending chat messages still waiting on the ticket. pendingChatMessages: integer // The responder entity type assigned to the ticket chat. responderEntity: enum[agents, squads] // The responder ID assigned to the ticket chat. responderId: string // The display name of the responder assigned to the ticket chat. responderName: string // The picture of the responder assigned to the ticket chat. responderPicture: string // The version ID of the responder entity for this ticket chat. responderVersionId: string // The version number of the responder entity for this ticket chat. responderVersionNumber: integer // The lifecycle status of the ticket. status: enum[pending, ongoing, completed] // The short summary of the ticket. summary: string tags: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The number of active tickets for this tag. activeTicketCount: integer // The color of the tag. color: enum[default, gray, red, orange, yellow, green, blue, purple, pink, brown] // The description of the tag. description: string // The display name of the tag. name: string // The workspace that owns this tag. workspaceId: string }[] // The ticketing team ID currently assigned to the ticket. ticketingTeamId: string // The display name of the ticketing team currently assigned to the ticket. ticketingTeamName: string // The picture of the ticketing team currently assigned to the ticket. ticketingTeamPicture: string // The workspace ID associated with the ticket. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/tickets/{id}/complete - Description Completes a ticket. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. userId: string } ``` #### Responses - 200 The ticket was completed. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The id of the user assigned to the ticket. assigneeId: string // A UUID v4 string that identifies an entity. chatId: string // The type of ticket creation: takeover (human intervention) or handover (agent automatic creation). circumstance: enum[takeover, handover] completedAt: string // The last time the ticket was viewed by the assignee. lastViewedAt: string ongoingAt: string status: enum[pending, ongoing, completed] // A brief summary of the chat up until the ticket was created. summary: string // The id of the ticketing team responsible for the ticket. ticketingTeamId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticket not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Ticket is not ongoing. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/tickets - Description Creates a new ticket. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. chatId: string // The id of the ticketing team responsible for the ticket. ticketingTeamId: string // A UUID v4 string that identifies an entity. assigneeId: string status: enum[pending, ongoing] } ``` #### Responses - 200 The ticket was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The id of the user assigned to the ticket. assigneeId: string // A UUID v4 string that identifies an entity. chatId: string // The type of ticket creation: takeover (human intervention) or handover (agent automatic creation). circumstance: enum[takeover, handover] completedAt: string // The last time the ticket was viewed by the assignee. lastViewedAt: string ongoingAt: string status: enum[pending, ongoing, completed] // A brief summary of the chat up until the ticket was created. summary: string // The id of the ticketing team responsible for the ticket. ticketingTeamId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Chat not found or assignee not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 409 Ticket already exists. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/tickets/{ticketId}/tags - Description Creates tags for a ticket. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. tagId: string } ``` #### Responses - 200 The tag was attached to the ticket. `application/json` ```typescript { createdAt: string updatedAt: string // The tag associated with the ticket. tagId: string // The ticket associated with the tag. ticketId: string tag: { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The number of active tickets for this tag. activeTicketCount: integer // The color of the tag. color: enum[default, gray, red, orange, yellow, green, blue, purple, pink, brown] // The description of the tag. description: string // The display name of the tag. name: string // The workspace that owns this tag. workspaceId: string } } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticket or tag not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/tickets/{ticketId}/tags/{tagId} - Description Removes a tag from a ticket. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The tag was removed from the ticket. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticket tag relationship not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/tickets/{id}/takeover - Description Takes over a ticket. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. assigneeId: string } ``` #### Responses - 200 The ticket was taken over. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The id of the user assigned to the ticket. assigneeId: string // A UUID v4 string that identifies an entity. chatId: string // The type of ticket creation: takeover (human intervention) or handover (agent automatic creation). circumstance: enum[takeover, handover] completedAt: string // The last time the ticket was viewed by the assignee. lastViewedAt: string ongoingAt: string status: enum[pending, ongoing, completed] // A brief summary of the chat up until the ticket was created. summary: string // The id of the ticketing team responsible for the ticket. ticketingTeamId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticket not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Ticket is not ongoing or already assigned. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/tickets/{id}/assignee - Description Updates the assignee of a ticket. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. assigneeId: string } ``` #### Responses - 200 The ticket was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // The id of the user assigned to the ticket. assigneeId: string // A UUID v4 string that identifies an entity. chatId: string // The type of ticket creation: takeover (human intervention) or handover (agent automatic creation). circumstance: enum[takeover, handover] completedAt: string // The last time the ticket was viewed by the assignee. lastViewedAt: string ongoingAt: string status: enum[pending, ongoing, completed] // A brief summary of the chat up until the ticket was created. summary: string // The id of the ticketing team responsible for the ticket. ticketingTeamId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Ticket not found or assignee not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 Ticket is completed. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/tiers - Description Creates a new tier. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A description of the tier. description: string // The maximum number of assistant messages allowed for this tier. maxAssistantMessages: integer // The name of the tier. name: string // The prompt associated with the tier to be injected into the agent. prompt: string } ``` #### Responses - 200 The tier was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A description of the tier. description: string // The maximum number of assistant messages allowed for this tier. maxAssistantMessages: integer // The name of the tier. name: string // The prompt associated with the tier to be injected into the agent. prompt: string // The ID of the workspace this tier belongs to. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 409 Tier name already exists in this workspace. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tiers - Description Retrieves multiple tiers. #### Parameters(Query) ```typescript ids?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter tiers by name or description. search?: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all tiers for the workspace. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A description of the tier. description: string // The maximum number of assistant messages allowed for this tier. maxAssistantMessages: integer // The name of the tier. name: string // The prompt associated with the tier to be injected into the agent. prompt: string // The ID of the workspace this tier belongs to. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/tiers/{id} - Description Removes a tier. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The tier was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Tier not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tiers/{id} - Description Retrieves a tier. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a tier. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A description of the tier. description: string // The maximum number of assistant messages allowed for this tier. maxAssistantMessages: integer // The name of the tier. name: string // The prompt associated with the tier to be injected into the agent. prompt: string // The ID of the workspace this tier belongs to. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Tier not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [PATCH]/api/v1/tiers/{id} - Description Updates a tier. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A description of the tier. description?: string // The maximum number of assistant messages allowed for this tier. maxAssistantMessages?: integer // The name of the tier. name?: string // The prompt associated with the tier to be injected into the agent. prompt?: string } ``` #### Responses - 200 The tier was updated. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A description of the tier. description: string // The maximum number of assistant messages allowed for this tier. maxAssistantMessages: integer // The name of the tier. name: string // The prompt associated with the tier to be injected into the agent. prompt: string // The ID of the workspace this tier belongs to. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Tier not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 409 Tier name already exists in this workspace. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/tools - Description Creates a new tool. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string } ``` #### Responses - 200 The tool was created. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string } ``` - 400 Invalid tool configuration. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tools - Description Retrieves multiple tools. #### Parameters(Query) ```typescript agentIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` ```typescript joins?: Partial(enum[agents][]) & Partial(string) ``` ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` ```typescript // Search term to filter tools by name or description. search?: string ``` ```typescript versionIds?: Partial( // A UUID v4 string that identifies an entity. string[]) & Partial(string) ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all tools for the workspace. `application/json` ```typescript undefined?: Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string agentTools: { createdAt: string updatedAt: string // The id of the agent to link the tool to. agentId: string // The id of the tool to link to the agent. toolId: string agent: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string } }[] }) & Partial({ createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string })[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [DELETE]/api/v1/tools/{id} - Description Removes a tool. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The tool was removed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Tool not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/tools/{id} - Description Retrieves a tool. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves a tool. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 Tool not found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/versions/check-creation-balance - Description Checks if version creation balance is available. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Version creation balance checked successfully. `application/json` ```typescript { availableAt: string canCreate: boolean remainingBalance: integer } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/versions/deploy - Description Deploys the current draft version. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 The draft version was deployed. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/versions/diff - Description Retrieves differences between source and target versions. #### Parameters(Query) ```typescript // A UUID v4 string that identifies an entity. sourceId: string ``` ```typescript // A UUID v4 string that identifies an entity. targetId: string ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Version differences retrieved successfully. `application/json` ```typescript { added: { agentMcps: { createdAt: string updatedAt: string // The id of the agent to link the MCP to. agentId: string // The id of the MCP to link to the agent. mcpId: string }[] agentTools: { createdAt: string updatedAt: string // The id of the agent to link the tool to. agentId: string // The id of the tool to link to the agent. toolId: string }[] agents: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string }[] components: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The detail configuration of the component. detail: Partial({ type: enum[boolean] value: boolean }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[string] value: string }) // The unique key identifier for this component within the workspace. key: string // The workspace that owns this component. workspaceId: string }[] mcps: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string // The workspace ID that owns the MCP. workspaceId: string }[] squadAgents: { createdAt: string updatedAt: string // A UUID v4 string that identifies an entity. agentId: string // A UUID v4 string that identifies an entity. squadId: string type: enum[member, main] }[] squads: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string }[] tasks: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The agent ID associated with the task. agentId: string // The condition that must be met for the task to be executed. condition: string // The display name of the task. name: string // What will be set as the main object of the agent when the task is selected. prompt: string // The lifecycle status of the task. status: enum[active, inactive] }[] tools: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string }[] voices: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The voice configuration details. detail: { // Voice instructions that guide the TTS model on tone, style, and delivery. instructions: string // The TTS model to use. model: enum[gpt-4o-mini-tts] // The voice name to use for TTS. name: enum[ash, ballad, cedar, coral, echo, fable, marin, nova, onyx, sage, shimmer, verse] // The speed of the voice. Must be a multiple of 0.25, between 0.25 and 4.0. speed: number } // The workspace this voice belongs to. workspaceId: string }[] } kept: { agentMcps: { createdAt: string updatedAt: string // The id of the agent to link the MCP to. agentId: string // The id of the MCP to link to the agent. mcpId: string }[] agentTools: { createdAt: string updatedAt: string // The id of the agent to link the tool to. agentId: string // The id of the tool to link to the agent. toolId: string }[] agents: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string }[] components: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The detail configuration of the component. detail: Partial({ type: enum[boolean] value: boolean }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[string] value: string }) // The unique key identifier for this component within the workspace. key: string // The workspace that owns this component. workspaceId: string }[] mcps: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string // The workspace ID that owns the MCP. workspaceId: string }[] squadAgents: { createdAt: string updatedAt: string // A UUID v4 string that identifies an entity. agentId: string // A UUID v4 string that identifies an entity. squadId: string type: enum[member, main] }[] squads: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string }[] tasks: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The agent ID associated with the task. agentId: string // The condition that must be met for the task to be executed. condition: string // The display name of the task. name: string // What will be set as the main object of the agent when the task is selected. prompt: string // The lifecycle status of the task. status: enum[active, inactive] }[] tools: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string }[] voices: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The voice configuration details. detail: { // Voice instructions that guide the TTS model on tone, style, and delivery. instructions: string // The TTS model to use. model: enum[gpt-4o-mini-tts] // The voice name to use for TTS. name: enum[ash, ballad, cedar, coral, echo, fable, marin, nova, onyx, sage, shimmer, verse] // The speed of the voice. Must be a multiple of 0.25, between 0.25 and 4.0. speed: number } // The workspace this voice belongs to. workspaceId: string }[] } removed: { agentMcps: { createdAt: string updatedAt: string // The id of the agent to link the MCP to. agentId: string // The id of the MCP to link to the agent. mcpId: string }[] agentTools: { createdAt: string updatedAt: string // The id of the agent to link the tool to. agentId: string // The id of the tool to link to the agent. toolId: string }[] agents: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // Whether the agent should be able to execute JavaScript code using the Code Runtime tool. codeRuntime: boolean // The internal name of the agent. For internal use only. internalName: string // The number of iterations (steps) the agent can execute in a single execution. iterations: number // The LLM model key to use for the agent. llm: enum[claude-haiku-4-5, claude-opus-4-6, claude-opus-4-5, claude-sonnet-4-6, claude-sonnet-4-5, gpt-5.2, gpt-5.5, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gemini-2.5-flash, gemini-2.5-pro, gemini-3-flash, gemini-3-pro, gemini-3.1-pro, kimi-k2.5, kimi-k2.6] // The id of the LLM provider to use for the agent. llmProviderId: string // The name of the agent. name: string // The picture of the agent. picture: string // Whether the agent should plan before each execution. planning: boolean // The main description of the agent's behavior. prompt: string // The reasoning mode to use for the agent. If null, reasoning will be disabled. reasoningMode: enum[low, medium, high, xhigh, ] // The role of the agent. Particularly useful to give other agents context of what the agent does. role: string // The super identity ID associated with the agent. superIdentityId: string // The temperature to use for the agent. The lower the more deterministic. The higher the more creative. temperature: number // The timezone to use for the agent. If null, no timezone will be used. timezone: enum[Africa/Cairo, Africa/Johannesburg, America/Chicago, America/Denver, America/Los_Angeles, America/New_York, America/Sao_Paulo, America/Manaus, Asia/Dubai, Asia/Kolkata, Asia/Shanghai, Asia/Singapore, Asia/Tokyo, Australia/Sydney, Europe/Berlin, Europe/London, Europe/Moscow, Europe/Paris, Pacific/Auckland, Pacific/Auckland2, UTC, auto, ] // The number of tools currently associated with the agent. toolCount: integer // The TTS voice to use for audio responses. Null when disabled for the agent. voiceId: string // The workspace ID that owns the agent. workspaceId: string }[] components: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The detail configuration of the component. detail: Partial({ type: enum[boolean] value: boolean }) & Partial({ type: enum[number] value: number }) & Partial({ type: enum[string] value: string }) // The unique key identifier for this component within the workspace. key: string // The workspace that owns this component. workspaceId: string }[] mcps: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The id of the connection the MCP will be used through. connectionId: string // The internal description of the MCP. description: string detail: { tools?: string[] type: enum[composio-airtable, composio-asana, composio-bannerbear, composio-browseai, composio-browser-tool, composio-calendly, composio-clickup, composio-discord, composio-dropbox, composio-facebook, composio-figma, composio-genderize, composio-github, composio-gitlab, composio-gmail, composio-google-analytics, composio-google-calendar, composio-google-docs, composio-google-drive, composio-google-maps, composio-google-meet, composio-google-sheets, composio-google-slides, composio-google-tasks, composio-hubspot, composio-hugging-face, composio-instagram, composio-linear, composio-linkedin, composio-mailersend, composio-manus, composio-mem0, composio-meta-ads, composio-microsoft-clarity, composio-miro, composio-mixpanel, composio-monday, composio-notion, composio-one-drive, composio-openweather-api, composio-outlook, composio-polygon-io, composio-postman, composio-prisma, composio-pushbullet, composio-reddit, composio-resend, composio-salesforce, composio-scrape-do, composio-search-api, composio-sendgrid, composio-sentry, composio-serpapi, composio-short-io, composio-short-menu, composio-slack, composio-slackbot, composio-stripe, composio-supabase, composio-tavily, composio-teams, composio-telegram, composio-ticktick, composio-todoist, composio-trello, composio-twitter, composio-typeform, composio-youtube, composio-zenrows] } // The display name of the MCP. name: string // The workspace ID that owns the MCP. workspaceId: string }[] squadAgents: { createdAt: string updatedAt: string // A UUID v4 string that identifies an entity. agentId: string // A UUID v4 string that identifies an entity. squadId: string type: enum[member, main] }[] squads: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the squad. description: string // The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager. mode: enum[hierarchical, flat] // The display name of the squad. name: string // The picture associated with the squad. picture: string // The super identity ID associated with the squad. superIdentityId: string // The workspace ID that owns the squad. workspaceId: string }[] tasks: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The agent ID associated with the task. agentId: string // The condition that must be met for the task to be executed. condition: string // The display name of the task. name: string // What will be set as the main object of the agent when the task is selected. prompt: string // The lifecycle status of the task. status: enum[active, inactive] }[] tools: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The internal description of the tool. description: string detail: Partial({ allowedDomains?: string[] // Web search effort level. effort: enum[low, medium, high] // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // Optional OpenAI LLM provider ID to be used in this tool call. llmProviderId: string // Prompt to be appended alongside queries to instruct the LLM call. prompt: string type: enum[agentic-web-search] }) & Partial({ // The body of the HTTP request as JSON string. body: string // The headers of the HTTP request as JSON string. headers: string method: enum[GET, POST, PUT, PATCH, DELETE] // The JSON Schema definition of the parameters that will be passed to the HTTP request. parameters: { properties: { } required?: string[] type: enum[object] } // The query parameters of the HTTP request as JSON string. query: string type: enum[http-request] // The URL to send the HTTP request to. Should not contain query parameters. url: string }) & Partial({ // The code to be executed. Must contain a function named main that takes no parameters. code: string // The JSON Schema definition of the parameters that will be passed to the code execution tool. parameters: { properties: { } required?: string[] type: enum[object] } type: enum[code-execution] }) & Partial({ // The JSON Schema definition of the parameters containing the description of the memory to be stored. parameters: { properties: { } required?: string[] type: enum[object] } sensitiveParameters?: string[] type: enum[contextual-memory] }) & Partial({ // The id of the dataset to search in. datasetId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The mode of the dataset search. mode: enum[scoped, global] type: enum[dataset-search] }) & Partial({ // The id of the datagrid to update the row in. datagridId: string type: enum[datagrid-row-update] }) & Partial({ // The id of the datagrid to insert the row into. datagridId: string type: enum[datagrid-row-insertion] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // Whether the search should always be executed or only if the agent decides to do it. execution: enum[eligible, compulsory] // The number of results to return to the agent. results: number type: enum[datagrid-row-semantic-search] }) & Partial({ // The id of the datagrid to search the row in. datagridId: string // The number of results to return to the agent. results: number type: enum[datagrid-row-similarity-search] }) & Partial({ // Tagging configuration for tickets. tagging: { // A UUID v4 string that identifies an entity. allowedIds?: string[] status: enum[enabled, disabled] } // The id of the ticketing team responsible for the ticket. ticketingTeamId: string type: enum[ticket-creation] }) & Partial({ // The path of the trigger to the workflow implementation to execute. path: string type: enum[workflow-executor] }) & Partial({ file: string // The name of the PDF file. fileName: string type: enum[pdf-reader] }) & Partial({ execution: enum[eligible, compulsory] fallback: { prompt: string } options: { condition: string label: string prompt: string }[] type: enum[follow-up] }) & Partial({ // The ID of the messaging connection to use. connectionId: string // The execution mode. mode: enum[discover, preset] phoneNumbers: { // The DDI of the phone number. ddi: string // The phone number to send the message to including the state prefix. phoneNumber: string }[] type: enum[message-dispatch] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // OpenAI image model to use for this tool call. model: enum[gpt-image-1, gpt-image-2] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[openai] type: enum[image-generation] }) & Partial({ // Optional LLM provider ID to be used in this tool call. llmProviderId: string // Gemini image model to use for this tool call. model: enum[gemini-3.1-flash-image, gemini-3-pro-image] // Prompt to be prepended to image generation calls. prompt: string // Image generation provider to use for this tool call. provider: enum[google-ai] type: enum[image-generation] }) & Partial({ // An optional delay in milliseconds to be waited after the event is emitted and, if applicable, a response is received. delay: integer // The name of the client-side event to listen for. event: string // Optional mock configuration for testing purposes. mock: { // An optional delay in milliseconds before returning the mock response when testing. delay: integer // An optional mock response to be returned when testing. response: { } } // The JSON schema of the parameters to pass with the event. parameters: { properties: { } required?: string[] type: enum[object] } // An optional payload to bind parameters to. payload: string // The maximum time in milliseconds to wait for a response before timing out. timeout: integer type: enum[client-side-call] // Whether to wait for a response after emitting the event. waitResponse: boolean }) // The display name of the tool. name: string // The workspace ID that owns the tool. workspaceId: string }[] voices: { createdAt: string // A UUID v4 string that identifies an entity. id: string isRemoved: boolean // The ID of the original entity in production. referenceId: string updatedAt: string // A UUID v4 string that identifies an entity. versionId: string // The voice configuration details. detail: { // Voice instructions that guide the TTS model on tone, style, and delivery. instructions: string // The TTS model to use. model: enum[gpt-4o-mini-tts] // The voice name to use for TTS. name: enum[ash, ballad, cedar, coral, echo, fable, marin, nova, onyx, sage, shimmer, verse] // The speed of the voice. Must be a multiple of 0.25, between 0.25 and 4.0. speed: number } // The workspace this voice belongs to. workspaceId: string }[] } } ``` - 400 Bad Request. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 One or more versions could not be found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/versions - Description Retrieves multiple versions. #### Parameters(Query) ```typescript // The page number. pageNumber?: number //default: 1 ``` ```typescript // The page size. pageSize?: number //default: 10 ``` #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all versions for the workspace scope. `application/json` ```typescript { createdAt: string // A UUID v4 string that identifies an entity. id: string updatedAt: string // A UUID v4 string that identifies an entity. brandId: string // The version number. -1 indicates a draft version and 0 indicates the production version. Higher numbers are snapshots created during deploys. number: number // The ID of version that this version is based on. referenceId: string // A UUID v4 string that identifies an entity. workspaceId: string }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [POST]/api/v1/versions/rollback - Description Rolls back the current draft version to a specific version. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### RequestBody - application/json ```typescript { // A UUID v4 string that identifies an entity. id: string } ``` #### Responses - 200 The draft version was rolled back. `application/json` ```typescript { // An informative message for a call that has no effective result to be returned. message: string } ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 404 The target version could not be found. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` - 412 The target version is invalid for rollback. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` *** ### [GET]/api/v1/voices/options - Description Retrieves available voice options for TTS. #### Headers ```typescript // The API key to use for authentication. Can be created in the api keys section on the workspace settings page. authorization: string ``` #### Responses - 200 Retrieves all available voice options. `application/json` ```typescript { gender: enum[male, female] model: string name: string provider: enum[openai] }[] ``` - 401 Unauthorized. `application/json` ```typescript // The description of a known exception. { // The error code. code?: string // The error call-to-action. cta: { type: enum[support-contact] url: string } // The error feedback. feedback: { enUs?: string ptBr?: string } // The error message. message: string // The error name. name: string } ``` ## References