Tools

get

Retrieves multiple tools.

Query parameters

agentIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

joinsany ofOptionalDefault: []

or

string · enumOptionalPossible values:

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

searchstring · min: 1Optional

Search term to filter tools by name or description.

versionIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

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

Retrieves all tools for the workspace.

application/json

or

401

Unauthorized.

application/json

get

/api/v1/tools

HTTPcURLJavaScriptPython

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

[
  {
    "createdAt": "2026-06-11T21:53:27.150Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isRemoved": true,
    "referenceId": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2026-06-11T21:53:27.150Z",
    "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",
    "agentTools": [
      {
        "createdAt": "2026-06-11T21:53:27.150Z",
        "updatedAt": "2026-06-11T21:53:27.150Z",
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "toolId": "123e4567-e89b-12d3-a456-426614174000",
        "agent": {
          "createdAt": "2026-06-11T21:53:27.150Z",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "isRemoved": true,
          "referenceId": "123e4567-e89b-12d3-a456-426614174000",
          "updatedAt": "2026-06-11T21:53:27.150Z",
          "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"
        }
      }
    ]
  }
]

post

Creates a new tool.

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

descriptionstring · min: 3 · max: 250Required

The internal description of the tool.

detailany ofRequired

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

namestring · min: 3 · max: 50Required

The display name of the tool.

Responses

200

The tool was created.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired

versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

descriptionstring · min: 3 · max: 250Required

The internal description of the tool.

detailany ofRequired

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

namestring · min: 3 · max: 50Required

The display name of the tool.

workspaceIdstring · uuidRequired

The workspace ID that owns the tool.

400

Invalid tool configuration.

application/json

401

Unauthorized.

application/json

post

/api/v1/tools

HTTPcURLJavaScriptPython

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

{
  "description": "text",
  "detail": {
    "allowedDomains": [
      "text"
    ],
    "effort": "low",
    "execution": "eligible",
    "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
    "prompt": "text",
    "type": "agentic-web-search"
  },
  "name": "text"
}

{
  "createdAt": "2026-06-11T21:53:27.150Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "referenceId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T21:53:27.150Z",
  "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"
}

get

Retrieves a tool.

Path parameters

idstring · 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

Retrieves a tool.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired

versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

descriptionstring · min: 3 · max: 250Required

The internal description of the tool.

detailany ofRequired

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

namestring · min: 3 · max: 50Required

The display name of the tool.

workspaceIdstring · uuidRequired

The workspace ID that owns the tool.

401

Unauthorized.

application/json

404

Tool not found.

application/json

get

/api/v1/tools/{id}

HTTPcURLJavaScriptPython

GET /api/v1/tools/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "createdAt": "2026-06-11T21:53:27.150Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "referenceId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T21:53:27.150Z",
  "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"
}

delete

Removes a tool.

Path parameters

idstring · 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

The tool was removed.

application/json

messagestringRequired

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

401

Unauthorized.

application/json

404

Tool not found.

application/json

delete

/api/v1/tools/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/tools/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "message": "text"
}