Versions

get

Checks if version creation balance is available.

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses

200

Version creation balance checked successfully.

application/json

availableAtstring · date-time · nullableRequired

canCreatebooleanRequired

remainingBalanceintegerRequired

401

Unauthorized.

application/json

get

/api/v1/versions/check-creation-balance

HTTPcURLJavaScriptPython

GET /api/v1/versions/check-creation-balance HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "availableAt": "2026-06-11T23:10:05.419Z",
  "canCreate": true,
  "remainingBalance": 1
}

post

Deploys the current draft version.

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses

200

The draft version was deployed.

application/json

messagestringRequired

An informative message for a call that has no effective result to be returned.

401

Unauthorized.

application/json

post

/api/v1/versions/deploy

HTTPcURLJavaScriptPython

POST /api/v1/versions/deploy HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "message": "text"
}

get

Retrieves differences between source and target versions.

Query parameters

sourceIdstring · uuidRequired

A UUID v4 string that identifies an entity.

targetIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses

200

Version differences retrieved successfully.

application/json

400

Bad Request.

application/json

401

Unauthorized.

application/json

404

One or more versions could not be found.

application/json

get

/api/v1/versions/diff

HTTPcURLJavaScriptPython

GET /api/v1/versions/diff?sourceId=123e4567-e89b-12d3-a456-426614174000&targetId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "added": {
    "agentMcps": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "mcpId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "agentTools": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "toolId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "agents": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "codeRuntime": true,
        "internalName": "text",
        "iterations": 1,
        "llm": "claude-haiku-4-5",
        "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "picture": "text",
        "planning": true,
        "prompt": "text",
        "reasoningMode": "low",
        "role": "text",
        "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
        "temperature": 1,
        "timezone": "Africa/Cairo",
        "toolCount": 1,
        "voiceId": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "components": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "detail": {
          "type": "boolean",
          "value": true
        },
        "key": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "mcps": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "connectionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "detail": {
          "tools": [
            "text"
          ],
          "type": "composio-airtable"
        },
        "name": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "squadAgents": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "squadId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "member"
      }
    ],
    "squads": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "mode": "hierarchical",
        "name": "text",
        "picture": "text",
        "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "tasks": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "condition": "text",
        "name": "text",
        "prompt": "text",
        "status": "active"
      }
    ],
    "tools": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "detail": {
          "allowedDomains": [
            "text"
          ],
          "effort": "low",
          "execution": "eligible",
          "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
          "prompt": "text",
          "type": "agentic-web-search"
        },
        "name": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "voices": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "detail": {
          "instructions": "text",
          "model": "gpt-4o-mini-tts",
          "name": "ash",
          "speed": 1
        },
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "kept": {
    "agentMcps": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "mcpId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "agentTools": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "toolId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "agents": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "codeRuntime": true,
        "internalName": "text",
        "iterations": 1,
        "llm": "claude-haiku-4-5",
        "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "picture": "text",
        "planning": true,
        "prompt": "text",
        "reasoningMode": "low",
        "role": "text",
        "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
        "temperature": 1,
        "timezone": "Africa/Cairo",
        "toolCount": 1,
        "voiceId": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "components": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "detail": {
          "type": "boolean",
          "value": true
        },
        "key": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "mcps": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "connectionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "detail": {
          "tools": [
            "text"
          ],
          "type": "composio-airtable"
        },
        "name": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "squadAgents": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "squadId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "member"
      }
    ],
    "squads": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "mode": "hierarchical",
        "name": "text",
        "picture": "text",
        "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "tasks": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "condition": "text",
        "name": "text",
        "prompt": "text",
        "status": "active"
      }
    ],
    "tools": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "detail": {
          "allowedDomains": [
            "text"
          ],
          "effort": "low",
          "execution": "eligible",
          "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
          "prompt": "text",
          "type": "agentic-web-search"
        },
        "name": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "voices": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "detail": {
          "instructions": "text",
          "model": "gpt-4o-mini-tts",
          "name": "ash",
          "speed": 1
        },
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "removed": {
    "agentMcps": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "mcpId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "agentTools": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "toolId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "agents": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "codeRuntime": true,
        "internalName": "text",
        "iterations": 1,
        "llm": "claude-haiku-4-5",
        "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "picture": "text",
        "planning": true,
        "prompt": "text",
        "reasoningMode": "low",
        "role": "text",
        "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
        "temperature": 1,
        "timezone": "Africa/Cairo",
        "toolCount": 1,
        "voiceId": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "components": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "detail": {
          "type": "boolean",
          "value": true
        },
        "key": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "mcps": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "connectionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "detail": {
          "tools": [
            "text"
          ],
          "type": "composio-airtable"
        },
        "name": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "squadAgents": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "squadId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "member"
      }
    ],
    "squads": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "mode": "hierarchical",
        "name": "text",
        "picture": "text",
        "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "tasks": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "condition": "text",
        "name": "text",
        "prompt": "text",
        "status": "active"
      }
    ],
    "tools": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "detail": {
          "allowedDomains": [
            "text"
          ],
          "effort": "low",
          "execution": "eligible",
          "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
          "prompt": "text",
          "type": "agentic-web-search"
        },
        "name": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "voices": [
      {
        "createdAt": "2026-06-11T23:10:05.419Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T23:10:05.419Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "detail": {
          "instructions": "text",
          "model": "gpt-4o-mini-tts",
          "name": "ash",
          "speed": 1
        },
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}

get

Retrieves multiple versions.

Query parameters

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses

200

Retrieves all versions for the workspace scope.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

brandIdstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

numbernumberRequired

The version number. -1 indicates a draft version and 0 indicates the production version. Higher numbers are snapshots created during deploys.

referenceIdstring · uuid · nullableRequired

The ID of version that this version is based on.

workspaceIdstring · uuidRequired

A UUID v4 string that identifies an entity.

401

Unauthorized.

application/json

get

/api/v1/versions

HTTPcURLJavaScriptPython

GET /api/v1/versions HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "createdAt": "2026-06-11T23:10:05.419Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2026-06-11T23:10:05.419Z",
    "brandId": "123e4567-e89b-12d3-a456-426614174000",
    "number": 1,
    "referenceId": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

post

Rolls back the current draft version to a specific version.

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body

application/json

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Responses

200

The draft version was rolled back.

application/json

messagestringRequired

An informative message for a call that has no effective result to be returned.

401

Unauthorized.

application/json

404

The target version could not be found.

application/json

412

The target version is invalid for rollback.

application/json

post

/api/v1/versions/rollback

HTTPcURLJavaScriptPython

POST /api/v1/versions/rollback HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "message": "text"
}