API Reference

Agents API

Create, configure, and manage AI agents programmatically.

Endpoints

GET/v1/agents

List all agents

POST/v1/agents

Create a new agent

GET/v1/agents/:id

Get agent details

PATCH/v1/agents/:id

Update an agent

DELETE/v1/agents/:id

Delete an agent

Create Agent

POST/v1/agents
{
  "name": "Support Agent",
  "description": "Handles customer support queries",
  "welcome_message": "Hi! How can I help you today?",
  "personality": {
    "tone": "friendly",
    "language": "en",
    "formality": "casual"
  },
  "settings": {
    "memory_enabled": true,
    "handoff_enabled": true,
    "auto_resolve": true
  }
}

Response

{
  "id": "agent_abc123",
  "name": "Support Agent",
  "description": "Handles customer support queries",
  "status": "active",
  "created_at": "2026-01-12T10:00:00Z",
  "updated_at": "2026-01-12T10:00:00Z",
  "stats": {
    "conversations_total": 0,
    "conversations_active": 0,
    "avg_response_time_ms": 0
  }
}

Agent Object

  • id string - Unique identifier
  • name string - Display name
  • description string - Internal description
  • status string - active, paused, or disabled
  • welcome_message string - First message to customers
  • personality object - Tone and language settings
  • settings object - Agent configuration
  • stats object - Performance metrics

Related

Conversations API
Messages API