/api/v1/versions/diff

GET

const url = 'https://api.endless.zaia.app/api/v1/versions/diff?sourceId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&targetId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.endless.zaia.app/api/v1/versions/diff?sourceId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&targetId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Retrieves differences between source and target versions.

Parameters

Query Parameters

sourceId

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

targetId

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Responses

200

Version differences retrieved successfully.

application/json

object

added

required

object

agentMcps

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the MCP to.

string format: uuid

mcpId

required

The id of the MCP to link to the agent.

string format: uuid

agentTools

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the tool to.

string format: uuid

toolId

required

The id of the tool to link to the agent.

string format: uuid

agents

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

codeRuntime

required

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

boolean

internalName

required

The internal name of the agent. For internal use only.

string

nullable >= 3 characters <= 50 characters

iterations

required

The number of iterations (steps) the agent can execute in a single execution.

number

>= 2 <= 100

llm

required

The LLM model key to use for the agent.

string

Allowed values: claude-haiku-4-5 claude-opus-4-8 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 gpt-5.6-luna gpt-5.6-sol gpt-5.6-terra gemini-2.5-flash gemini-2.5-pro gemini-3.5-flash gemini-3-flash gemini-3-pro gemini-3.1-pro kimi-k2.5 kimi-k2.6 grok-4.3 grok-4.5

llmProviderId

required

The id of the LLM provider to use for the agent.

string format: uuid

nullable

name

required

The name of the agent.

string

>= 3 characters <= 50 characters

picture

required

The picture of the agent.

string

nullable

planning

required

Whether the agent should plan before each execution.

boolean

prompt

required

The main description of the agent’s behavior.

string

>= 1 characters <= 10000 characters

reasoningMode

required

The reasoning mode to use for the agent. If null, reasoning will be disabled.

string

nullable

Allowed values: low medium high xhigh

role

required

The role of the agent. Particularly useful to give other agents context of what the agent does.

string

>= 1 characters <= 250 characters

superIdentityId

required

The super identity ID associated with the agent.

string format: uuid

temperature

required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

number

<= 2

timezone

required

The timezone to use for the agent. If null, no timezone will be used.

string

nullable

Allowed values: 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

toolCount

required

The number of tools currently associated with the agent.

integer

voiceId

required

The TTS voice to use for audio responses. Null when disabled for the agent.

string format: uuid

nullable

workspaceId

required

The workspace ID that owns the agent.

string format: uuid

components

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

Any of:

object

type

required

string

Allowed values: boolean

value

required

boolean

key

required

The unique key identifier for this component within the workspace.

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9_]+$/

workspaceId

required

The workspace that owns this component.

string format: uuid

mcps

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

connectionId

required

The id of the connection the MCP will be used through.

string format: uuid

nullable

description

required

The internal description of the MCP.

string

nullable >= 3 characters <= 250 characters

detail

required

One of:

object

object

tools

required

Array<string>

>= 1 items

type

required

string

Allowed values: 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

name

required

The display name of the MCP.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the MCP.

string format: uuid

squadAgents

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

A UUID v4 string that identifies an entity.

string format: uuid

squadId

required

A UUID v4 string that identifies an entity.

string format: uuid

type

required

string

Allowed values: member main

squads

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the squad.

string

nullable >= 3 characters <= 250 characters

mode

required

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

string

Allowed values: hierarchical flat

name

required

The display name of the squad.

string

>= 3 characters <= 50 characters

picture

required

The picture associated with the squad.

string

nullable

superIdentityId

required

The super identity ID associated with the squad.

string format: uuid

workspaceId

required

The workspace ID that owns the squad.

string format: uuid

tasks

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

agentId

required

The agent ID associated with the task.

string format: uuid

condition

required

The condition that must be met for the task to be executed.

string

>= 3 characters <= 250 characters

name

required

The display name of the task.

string

>= 3 characters <= 50 characters

prompt

required

What will be set as the main object of the agent when the task is selected.

string

>= 3 characters <= 2000 characters

status

required

The lifecycle status of the task.

string

Allowed values: active inactive

tools

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the tool.

string

>= 3 characters <= 250 characters

detail

required

Any of:

object

allowedDomains

required

List of domains allowed in web search results.

Array<string>

effort

required

Web search effort level.

string

Allowed values: low medium high

execution

required

Whether the search should always be executed or only if the agent decides to do it.

string

Allowed values: eligible compulsory

llmProviderId

required

Optional OpenAI LLM provider ID to be used in this tool call.

string format: uuid

nullable

prompt

required

Prompt to be appended alongside queries to instruct the LLM call.

string

nullable <= 500 characters

type

required

string

Allowed values: agentic-web-search

name

required

The display name of the tool.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the tool.

string format: uuid

voices

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

The voice configuration details.

object

instructions

required

Voice instructions that guide the TTS model on tone, style, and delivery.

string

nullable >= 1 characters <= 1000 characters

model

required

The TTS model to use.

string

Allowed values: gpt-4o-mini-tts

name

required

The voice name to use for TTS.

string

Allowed values: ash ballad cedar coral echo fable marin nova onyx sage shimmer verse

speed

required

The speed of the voice. Must be a multiple of 0.25, between 0.25 and 4.0.

number

>= 0.25 <= 4

workspaceId

required

The workspace this voice belongs to.

string format: uuid

kept

required

object

agentMcps

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the MCP to.

string format: uuid

mcpId

required

The id of the MCP to link to the agent.

string format: uuid

agentTools

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the tool to.

string format: uuid

toolId

required

The id of the tool to link to the agent.

string format: uuid

agents

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

codeRuntime

required

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

boolean

internalName

required

The internal name of the agent. For internal use only.

string

nullable >= 3 characters <= 50 characters

iterations

required

The number of iterations (steps) the agent can execute in a single execution.

number

>= 2 <= 100

llm

required

The LLM model key to use for the agent.

string

llmProviderId

required

The id of the LLM provider to use for the agent.

string format: uuid

nullable

name

required

The name of the agent.

string

>= 3 characters <= 50 characters

picture

required

The picture of the agent.

string

nullable

planning

required

Whether the agent should plan before each execution.

boolean

prompt

required

The main description of the agent’s behavior.

string

>= 1 characters <= 10000 characters

reasoningMode

required

The reasoning mode to use for the agent. If null, reasoning will be disabled.

string

nullable

Allowed values: low medium high xhigh

role

required

The role of the agent. Particularly useful to give other agents context of what the agent does.

string

>= 1 characters <= 250 characters

superIdentityId

required

The super identity ID associated with the agent.

string format: uuid

temperature

required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

number

<= 2

timezone

required

The timezone to use for the agent. If null, no timezone will be used.

string

nullable

toolCount

required

The number of tools currently associated with the agent.

integer

voiceId

required

The TTS voice to use for audio responses. Null when disabled for the agent.

string format: uuid

nullable

workspaceId

required

The workspace ID that owns the agent.

string format: uuid

components

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

Any of:

object

type

required

string

Allowed values: boolean

value

required

boolean

key

required

The unique key identifier for this component within the workspace.

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9_]+$/

workspaceId

required

The workspace that owns this component.

string format: uuid

mcps

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

connectionId

required

The id of the connection the MCP will be used through.

string format: uuid

nullable

description

required

The internal description of the MCP.

string

nullable >= 3 characters <= 250 characters

detail

required

One of:

object

object

tools

required

Array<string>

>= 1 items

type

required

string

name

required

The display name of the MCP.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the MCP.

string format: uuid

squadAgents

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

A UUID v4 string that identifies an entity.

string format: uuid

squadId

required

A UUID v4 string that identifies an entity.

string format: uuid

type

required

string

Allowed values: member main

squads

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the squad.

string

nullable >= 3 characters <= 250 characters

mode

required

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

string

Allowed values: hierarchical flat

name

required

The display name of the squad.

string

>= 3 characters <= 50 characters

picture

required

The picture associated with the squad.

string

nullable

superIdentityId

required

The super identity ID associated with the squad.

string format: uuid

workspaceId

required

The workspace ID that owns the squad.

string format: uuid

tasks

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

agentId

required

The agent ID associated with the task.

string format: uuid

condition

required

The condition that must be met for the task to be executed.

string

>= 3 characters <= 250 characters

name

required

The display name of the task.

string

>= 3 characters <= 50 characters

prompt

required

What will be set as the main object of the agent when the task is selected.

string

>= 3 characters <= 2000 characters

status

required

The lifecycle status of the task.

string

Allowed values: active inactive

tools

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the tool.

string

>= 3 characters <= 250 characters

detail

required

Any of:

object

allowedDomains

required

List of domains allowed in web search results.

Array<string>

effort

required

Web search effort level.

string

Allowed values: low medium high

execution

required

Whether the search should always be executed or only if the agent decides to do it.

string

Allowed values: eligible compulsory

llmProviderId

required

Optional OpenAI LLM provider ID to be used in this tool call.

string format: uuid

nullable

prompt

required

Prompt to be appended alongside queries to instruct the LLM call.

string

nullable <= 500 characters

type

required

string

Allowed values: agentic-web-search

name

required

The display name of the tool.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the tool.

string format: uuid

voices

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

The voice configuration details.

object

instructions

required

Voice instructions that guide the TTS model on tone, style, and delivery.

string

nullable >= 1 characters <= 1000 characters

model

required

The TTS model to use.

string

Allowed values: gpt-4o-mini-tts

name

required

The voice name to use for TTS.

string

Allowed values: ash ballad cedar coral echo fable marin nova onyx sage shimmer verse

speed

required

The speed of the voice. Must be a multiple of 0.25, between 0.25 and 4.0.

number

>= 0.25 <= 4

workspaceId

required

The workspace this voice belongs to.

string format: uuid

modified

required

object

agentMcps

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the MCP to.

string format: uuid

mcpId

required

The id of the MCP to link to the agent.

string format: uuid

target

required

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the MCP to.

string format: uuid

mcpId

required

The id of the MCP to link to the agent.

string format: uuid

agentTools

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the tool to.

string format: uuid

toolId

required

The id of the tool to link to the agent.

string format: uuid

target

required

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the tool to.

string format: uuid

toolId

required

The id of the tool to link to the agent.

string format: uuid

agents

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

codeRuntime

required

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

boolean

internalName

required

The internal name of the agent. For internal use only.

string

nullable >= 3 characters <= 50 characters

iterations

required

The number of iterations (steps) the agent can execute in a single execution.

number

>= 2 <= 100

llm

required

The LLM model key to use for the agent.

string

llmProviderId

required

The id of the LLM provider to use for the agent.

string format: uuid

nullable

name

required

The name of the agent.

string

>= 3 characters <= 50 characters

picture

required

The picture of the agent.

string

nullable

planning

required

Whether the agent should plan before each execution.

boolean

prompt

required

The main description of the agent’s behavior.

string

>= 1 characters <= 10000 characters

reasoningMode

required

The reasoning mode to use for the agent. If null, reasoning will be disabled.

string

nullable

Allowed values: low medium high xhigh

role

required

The role of the agent. Particularly useful to give other agents context of what the agent does.

string

>= 1 characters <= 250 characters

superIdentityId

required

The super identity ID associated with the agent.

string format: uuid

temperature

required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

number

<= 2

timezone

required

The timezone to use for the agent. If null, no timezone will be used.

string

nullable

toolCount

required

The number of tools currently associated with the agent.

integer

voiceId

required

The TTS voice to use for audio responses. Null when disabled for the agent.

string format: uuid

nullable

workspaceId

required

The workspace ID that owns the agent.

string format: uuid

target

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

codeRuntime

required

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

boolean

internalName

required

The internal name of the agent. For internal use only.

string

nullable >= 3 characters <= 50 characters

iterations

required

The number of iterations (steps) the agent can execute in a single execution.

number

>= 2 <= 100

llm

required

The LLM model key to use for the agent.

string

llmProviderId

required

The id of the LLM provider to use for the agent.

string format: uuid

nullable

name

required

The name of the agent.

string

>= 3 characters <= 50 characters

picture

required

The picture of the agent.

string

nullable

planning

required

Whether the agent should plan before each execution.

boolean

prompt

required

The main description of the agent’s behavior.

string

>= 1 characters <= 10000 characters

reasoningMode

required

The reasoning mode to use for the agent. If null, reasoning will be disabled.

string

nullable

Allowed values: low medium high xhigh

role

required

The role of the agent. Particularly useful to give other agents context of what the agent does.

string

>= 1 characters <= 250 characters

superIdentityId

required

The super identity ID associated with the agent.

string format: uuid

temperature

required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

number

<= 2

timezone

required

The timezone to use for the agent. If null, no timezone will be used.

string

nullable

toolCount

required

The number of tools currently associated with the agent.

integer

voiceId

required

The TTS voice to use for audio responses. Null when disabled for the agent.

string format: uuid

nullable

workspaceId

required

The workspace ID that owns the agent.

string format: uuid

components

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

Any of:

object

type

required

string

Allowed values: boolean

value

required

boolean

key

required

The unique key identifier for this component within the workspace.

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9_]+$/

workspaceId

required

The workspace that owns this component.

string format: uuid

target

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

Any of:

object

type

required

string

Allowed values: boolean

value

required

boolean

key

required

The unique key identifier for this component within the workspace.

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9_]+$/

workspaceId

required

The workspace that owns this component.

string format: uuid

mcps

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

connectionId

required

The id of the connection the MCP will be used through.

string format: uuid

nullable

description

required

The internal description of the MCP.

string

nullable >= 3 characters <= 250 characters

detail

required

One of:

object

object

tools

required

Array<string>

>= 1 items

type

required

string

name

required

The display name of the MCP.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the MCP.

string format: uuid

target

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

connectionId

required

The id of the connection the MCP will be used through.

string format: uuid

nullable

description

required

The internal description of the MCP.

string

nullable >= 3 characters <= 250 characters

detail

required

One of:

object

object

tools

required

Array<string>

>= 1 items

type

required

string

name

required

The display name of the MCP.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the MCP.

string format: uuid

squadAgents

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

A UUID v4 string that identifies an entity.

string format: uuid

squadId

required

A UUID v4 string that identifies an entity.

string format: uuid

type

required

string

Allowed values: member main

target

required

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

A UUID v4 string that identifies an entity.

string format: uuid

squadId

required

A UUID v4 string that identifies an entity.

string format: uuid

type

required

string

Allowed values: member main

squads

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the squad.

string

nullable >= 3 characters <= 250 characters

mode

required

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

string

Allowed values: hierarchical flat

name

required

The display name of the squad.

string

>= 3 characters <= 50 characters

picture

required

The picture associated with the squad.

string

nullable

superIdentityId

required

The super identity ID associated with the squad.

string format: uuid

workspaceId

required

The workspace ID that owns the squad.

string format: uuid

target

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the squad.

string

nullable >= 3 characters <= 250 characters

mode

required

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

string

Allowed values: hierarchical flat

name

required

The display name of the squad.

string

>= 3 characters <= 50 characters

picture

required

The picture associated with the squad.

string

nullable

superIdentityId

required

The super identity ID associated with the squad.

string format: uuid

workspaceId

required

The workspace ID that owns the squad.

string format: uuid

tasks

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

agentId

required

The agent ID associated with the task.

string format: uuid

condition

required

The condition that must be met for the task to be executed.

string

>= 3 characters <= 250 characters

name

required

The display name of the task.

string

>= 3 characters <= 50 characters

prompt

required

What will be set as the main object of the agent when the task is selected.

string

>= 3 characters <= 2000 characters

status

required

The lifecycle status of the task.

string

Allowed values: active inactive

target

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

agentId

required

The agent ID associated with the task.

string format: uuid

condition

required

The condition that must be met for the task to be executed.

string

>= 3 characters <= 250 characters

name

required

The display name of the task.

string

>= 3 characters <= 50 characters

prompt

required

What will be set as the main object of the agent when the task is selected.

string

>= 3 characters <= 2000 characters

status

required

The lifecycle status of the task.

string

Allowed values: active inactive

tools

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the tool.

string

>= 3 characters <= 250 characters

detail

required

Any of:

object

allowedDomains

required

List of domains allowed in web search results.

Array<string>

effort

required

Web search effort level.

string

Allowed values: low medium high

execution

required

Whether the search should always be executed or only if the agent decides to do it.

string

Allowed values: eligible compulsory

llmProviderId

required

Optional OpenAI LLM provider ID to be used in this tool call.

string format: uuid

nullable

prompt

required

Prompt to be appended alongside queries to instruct the LLM call.

string

nullable <= 500 characters

type

required

string

Allowed values: agentic-web-search

name

required

The display name of the tool.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the tool.

string format: uuid

target

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the tool.

string

>= 3 characters <= 250 characters

detail

required

Any of:

object

allowedDomains

required

List of domains allowed in web search results.

Array<string>

effort

required

Web search effort level.

string

Allowed values: low medium high

execution

required

Whether the search should always be executed or only if the agent decides to do it.

string

Allowed values: eligible compulsory

llmProviderId

required

Optional OpenAI LLM provider ID to be used in this tool call.

string format: uuid

nullable

prompt

required

Prompt to be appended alongside queries to instruct the LLM call.

string

nullable <= 500 characters

type

required

string

Allowed values: agentic-web-search

name

required

The display name of the tool.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the tool.

string format: uuid

voices

required

Array<object>

object

source

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

The voice configuration details.

object

instructions

required

Voice instructions that guide the TTS model on tone, style, and delivery.

string

nullable >= 1 characters <= 1000 characters

model

required

The TTS model to use.

string

Allowed values: gpt-4o-mini-tts

name

required

The voice name to use for TTS.

string

Allowed values: ash ballad cedar coral echo fable marin nova onyx sage shimmer verse

speed

required

The speed of the voice. Must be a multiple of 0.25, between 0.25 and 4.0.

number

>= 0.25 <= 4

workspaceId

required

The workspace this voice belongs to.

string format: uuid

target

required

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

The voice configuration details.

object

instructions

required

Voice instructions that guide the TTS model on tone, style, and delivery.

string

nullable >= 1 characters <= 1000 characters

model

required

The TTS model to use.

string

Allowed values: gpt-4o-mini-tts

name

required

The voice name to use for TTS.

string

Allowed values: ash ballad cedar coral echo fable marin nova onyx sage shimmer verse

speed

required

The speed of the voice. Must be a multiple of 0.25, between 0.25 and 4.0.

number

>= 0.25 <= 4

workspaceId

required

The workspace this voice belongs to.

string format: uuid

removed

required

object

agentMcps

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the MCP to.

string format: uuid

mcpId

required

The id of the MCP to link to the agent.

string format: uuid

agentTools

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

The id of the agent to link the tool to.

string format: uuid

toolId

required

The id of the tool to link to the agent.

string format: uuid

agents

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

codeRuntime

required

Whether the agent should be able to execute JavaScript code using the Code Runtime tool.

boolean

internalName

required

The internal name of the agent. For internal use only.

string

nullable >= 3 characters <= 50 characters

iterations

required

The number of iterations (steps) the agent can execute in a single execution.

number

>= 2 <= 100

llm

required

The LLM model key to use for the agent.

string

llmProviderId

required

The id of the LLM provider to use for the agent.

string format: uuid

nullable

name

required

The name of the agent.

string

>= 3 characters <= 50 characters

picture

required

The picture of the agent.

string

nullable

planning

required

Whether the agent should plan before each execution.

boolean

prompt

required

The main description of the agent’s behavior.

string

>= 1 characters <= 10000 characters

reasoningMode

required

The reasoning mode to use for the agent. If null, reasoning will be disabled.

string

nullable

Allowed values: low medium high xhigh

role

required

The role of the agent. Particularly useful to give other agents context of what the agent does.

string

>= 1 characters <= 250 characters

superIdentityId

required

The super identity ID associated with the agent.

string format: uuid

temperature

required

The temperature to use for the agent. The lower the more deterministic. The higher the more creative.

number

<= 2

timezone

required

The timezone to use for the agent. If null, no timezone will be used.

string

nullable

toolCount

required

The number of tools currently associated with the agent.

integer

voiceId

required

The TTS voice to use for audio responses. Null when disabled for the agent.

string format: uuid

nullable

workspaceId

required

The workspace ID that owns the agent.

string format: uuid

components

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

Any of:

object

type

required

string

Allowed values: boolean

value

required

boolean

key

required

The unique key identifier for this component within the workspace.

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9_]+$/

workspaceId

required

The workspace that owns this component.

string format: uuid

mcps

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

connectionId

required

The id of the connection the MCP will be used through.

string format: uuid

nullable

description

required

The internal description of the MCP.

string

nullable >= 3 characters <= 250 characters

detail

required

One of:

object

object

tools

required

Array<string>

>= 1 items

type

required

string

name

required

The display name of the MCP.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the MCP.

string format: uuid

squadAgents

required

Array<object>

object

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

agentId

required

A UUID v4 string that identifies an entity.

string format: uuid

squadId

required

A UUID v4 string that identifies an entity.

string format: uuid

type

required

string

Allowed values: member main

squads

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the squad.

string

nullable >= 3 characters <= 250 characters

mode

required

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

string

Allowed values: hierarchical flat

name

required

The display name of the squad.

string

>= 3 characters <= 50 characters

picture

required

The picture associated with the squad.

string

nullable

superIdentityId

required

The super identity ID associated with the squad.

string format: uuid

workspaceId

required

The workspace ID that owns the squad.

string format: uuid

tasks

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

agentId

required

The agent ID associated with the task.

string format: uuid

condition

required

The condition that must be met for the task to be executed.

string

>= 3 characters <= 250 characters

name

required

The display name of the task.

string

>= 3 characters <= 50 characters

prompt

required

What will be set as the main object of the agent when the task is selected.

string

>= 3 characters <= 2000 characters

status

required

The lifecycle status of the task.

string

Allowed values: active inactive

tools

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

description

required

The internal description of the tool.

string

>= 3 characters <= 250 characters

detail

required

Any of:

object

allowedDomains

required

List of domains allowed in web search results.

Array<string>

effort

required

Web search effort level.

string

Allowed values: low medium high

execution

required

Whether the search should always be executed or only if the agent decides to do it.

string

Allowed values: eligible compulsory

llmProviderId

required

Optional OpenAI LLM provider ID to be used in this tool call.

string format: uuid

nullable

prompt

required

Prompt to be appended alongside queries to instruct the LLM call.

string

nullable <= 500 characters

type

required

string

Allowed values: agentic-web-search

name

required

The display name of the tool.

string

>= 3 characters <= 50 characters

workspaceId

required

The workspace ID that owns the tool.

string format: uuid

voices

required

Array<object>

object

createdAt

required

string format: date-time

required

A UUID v4 string that identifies an entity.

string format: uuid

isRemoved

required

boolean

referenceId

required

The ID of the original entity in production.

string format: uuid

nullable

updatedAt

required

string format: date-time

versionId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

The voice configuration details.

object

instructions

required

Voice instructions that guide the TTS model on tone, style, and delivery.

string

nullable >= 1 characters <= 1000 characters

model

required

The TTS model to use.

string

Allowed values: gpt-4o-mini-tts

name

required

The voice name to use for TTS.

string

Allowed values: ash ballad cedar coral echo fable marin nova onyx sage shimmer verse

speed

required

The speed of the voice. Must be a multiple of 0.25, between 0.25 and 4.0.

number

>= 0.25 <= 4

workspaceId

required

The workspace this voice belongs to.

string format: uuid

Example

{
  "added": {
    "agents": [
      {
        "llm": "claude-haiku-4-5",
        "reasoningMode": "low",
        "timezone": "Africa/Cairo"
      }
    ],
    "components": [
      {
        "detail": {
          "type": "boolean"
        }
      }
    ],
    "mcps": [
      {
        "detail": {
          "type": "composio-airtable"
        }
      }
    ],
    "squadAgents": [
      {
        "type": "member"
      }
    ],
    "squads": [
      {
        "mode": "hierarchical"
      }
    ],
    "tasks": [
      {
        "status": "active"
      }
    ],
    "tools": [
      {
        "detail": {
          "effort": "low",
          "execution": "eligible",
          "type": "agentic-web-search"
        }
      }
    ],
    "voices": [
      {
        "detail": {
          "model": "gpt-4o-mini-tts",
          "name": "ash"
        }
      }
    ]
  },
  "kept": {
    "agents": [
      {
        "llm": "claude-haiku-4-5",
        "reasoningMode": "low",
        "timezone": "Africa/Cairo"
      }
    ],
    "components": [
      {
        "detail": {
          "type": "boolean"
        }
      }
    ],
    "mcps": [
      {
        "detail": {
          "type": "composio-airtable"
        }
      }
    ],
    "squadAgents": [
      {
        "type": "member"
      }
    ],
    "squads": [
      {
        "mode": "hierarchical"
      }
    ],
    "tasks": [
      {
        "status": "active"
      }
    ],
    "tools": [
      {
        "detail": {
          "effort": "low",
          "execution": "eligible",
          "type": "agentic-web-search"
        }
      }
    ],
    "voices": [
      {
        "detail": {
          "model": "gpt-4o-mini-tts",
          "name": "ash"
        }
      }
    ]
  },
  "modified": {
    "agents": [
      {
        "source": {
          "llm": "claude-haiku-4-5",
          "reasoningMode": "low",
          "timezone": "Africa/Cairo"
        },
        "target": {
          "llm": "claude-haiku-4-5",
          "reasoningMode": "low",
          "timezone": "Africa/Cairo"
        }
      }
    ],
    "components": [
      {
        "source": {
          "detail": {
            "type": "boolean"
          }
        },
        "target": {
          "detail": {
            "type": "boolean"
          }
        }
      }
    ],
    "mcps": [
      {
        "source": {
          "detail": {
            "type": "composio-airtable"
          }
        },
        "target": {
          "detail": {
            "type": "composio-airtable"
          }
        }
      }
    ],
    "squadAgents": [
      {
        "source": {
          "type": "member"
        },
        "target": {
          "type": "member"
        }
      }
    ],
    "squads": [
      {
        "source": {
          "mode": "hierarchical"
        },
        "target": {
          "mode": "hierarchical"
        }
      }
    ],
    "tasks": [
      {
        "source": {
          "status": "active"
        },
        "target": {
          "status": "active"
        }
      }
    ],
    "tools": [
      {
        "source": {
          "detail": {
            "effort": "low",
            "execution": "eligible",
            "type": "agentic-web-search"
          }
        },
        "target": {
          "detail": {
            "effort": "low",
            "execution": "eligible",
            "type": "agentic-web-search"
          }
        }
      }
    ],
    "voices": [
      {
        "source": {
          "detail": {
            "model": "gpt-4o-mini-tts",
            "name": "ash"
          }
        },
        "target": {
          "detail": {
            "model": "gpt-4o-mini-tts",
            "name": "ash"
          }
        }
      }
    ]
  },
  "removed": {
    "agents": [
      {
        "llm": "claude-haiku-4-5",
        "reasoningMode": "low",
        "timezone": "Africa/Cairo"
      }
    ],
    "components": [
      {
        "detail": {
          "type": "boolean"
        }
      }
    ],
    "mcps": [
      {
        "detail": {
          "type": "composio-airtable"
        }
      }
    ],
    "squadAgents": [
      {
        "type": "member"
      }
    ],
    "squads": [
      {
        "mode": "hierarchical"
      }
    ],
    "tasks": [
      {
        "status": "active"
      }
    ],
    "tools": [
      {
        "detail": {
          "effort": "low",
          "execution": "eligible",
          "type": "agentic-web-search"
        }
      }
    ],
    "voices": [
      {
        "detail": {
          "model": "gpt-4o-mini-tts",
          "name": "ash"
        }
      }
    ]
  }
}

400

Bad Request.

application/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

401

Unauthorized.

application/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

404

One or more versions could not be found.

application/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}