Endpoints at a Glance
Voice Agents
| Method | Path | Description |
|---|
| GET | /workflow/fetch | List agents |
| GET | /workflow/fetch/{id} | Get agent |
| POST | /workflow/create/definition | Create from definition |
| POST | /workflow/create/template | Create from template |
| POST | /workflow/{id}/validate | Validate |
| POST | /workflow/{id}/publish | Publish draft |
| PUT | /workflow/{id}/status | Archive/activate |
| PUT | /workflow/{id}/folder | Move to folder |
| POST | /workflow/{id}/duplicate | Duplicate |
| GET | /workflow/{id}/report | Download report |
Calls & Runs
| Method | Path | Description |
|---|
| POST | /public/agent/{uuid} | Trigger call (trigger UUID) |
| POST | /public/agent/workflow/{workflow_uuid} | Trigger call (workflow UUID) |
| POST | /public/agent/test/{uuid} | Trigger test call |
| GET | /workflow/{id}/runs | List runs |
| GET | /workflow/{id}/runs/{run_id} | Get run detail |
| GET | /public/download/workflow/{token}/{type} | Download transcript/recording |
Campaigns
| Method | Path | Description |
|---|
| GET | /campaign/ | List |
| POST | /campaign/create | Create |
| POST | /campaign/{id}/start | Start |
| POST | /campaign/{id}/pause | Pause |
| POST | /campaign/{id}/resume | Resume |
| POST | /campaign/{id}/redial | Redial |
| GET | /campaign/{id}/progress | Progress |
| GET | /campaign/{id}/report | Report |
Knowledge Base
| Method | Path | Description |
|---|
| GET | /knowledge-base/ | List |
| POST | /knowledge-base/ | Upload |
| DELETE | /knowledge-base/{id} | Archive |
| POST | /knowledge-base/{id}/unarchive | Restore |
Tools & Credentials
| Method | Path | Description |
|---|
| GET | /tools/ | List tools |
| POST | /tools/ | Create tool |
| POST | /tools/{uuid}/mcp/refresh | Refresh MCP |
| GET | /credentials/ | List credentials |
| POST | /credentials/ | Create credential |
Organisation
| Method | Path | Description |
|---|
| GET | /organizations/api-keys | List API keys |
| POST | /organizations/api-keys | Create API key |
| DELETE | /organizations/api-keys/{id} | Archive API key |
| PUT | /organizations/api-keys/{id}/reactivate | Reactivate API key |
| POST | /organizations/langfuse-credentials | Langfuse config |
| PUT | /organizations/model-configurations/v2 | Model config |
| GET | /organizations/telephony-configs | Telephony configs |
| POST | /organizations/telephony-configs/{id}/set-default-outbound | Set default outbound |
| PUT | /organizations/preferences | Org preferences |
| GET | /organizations/usage/current-period | Current usage |
User
| Method | Path | Description |
|---|
| GET | /user/auth/user | Get current user |
| GET | /user/configurations/user | Get user config |
| GET | /user/configurations/voices/{provider} | Search voices |
MCP Tools Quick Reference
| Tool | What it does |
|---|
list_workflows | List all agents |
get_workflow_code | Get editable TypeScript source |
create_workflow | Create a new published agent |
save_workflow | Save changes as a draft |
list_node_types | List available node types |
get_node_type | Get field spec for one node type |
list_tools | List tool integrations |
list_documents | List KB documents |
list_credentials | List credentials (no secrets) |
list_recordings | List call recordings |
search_docs | Search platform documentation |
read_doc | Read a documentation page |
list_docs | Browse documentation tree |
Auth Header
E.164 Phone Number Examples
+14155552671 US
+447911123456 UK
+61291234567 AU
+4930123456 DE
+33123456789 FR
Run Status
pending → in_progress → completed or failed
Campaign Status
draft → running ↔ paused → completed (or failed)
Key Links