Workers
Workers are containers that manage assistants and handle conversations across channels. They coordinate between assistants and channels, routing messages appropriately.List Workers
GET /workers
Returns a list of all workers in your workspace.
Query Parameters
number
Page number for pagination
number
Number of items per page
Create Worker
POST /workers
Creates a new worker and associates it with a workspace.
Request Body
string
required
Worker name
string
Worker description
string
Worker timezone (e.g., “America/Sao_Paulo”)
Response
Success message
Get Worker
GET /workers/:worker_id
Returns detailed information about a specific worker.
Worker unique identifier
Delete Worker
DELETE /workers/:worker_id
Removes a worker from a workspace.
Worker unique identifier
Create Assistant for Worker
POST /workers/:worker_id/assistants
Creates a new assistant and associates it with a specific worker.
Worker unique identifier
Request Body
string
required
Assistant name
string
required
System instructions for the assistant
string
AI model to use
string
AI provider (e.g., “OPENAI”)
array
List of supported language codes
How Workers Work
- Workers contain one or more assistants
- Assistants are connected to channels via workers
- Messages are routed to the appropriate assistant based on channel configuration
- Workers can be assigned to multiple channels