API Reference

The SIMBA REST API lets you create agents, launch conversations, and manage voices and tools programmatically. All endpoints are versioned under /v1.

Base URL

https://api.simbavoice.ai

Authentication

Authenticate every request with your API key in the Authorization header. Create keys in the developers dashboard.

curl https://api.simbavoice.ai/v1/agents \
  -H "Authorization: Bearer sk-simba-..." \
  -H "Content-Type: application/json"

Create your first agent

curl -X POST https://api.simbavoice.ai/v1/agents \
  -H "Authorization: Bearer sk-simba-..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support agent",
    "conversation_config": {
      "agent": {
        "prompt": { "prompt": "You are a helpful support agent." },
        "first_message": "Hi, how can I help?"
      },
      "tts": { "voice_id": "simba-natural-en-1" }
    }
  }'

Endpoints

Agents

POST/v1/agentsCreate a new agent with prompt, voice, and tools.

GET/v1/agentsList all agents in your workspace.

GET/v1/agents/{agent_id}Retrieve a single agent by ID.

PATCH/v1/agents/{agent_id}Update prompt, voice, tools, or knowledge base.

DELETE/v1/agents/{agent_id}Permanently delete an agent.

Conversations

POST/v1/conversationsStart an outbound conversation.

GET/v1/conversationsList conversations with filters for agent, date, status.

GET/v1/conversations/{id}Retrieve a conversation with transcript and analytics.

GET/v1/conversations/{id}/audioDownload the conversation recording.

Voices

GET/v1/voicesList all available voices, including custom clones.

POST/v1/voicesCreate a new voice from audio samples.

GET/v1/voices/{voice_id}Retrieve voice metadata.

Tools

POST/v1/toolsRegister a webhook tool an agent can call.

GET/v1/toolsList tools in your workspace.

Webhooks

POST/v1/webhooksRegister a webhook endpoint for conversation events.

GET/v1/webhooksList webhook endpoints.

DELETE/v1/webhooks/{id}Remove a webhook endpoint.

Rate limits

Default limits are 600 requests per minute per workspace. Contact sales for higher limits on enterprise workloads.

Errors

The API uses standard HTTP status codes. Errors return a JSON body with error.code, error.message, and error.type.