OpenAPI Specification
Full OpenAPI 3.0 spec for all API routes
OpenAPI Specification
Download the full OpenAPI spec for use with Postman, Insomnia, or any API client:
- JSON:
/openapi.json
Quick Import
Postman
- Open Postman → Import → Link
- Enter:
http://localhost:3000/openapi.json - All routes will be imported with schemas
Insomnia
- Open Insomnia → Import → From URL
- Enter:
http://localhost:3000/openapi.json
cURL (all routes)
# Message Event
curl -X POST http://localhost:3000/api/v1/message-event \
-H "Content-Type: application/json" \
-d '{"locationId":"loc_123","messageType":"SMS","body":"test"}'
# Agent Run
curl -X POST http://localhost:3000/api/v1/agent-run \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_KEY" \
-d '{"conversation_id":"conv_123","assistant_id":"asst_456"}'
# System Variables
curl -X POST http://localhost:3000/api/v1/system-variables \
-H "Content-Type: application/json" \
-d '{"assistant_id":"asst_123","location_id":"loc_456","contact_id":"c_789","direction":"inbound","to":"+15559876543","from":"+15551234567","channel":"Voice"}'
# Make Call
curl -X POST http://localhost:3000/api/v1/make-call \
-H "Content-Type: application/json" \
-d '{"location_id":"loc_123","assistant_id":"asst_456","phone_number":"+15559876543"}'
# Inbound Call
curl -X POST http://localhost:3000/api/v1/inbound-call \
-H "Content-Type: application/json" \
-d '{"to_number":"+15559876543","from_number":"+15551234567","llm_id":"asst_123"}'
# Voice Webhook
curl -X POST http://localhost:3000/api/v1/voice-webhook \
-H "Content-Type: application/json" \
-d '{"call_id":"call_001","event":"call_initiated","direction":"outbound"}'
# Tool Proxy
curl -X POST http://localhost:3000/api/v1/tool-proxy \
-H "Content-Type: application/json" \
-d '{"tool_id":"tool_123","body":{"query":"test"}}'