Channels

get

Retrieves multiple channels.

Query parameters

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

responderIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

searchstring · min: 1Optional

Search term to filter channels by name, description, or prompt.

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 channels for the workspace.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

delayinteger · min: 1 · max: 60Required

The delay between the last user message and the beginning of the response generation.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the channel.

detailany ofRequired

or

or

or

or

or

maxAssistantMessagesPerChatOwnerinteger · nullableRequired

namestring · min: 3 · max: 50Required

The display name of the channel.

promptstring · min: 3 · max: 500 · nullableRequired

A prompt to be passed down to the agent in the context of this channel.

responderIdstring · uuid · nullableRequired

The super identity of the responder (agents or squads) of the channel

showSenderNamebooleanRequired

Whether to display sender names in chat messages.

statusstring · enumRequired

The lifecycle status of the channel.

Possible values:

useVoicestring · enumRequired

The voice behavior mode configured for the channel.

Possible values:

workspaceIdstring · uuidRequired

The workspace ID that owns the channel.

400

Bad Request.

application/json

401

Unauthorized.

application/json

get/api/v1/channels

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

[
  {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isRemoved": true,
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "delay": 1,
    "description": "text",
    "detail": {
      "initialMessage": "text",
      "responseWebhookUrl": "https://example.com",
      "type": "api"
    },
    "maxAssistantMessagesPerChatOwner": 1,
    "name": "text",
    "prompt": "text",
    "responderId": "123e4567-e89b-12d3-a456-426614174000",
    "showSenderName": true,
    "status": "active",
    "useVoice": "on-audio/without-transcription",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

post

Creates a new channel.

Header parameters

authorizationstringRequired

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

Body

delayinteger · min: 1 · max: 60Required

The delay between the last user message and the beginning of the response generation.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the channel.

detailany ofRequired

or

or

or

or

or

maxAssistantMessagesPerChatOwnerinteger · nullableRequired

namestring · min: 3 · max: 50Required

The display name of the channel.

promptstring · min: 3 · max: 500 · nullableRequired

A prompt to be passed down to the agent in the context of this channel.

responderIdstring · uuid · nullableRequired

The super identity of the responder (agents or squads) of the channel

showSenderNamebooleanRequired

Whether to display sender names in chat messages.

statusstring · enumRequired

The lifecycle status of the channel.

Possible values:

useVoicestring · enumRequired

The voice behavior mode configured for the channel.

Possible values:

Responses

200

The channel was created.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

delayinteger · min: 1 · max: 60Required

The delay between the last user message and the beginning of the response generation.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the channel.

detailany ofRequired

or

or

or

or

or

maxAssistantMessagesPerChatOwnerinteger · nullableRequired

namestring · min: 3 · max: 50Required

The display name of the channel.

promptstring · min: 3 · max: 500 · nullableRequired

A prompt to be passed down to the agent in the context of this channel.

responderIdstring · uuid · nullableRequired

The super identity of the responder (agents or squads) of the channel

showSenderNamebooleanRequired

Whether to display sender names in chat messages.

statusstring · enumRequired

The lifecycle status of the channel.

Possible values:

useVoicestring · enumRequired

The voice behavior mode configured for the channel.

Possible values:

workspaceIdstring · uuidRequired

The workspace ID that owns the channel.

400

Invalid channel configuration.

application/json

401

Unauthorized.

application/json

403

Plan limit exceeded.

application/json

404

Resource not found.

application/json

409

A channel for this connection already exists.

application/json

post/api/v1/channels

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

{
  "delay": 1,
  "description": "text",
  "detail": {
    "initialMessage": "text",
    "responseWebhookUrl": "https://example.com",
    "type": "api"
  },
  "maxAssistantMessagesPerChatOwner": 1,
  "name": "text",
  "prompt": "text",
  "responderId": "123e4567-e89b-12d3-a456-426614174000",
  "showSenderName": true,
  "status": "active",
  "useVoice": "on-audio/without-transcription"
}

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "delay": 1,
  "description": "text",
  "detail": {
    "initialMessage": "text",
    "responseWebhookUrl": "https://example.com",
    "type": "api"
  },
  "maxAssistantMessagesPerChatOwner": 1,
  "name": "text",
  "prompt": "text",
  "responderId": "123e4567-e89b-12d3-a456-426614174000",
  "showSenderName": true,
  "status": "active",
  "useVoice": "on-audio/without-transcription",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

get

Retrieves a channel.

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 channel.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

delayinteger · min: 1 · max: 60Required

The delay between the last user message and the beginning of the response generation.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the channel.

detailany ofRequired

or

or

or

or

or

maxAssistantMessagesPerChatOwnerinteger · nullableRequired

namestring · min: 3 · max: 50Required

The display name of the channel.

promptstring · min: 3 · max: 500 · nullableRequired

A prompt to be passed down to the agent in the context of this channel.

responderIdstring · uuid · nullableRequired

The super identity of the responder (agents or squads) of the channel

showSenderNamebooleanRequired

Whether to display sender names in chat messages.

statusstring · enumRequired

The lifecycle status of the channel.

Possible values:

useVoicestring · enumRequired

The voice behavior mode configured for the channel.

Possible values:

workspaceIdstring · uuidRequired

The workspace ID that owns the channel.

401

Unauthorized.

application/json

404

Channel not found.

application/json

get/api/v1/channels/{id}

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

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "delay": 1,
  "description": "text",
  "detail": {
    "initialMessage": "text",
    "responseWebhookUrl": "https://example.com",
    "type": "api"
  },
  "maxAssistantMessagesPerChatOwner": 1,
  "name": "text",
  "prompt": "text",
  "responderId": "123e4567-e89b-12d3-a456-426614174000",
  "showSenderName": true,
  "status": "active",
  "useVoice": "on-audio/without-transcription",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Removes a channel.

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 channel was removed.

application/json

messagestringRequired

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

401

Unauthorized.

application/json

404

Channel not found.

application/json

delete/api/v1/channels/{id}

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

{
  "message": "text"
}

patch

Updates a channel.

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.

Body

delayinteger · min: 1 · max: 60Optional

The delay between the last user message and the beginning of the response generation.

descriptionstring · min: 3 · max: 250 · nullableOptional

The internal description of the channel.

detailany ofOptional

or

or

or

or

or

maxAssistantMessagesPerChatOwnerinteger · nullableOptional

namestring · min: 3 · max: 50Optional

The display name of the channel.

promptstring · min: 3 · max: 500 · nullableOptional

A prompt to be passed down to the agent in the context of this channel.

responderIdstring · uuid · nullableOptional

The super identity of the responder (agents or squads) of the channel

showSenderNamebooleanOptional

Whether to display sender names in chat messages.

statusstring · enumOptional

The lifecycle status of the channel.

Possible values:

useVoicestring · enumOptional

The voice behavior mode configured for the channel.

Possible values:

Responses

200

The channel was updated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

delayinteger · min: 1 · max: 60Required

The delay between the last user message and the beginning of the response generation.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the channel.

detailany ofRequired

or

or

or

or

or

maxAssistantMessagesPerChatOwnerinteger · nullableRequired

namestring · min: 3 · max: 50Required

The display name of the channel.

promptstring · min: 3 · max: 500 · nullableRequired

A prompt to be passed down to the agent in the context of this channel.

responderIdstring · uuid · nullableRequired

The super identity of the responder (agents or squads) of the channel

showSenderNamebooleanRequired

Whether to display sender names in chat messages.

statusstring · enumRequired

The lifecycle status of the channel.

Possible values:

useVoicestring · enumRequired

The voice behavior mode configured for the channel.

Possible values:

workspaceIdstring · uuidRequired

The workspace ID that owns the channel.

400

Invalid data provided.

application/json

401

Unauthorized.

application/json

404

Channel not found.

application/json

patch/api/v1/channels/{id}

PATCH /api/v1/channels/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 327

{
  "delay": 1,
  "description": "text",
  "detail": {
    "initialMessage": "text",
    "responseWebhookUrl": "https://example.com",
    "type": "api"
  },
  "maxAssistantMessagesPerChatOwner": 1,
  "name": "text",
  "prompt": "text",
  "responderId": "123e4567-e89b-12d3-a456-426614174000",
  "showSenderName": true,
  "status": "active",
  "useVoice": "on-audio/without-transcription"
}

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "delay": 1,
  "description": "text",
  "detail": {
    "initialMessage": "text",
    "responseWebhookUrl": "https://example.com",
    "type": "api"
  },
  "maxAssistantMessagesPerChatOwner": 1,
  "name": "text",
  "prompt": "text",
  "responderId": "123e4567-e89b-12d3-a456-426614174000",
  "showSenderName": true,
  "status": "active",
  "useVoice": "on-audio/without-transcription",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}