v1

latestOpenAPI 3.0.02026-08-063524105.9 KB

Agents

Create agent

Create a new agent within a workspace. Requires workspaceId and name. Optional fields include prompt, voiceConfig, widgetConfig, and language.

post/v1/agents

Request body

workspaceIdstring uuid required

Workspace ID to create agent in (required)

namestring required

Agent name (required)

promptstring

System prompt for the agent

voiceConfigobject

Voice configuration settings (JSON)

widgetConfigobject

Widget appearance settings (JSON)

languagestring

Agent language code

Example request

{
  "workspaceId": "789e4567-e89b-12d3-a456-426614174000",
  "name": "My New Agent",
  "prompt": "You are a helpful assistant for our e-commerce platform.",
  "voiceConfig": {
    "provider": "elevenlabs",
    "voiceId": "voice_456"
  },
  "widgetConfig": {
    "theme": "dark"
  },
  "language": "en"
}

Response

Agent created successfully

idstring uuid required

Unique agent identifier

workspaceIdstring uuid required

Workspace ID that owns this agent

namestring required

Agent name

promptstring nullable required

System prompt for the agent

voiceConfigobject nullable required

Voice configuration settings (JSON)

widgetConfigobject nullable required

Widget appearance settings (JSON)

languagestring nullable required

Agent language code

createdAtstring date-time required

Agent creation timestamp

updatedAtstring date-time required

Agent last update timestamp

deletedAtstring date-time nullable required

Soft delete timestamp (null if active)

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "789e4567-e89b-12d3-a456-426614174000",
  "name": "Customer Support Agent",
  "prompt": "You are a helpful customer support assistant...",
  "voiceConfig": {
    "provider": "elevenlabs",
    "voiceId": "voice_123"
  },
  "widgetConfig": {
    "primaryColor": "#007bff",
    "position": "bottom-right"
  },
  "language": "en",
  "createdAt": "2025-12-11T12:00:00Z",
  "updatedAt": "2025-12-11T12:00:00Z"
}