v1

latestOpenAPI 3.0.02026-08-063524105.9 KB

Agents

Get agent by ID

Retrieves a specific agent by its UUID. Returns the agent even if soft-deleted (deletedAt will be populated).

get/v1/agents/{id}

Path parameters

idstring uuid required

Agent UUID

Example:123e4567-e89b-12d3-a456-426614174000

Response

Agent retrieved 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"
}