API catalog

This catalog covers 173 application operations in the checked-in schema. The specialized guides explain multi-step workflows; each endpoint page supplies its request and response contract. Provider callbacks, superuser administration, and local authentication routes remain in the full OpenAPI file and are not promoted as application APIs here.

Agents and runs#

• Validate Workflow — POST /api/v1/workflow/{workflow_id}/validate
• Create Workflow — POST /api/v1/workflow/create/definition
• Create Workflow From Template — POST /api/v1/workflow/create/template
• Get Workflow Count — GET /api/v1/workflow/count
• Get Workflows — GET /api/v1/workflow/fetch
• Get Workflow — GET /api/v1/workflow/fetch/{workflow_id}
• Get Agent Setup — GET /api/v1/workflow/{workflow_id}/agent-setup
• Preview Agent — POST /api/v1/workflow/{workflow_id}/agent-preview
• Get Workflow Versions — GET /api/v1/workflow/{workflow_id}/versions
• Publish Workflow — POST /api/v1/workflow/{workflow_id}/publish
• Create Workflow Draft — POST /api/v1/workflow/{workflow_id}/create-draft
• Get Workflows Summary — GET /api/v1/workflow/summary
• Update Workflow Status — PUT /api/v1/workflow/{workflow_id}/status
• Move Workflow To Folder — PUT /api/v1/workflow/{workflow_id}/folder
• Update Workflow — PUT /api/v1/workflow/{workflow_id}
• Duplicate Workflow Endpoint — POST /api/v1/workflow/{workflow_id}/duplicate
• Create Workflow Run — POST /api/v1/workflow/{workflow_id}/runs
• Get Workflow Runs — GET /api/v1/workflow/{workflow_id}/runs
• Get Workflow Run — GET /api/v1/workflow/{workflow_id}/runs/{run_id}
• Download Workflow Report — GET /api/v1/workflow/{workflow_id}/report
• Get Workflow Templates — GET /api/v1/workflow/templates
• Duplicate Workflow Template — POST /api/v1/workflow/templates/duplicate
• Get a presigned URL to upload a custom ambient noise audio file — POST /api/v1/workflow/ambient-noise/upload-url
• Get Pilot Review — GET /api/v1/workflow/{workflow_id}/pilot-review

API keys#

• Get Api Keys — GET /api/v1/user/api-keys
• Create Api Key — POST /api/v1/user/api-keys
• Archive Api Key — DELETE /api/v1/user/api-keys/{api_key_id}
• Reactivate Api Key — PUT /api/v1/user/api-keys/{api_key_id}/reactivate

Billing and usage#

• Get Subscription Status — GET /api/v1/organizations/billing/subscription
• Create Subscription Checkout — POST /api/v1/organizations/billing/subscription/checkout
• Create Subscription Portal — POST /api/v1/organizations/billing/subscription/portal
• Get Current Period Usage — GET /api/v1/organizations/usage/current-period
• Get Billing Credits — GET /api/v1/organizations/billing/credits
• Create Mps Credit Purchase Url — POST /api/v1/organizations/usage/mps-credits/purchase-url
• Get Usage History — GET /api/v1/organizations/usage/runs
• Download Usage Runs Report — GET /api/v1/organizations/usage/runs/report
• Get Daily Usage Breakdown — GET /api/v1/organizations/usage/daily-breakdown

Campaigns#

• Create Campaign — POST /api/v1/campaign/create
• Get Campaigns — GET /api/v1/campaign/
• Get Campaign — GET /api/v1/campaign/{campaign_id}
• Update Campaign — PATCH /api/v1/campaign/{campaign_id}
• Start Campaign — POST /api/v1/campaign/{campaign_id}/start
• Pause Campaign — POST /api/v1/campaign/{campaign_id}/pause
• Get Campaign Runs — GET /api/v1/campaign/{campaign_id}/runs
• Redial Campaign — POST /api/v1/campaign/{campaign_id}/redial
• Resume Campaign — POST /api/v1/campaign/{campaign_id}/resume
• Get Campaign Progress — GET /api/v1/campaign/{campaign_id}/progress
• Get Campaign Source Download Url — GET /api/v1/campaign/{campaign_id}/source-download-url
• Download Campaign Report — GET /api/v1/campaign/{campaign_id}/report

Credentials#

• List Credentials — GET /api/v1/credentials/
• Create Credential — POST /api/v1/credentials/
• Get Credential — GET /api/v1/credentials/{credential_uuid}
• Update Credential — PUT /api/v1/credentials/{credential_uuid}
• Delete Credential — DELETE /api/v1/credentials/{credential_uuid}

Documentation assistant#

• Docs Chat — POST /api/v1/docs/chat

Folders#

• List Folders — GET /api/v1/folder/
• Create Folder — POST /api/v1/folder/
• Rename Folder — PUT /api/v1/folder/{folder_id}
• Delete Folder — DELETE /api/v1/folder/{folder_id}

Health#

• Health — GET /api/v1/health
• Active Calls — GET /api/v1/health/active-calls
• Autoscale Metric — GET /api/v1/health/autoscale-metric

Knowledge base#

• Get presigned URL for document upload — POST /api/v1/knowledge-base/upload-url
• Trigger document processing — POST /api/v1/knowledge-base/process-document
• List documents — GET /api/v1/knowledge-base/documents
• Get document details — GET /api/v1/knowledge-base/documents/{document_uuid}
• Delete document — DELETE /api/v1/knowledge-base/documents/{document_uuid}
• Search for similar chunks — POST /api/v1/knowledge-base/search

Node schemas#

• List Node Types — GET /api/v1/node-types
• Get Node Type — GET /api/v1/node-types/{name}

Outbound calls#

• Initiate Call — POST /api/v1/telephony/initiate-call

Public calls and artifacts#

• Initiate Call — POST /api/v1/public/agent/{uuid}
• Initiate Call Test — POST /api/v1/public/agent/test/{uuid}
• Initiate Call By Workflow Uuid — POST /api/v1/public/agent/workflow/{workflow_uuid}
• Initiate Call Test By Workflow Uuid — POST /api/v1/public/agent/test/workflow/{workflow_uuid}
• Download Workflow Artifact — GET /api/v1/public/download/workflow/{token}/{artifact_type}

Recordings#

• Get presigned URLs for recording uploads — POST /api/v1/workflow-recordings/upload-url
• Create recording records after upload — POST /api/v1/workflow-recordings/
• List recordings — GET /api/v1/workflow-recordings/
• Delete a recording — DELETE /api/v1/workflow-recordings/{recording_id}
• Update a recording's Recording ID — PATCH /api/v1/workflow-recordings/{id}
• Transcribe an audio file — POST /api/v1/workflow-recordings/transcribe

Reports#

• Get Daily Report — GET /api/v1/organizations/reports/daily
• Get Workflow Options — GET /api/v1/organizations/reports/workflows
• Get Daily Runs Detail — GET /api/v1/organizations/reports/daily/runs

Service Keys#

• Get Service Keys — GET /api/v1/user/service-keys
• Create Service Key — POST /api/v1/user/service-keys
• Archive Service Key — DELETE /api/v1/user/service-keys/{service_key_id}
• Reactivate Service Key — PUT /api/v1/user/service-keys/{service_key_id}/reactivate

Storage#

• Generate a signed S3 URL — GET /api/v1/s3/signed-url
• Get file metadata for debugging — GET /api/v1/s3/file-metadata
• Generate a presigned URL for direct CSV upload — POST /api/v1/s3/presigned-upload-url

Telephony configuration#

• Get Telephony Providers Metadata — GET /api/v1/organizations/telephony-providers/metadata
• Get Telephony Config Warnings — GET /api/v1/organizations/telephony-config-warnings
• List Telephony Configurations — GET /api/v1/organizations/telephony-configs
• Create Telephony Configuration — POST /api/v1/organizations/telephony-configs
• Get Telephony Configuration By Id — GET /api/v1/organizations/telephony-configs/{config_id}
• Update Telephony Configuration — PUT /api/v1/organizations/telephony-configs/{config_id}
• Delete Telephony Configuration — DELETE /api/v1/organizations/telephony-configs/{config_id}
• Set Default Outbound — POST /api/v1/organizations/telephony-configs/{config_id}/set-default-outbound
• Reactivate Telephony Configuration — POST /api/v1/organizations/telephony-configs/{config_id}/reactivate
• List Telephony Trunks — GET /api/v1/organizations/telephony-configs/{config_id}/trunks
• Create Telephony Trunk — POST /api/v1/organizations/telephony-configs/{config_id}/trunks
• Update Telephony Trunk — PUT /api/v1/organizations/telephony-configs/{config_id}/trunks/{trunk_id}
• Delete Telephony Trunk — DELETE /api/v1/organizations/telephony-configs/{config_id}/trunks/{trunk_id}
• List Phone Numbers — GET /api/v1/organizations/telephony-configs/{config_id}/phone-numbers
• Create Phone Number — POST /api/v1/organizations/telephony-configs/{config_id}/phone-numbers
• Get Phone Number — GET /api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}
• Update Phone Number — PUT /api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}
• Delete Phone Number — DELETE /api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}
• Set Default Caller Id — POST /api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}/set-default-caller

Text chat and scenarios#

• Create Text Chat Session — POST /api/v1/workflow/{workflow_id}/text-chat/sessions
• Get Text Chat Session — GET /api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}
• Append Text Chat Message — POST /api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}/messages
• End Text Chat Session — POST /api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}/end
• Rewind Text Chat Session — POST /api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}/rewind
• List Text Scenarios — GET /api/v1/workflow/{workflow_id}/text-chat/scenarios
• Save Text Scenario — PUT /api/v1/workflow/{workflow_id}/text-chat/scenarios/{run_id}
• Delete Text Scenario — DELETE /api/v1/workflow/{workflow_id}/text-chat/scenarios/{run_id}
• Replay Text Scenario — POST /api/v1/workflow/{workflow_id}/text-chat/scenarios/{run_id}/replay

Tools#

• List Tools — GET /api/v1/tools/
• Create Tool — POST /api/v1/tools/
• Get Tool — GET /api/v1/tools/{tool_uuid}
• Update Tool — PUT /api/v1/tools/{tool_uuid}
• Delete Tool — DELETE /api/v1/tools/{tool_uuid}
• Refresh Mcp Tools — POST /api/v1/tools/{tool_uuid}/mcp/refresh
• Test Tool — POST /api/v1/tools/{tool_uuid}/test
• Unarchive Tool — POST /api/v1/tools/{tool_uuid}/unarchive

TURN#

• Get Turn Credentials — GET /api/v1/turn/credentials

User configuration#

• Get Default Configurations — GET /api/v1/user/configurations/defaults
• Get Auth User — GET /api/v1/user/auth/user
• Get User Configurations — GET /api/v1/user/configurations/user
• Update User Configurations — PUT /api/v1/user/configurations/user
• Get User Onboarding State — GET /api/v1/user/onboarding-state
• Update User Onboarding State — PUT /api/v1/user/onboarding-state
• Validate User Configurations — GET /api/v1/user/configurations/user/validate
• Get Voices — GET /api/v1/user/configurations/voices/{provider}

Voice cloning#

• Voice Clone Capabilities — GET /api/v1/voice-clones/capabilities
• List Voice Clones — GET /api/v1/voice-clones
• Create Voice Clone — POST /api/v1/voice-clones
• List Voice Clone Agents — GET /api/v1/voice-clones/agents
• Assign Voice Clone — PUT /api/v1/voice-clones/agents/{workflow_id}
• Preview Voice Clone — POST /api/v1/voice-clones/{clone_id}/preview
• Delete Voice Clone — DELETE /api/v1/voice-clones/{clone_id}

Website embeds#

• Initialize Embed Session — POST /api/v1/public/embed/init
• Options Init — OPTIONS /api/v1/public/embed/init
• Options Embed Config — OPTIONS /api/v1/public/embed/config/{token}
• Get Embed Config — GET /api/v1/public/embed/config/{token}
• Get Public Turn Credentials — GET /api/v1/public/embed/turn-credentials/{session_token}
• Options Turn Credentials — OPTIONS /api/v1/public/embed/turn-credentials/{session_token}
• Get Public Chat Session — GET /api/v1/public/embed/chat/{session_token}
• Options Public Chat Session — OPTIONS /api/v1/public/embed/chat/{session_token}
• End Public Chat Session — POST /api/v1/public/embed/chat/{session_token}/end
• Options Public Chat End — OPTIONS /api/v1/public/embed/chat/{session_token}/end
• Post Public Chat Message — POST /api/v1/public/embed/chat/{session_token}/messages
• Options Public Chat Messages — OPTIONS /api/v1/public/embed/chat/{session_token}/messages
• Create Or Update Embed Token — POST /api/v1/workflow/{workflow_id}/embed-token
• Get Embed Token — GET /api/v1/workflow/{workflow_id}/embed-token
• Deactivate Embed Token — DELETE /api/v1/workflow/{workflow_id}/embed-token

Workspace configuration#

• Get Current Organization Context — GET /api/v1/organizations/context
• Get Model Configuration V2 Defaults — GET /api/v1/organizations/model-configurations/v2/defaults
• Get Model Configuration V2 — GET /api/v1/organizations/model-configurations/v2
• Save Model Configuration V2 — PUT /api/v1/organizations/model-configurations/v2
• Get Model Configuration Pricing — GET /api/v1/organizations/model-configurations/v2/pricing
• Preview Model Configuration V2 Migration — GET /api/v1/organizations/model-configurations/v2/migration-preview
• Migrate Model Configuration V2 — POST /api/v1/organizations/model-configurations/v2/migrate
• Get Disposition Codes — GET /api/v1/organizations/disposition-codes
• Get Preferences — GET /api/v1/organizations/preferences
• Save Preferences — PUT /api/v1/organizations/preferences
• Get Langfuse Credentials — GET /api/v1/organizations/langfuse-credentials
• Save Langfuse Credentials — POST /api/v1/organizations/langfuse-credentials
• Delete Langfuse Credentials — DELETE /api/v1/organizations/langfuse-credentials
• Get Campaign Defaults — GET /api/v1/organizations/campaign-defaults