Developers

API Reference

Full REST API for agents, calls, campaigns, and analytics. Authenticate with your workspace API key.


Base URL and auth

bash
https://api.katexs.com/v1

Authorization: Bearer <KATEXS_API_KEY>

Endpoints

MethodPathDescription
GET/agentsList agents
POST/agentsCreate an agent
PATCH/agents/:idUpdate agent configuration
POST/agents/:id/deploySet an agent live
GET/callsList calls with filters
GET/calls/:idFetch a transcript and outcome
POST/campaignsCreate a campaign
POST/campaigns/:id/launchLaunch a campaign

Create an agent

bash
curl -X POST https://api.katexs.com/v1/agents \
  -H "Authorization: Bearer $KATEXS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Front Desk",
    "type": "voice",
    "voice_id": "elevenlabs:rachel",
    "prompt": "You are the receptionist for Bright Dental...",
    "tools": ["check_calendar", "book_appointment"]
  }'

Errors and limits

StatusMeaning
400Validation error โ€” see the details array
401Missing or invalid API key
429Rate limited โ€” 120 requests per minute
5xxRetry with exponential backoff