Sign in

v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
Channels

Retrieves multiple channels.

get/api/v1/channels

Query parameters

pageNumbernumber

The page number.

The page number.

pageSizenumber

The page size.

The page size.

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

searchstring

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

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

Headers

authorizationstring required

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

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

Response

Retrieves all channels for the workspace.

createdAtstring date-time required
idstring uuid required

A UUID v4 string that identifies an entity.

isRemovedboolean required
updatedAtstring date-time required
delayinteger required

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

descriptionstring nullable required

The internal description of the channel.

maxAssistantMessagesPerChatOwnerinteger nullable required
namestring required

The display name of the channel.

promptstring nullable required

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

responderIdstring uuid nullable required

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

showSenderNameboolean required

Whether to display sender names in chat messages.

status'active' | 'inactive' required

The lifecycle status of the channel.

useVoice'on-audio/without-transcription' | 'on-audio/with-transcription' | 'always/without-transcription' | 'always/with-transcription' | 'never' required

The voice behavior mode configured for the channel.

workspaceIdstring uuid required

The workspace ID that owns the channel.