/

Docs
History
Schema
Generate

Filter operations

main211

post/api/v1/telephony/initiate-callInitiate Call
get/api/v1/telephony/inbound/runHandle Inbound Run
post/api/v1/telephony/inbound/runHandle Inbound Run
post/api/v1/telephony/inbound/fallbackHandle Inbound Fallback
post/api/v1/telephony/inbound/{workflow_id}Handle Inbound Telephony
post/api/v1/telephony/transfer-result/{transfer_id}Complete Transfer Function Call
post/api/v1/telephony/cloudonix/transfer-result/{transfer_id}Handle Cloudonix Transfer Result
post/api/v1/telephony/cloudonix/status-callback/{workflow_run_id}Handle Cloudonix Status Callback
post/api/v1/telephony/cloudonix/cdrHandle Cloudonix Cdr
post/api/v1/telephony/exotel/status-callback/{workflow_run_id}Handle Exotel Status Callback
post/api/v1/telephony/plivo/hangup-callback/{workflow_run_id}Handle Plivo Hangup Callback
post/api/v1/telephony/plivo/ring-callback/{workflow_run_id}Handle Plivo Ring Callback
post/api/v1/telephony/telnyx/events/{workflow_run_id}Handle Telnyx Events
post/api/v1/telephony/telnyx/transfer-result/{transfer_id}Handle Telnyx Transfer Result
post/api/v1/telephony/twilio/status-callback/{workflow_run_id}Handle Twilio Status Callback
post/api/v1/telephony/vobiz/hangup-callback/{workflow_run_id}Handle Vobiz Hangup Callback
post/api/v1/telephony/vobiz/ring-callback/{workflow_run_id}Handle Vobiz Ring Callback
post/api/v1/telephony/vobiz/hangup-callback/workflow/{workflow_id}Handle Vobiz Hangup Callback By Workflow
post/api/v1/telephony/vonage/events/{workflow_run_id}Handle Vonage Events
post/api/v1/telephony/vonage/eventsHandle Vonage Events Without Run
get/api/v1/telephony/whatsapp/webhookHandle Webhook Verification
post/api/v1/telephony/whatsapp/webhookHandle Whatsapp Webhook
post/api/v1/superuser/impersonateImpersonate
get/api/v1/superuser/workflow-runsGet Workflow Runs
post/api/v1/workflow/{workflow_id}/validateValidate Workflow
post/api/v1/workflow/create/definitionCreate Workflow
post/api/v1/workflow/create/templateCreate Workflow From Template
get/api/v1/workflow/countGet Workflow Count
get/api/v1/workflow/fetchGet Workflows
get/api/v1/workflow/fetch/{workflow_id}Get Workflow
get/api/v1/workflow/{workflow_id}/version-summariesGet Workflow Version Summaries
get/api/v1/workflow/{workflow_id}/versionsGet Workflow Versions
patch/api/v1/workflow/{workflow_id}/versions/{definition_id}/metadataUpdate Workflow Version Metadata
post/api/v1/workflow/{workflow_id}/publishPublish Workflow
post/api/v1/workflow/{workflow_id}/create-draftCreate Workflow Draft
get/api/v1/workflow/summaryGet Workflows Summary
put/api/v1/workflow/{workflow_id}/statusUpdate Workflow Status
put/api/v1/workflow/{workflow_id}/folderMove Workflow To Folder
put/api/v1/workflow/{workflow_id}Update Workflow
post/api/v1/workflow/{workflow_id}/duplicateDuplicate Workflow Endpoint
get/api/v1/workflow/{workflow_id}/runsGet Workflow Runs
post/api/v1/workflow/{workflow_id}/runsCreate Workflow Run
get/api/v1/workflow/{workflow_id}/runs/{run_id}Get Workflow Run
get/api/v1/workflow/{workflow_id}/reportDownload Workflow Report
get/api/v1/workflow/templatesGet Workflow Templates
post/api/v1/workflow/templates/duplicateDuplicate Workflow Template
post/api/v1/workflow/ambient-noise/upload-urlGet a presigned URL to upload a custom ambient noise audio file
post/api/v1/workflow/{workflow_id}/text-chat/sessionsCreate Text Chat Session
get/api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}Get Text Chat Session
get/api/v1/workflow/{workflow_id}/text-chat/sessions/recovery/{request_id}Recover Text Chat Session
post/api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}/messagesAppend Text Chat Message
post/api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}/endEnd Text Chat Session
post/api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}/rewindRewind Text Chat Session
post/api/v1/workflow/{workflow_id}/text-chat/sessions/streamStream Text Chat Session
post/api/v1/workflow/{workflow_id}/text-chat/sessions/{run_id}/messages/streamStream Text Chat Message
get/api/v1/user/configurations/defaultsGet Default Configurations
get/api/v1/user/auth/userGet Auth User
get/api/v1/user/configurations/userGet User Configurations
put/api/v1/user/configurations/userUpdate User Configurations
get/api/v1/user/onboarding-stateGet User Onboarding State
put/api/v1/user/onboarding-stateUpdate User Onboarding State
get/api/v1/user/configurations/user/validateValidate User Configurations
get/api/v1/user/api-keysGet Api Keys
post/api/v1/user/api-keysCreate Api Key
delete/api/v1/user/api-keys/{api_key_id}Archive Api Key
put/api/v1/user/api-keys/{api_key_id}/reactivateReactivate Api Key
get/api/v1/user/configurations/voices/{provider}Get Voices
get/api/v1/campaign/{campaign_id}/traffic-statsGet Campaign Traffic Stats
post/api/v1/campaign/createCreate Campaign
get/api/v1/campaign/Get Campaigns
get/api/v1/campaign/{campaign_id}Get Campaign
patch/api/v1/campaign/{campaign_id}Update Campaign
post/api/v1/campaign/{campaign_id}/startStart Campaign
post/api/v1/campaign/{campaign_id}/pausePause Campaign
get/api/v1/campaign/{campaign_id}/runsGet Campaign Runs
post/api/v1/campaign/{campaign_id}/redialRedial Campaign
post/api/v1/campaign/{campaign_id}/resumeResume Campaign
get/api/v1/campaign/{campaign_id}/progressGet Campaign Progress
get/api/v1/campaign/{campaign_id}/source-download-urlGet Campaign Source Download Url
get/api/v1/campaign/{campaign_id}/reportDownload Campaign Report
get/api/v1/credentials/List Credentials
post/api/v1/credentials/Create Credential
get/api/v1/credentials/{credential_uuid}Get Credential
put/api/v1/credentials/{credential_uuid}Update Credential
delete/api/v1/credentials/{credential_uuid}Delete Credential
get/api/v1/tools/List Tools
post/api/v1/tools/Create Tool
get/api/v1/tools/{tool_uuid}Get Tool
put/api/v1/tools/{tool_uuid}Update Tool
delete/api/v1/tools/{tool_uuid}Delete Tool
post/api/v1/tools/{tool_uuid}/mcp/refreshRefresh Mcp Tools
post/api/v1/tools/{tool_uuid}/testTest Tool
post/api/v1/tools/{tool_uuid}/unarchiveUnarchive Tool
get/api/v1/organizations/contextGet Current Organization Context
get/api/v1/organizations/telephony-providers/metadataGet Telephony Providers Metadata
get/api/v1/organizations/telephony-config-warningsGet Telephony Config Warnings
get/api/v1/organizations/disposition-codesGet Disposition Codes
get/api/v1/organizations/preferencesGet Preferences
put/api/v1/organizations/preferencesSave Preferences
post/api/v1/organizations/call-events/testTest Call Events Connection
get/api/v1/organizations/telephony-configsList Telephony Configurations
post/api/v1/organizations/telephony-configsCreate Telephony Configuration
get/api/v1/organizations/telephony-configs/{config_id}Get Telephony Configuration By Id
put/api/v1/organizations/telephony-configs/{config_id}Update Telephony Configuration
delete/api/v1/organizations/telephony-configs/{config_id}Delete Telephony Configuration
post/api/v1/organizations/telephony-configs/{config_id}/set-default-outboundSet Default Outbound
post/api/v1/organizations/telephony-configs/{config_id}/reactivateReactivate Telephony Configuration
get/api/v1/organizations/telephony-configs/{config_id}/trunksList Telephony Trunks
post/api/v1/organizations/telephony-configs/{config_id}/trunksCreate Telephony Trunk
put/api/v1/organizations/telephony-configs/{config_id}/trunks/{trunk_id}Update Telephony Trunk
delete/api/v1/organizations/telephony-configs/{config_id}/trunks/{trunk_id}Delete Telephony Trunk
get/api/v1/organizations/telephony-configs/{config_id}/phone-numbersList Phone Numbers
post/api/v1/organizations/telephony-configs/{config_id}/phone-numbersCreate Phone Number
post/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/syncSync Phone Numbers
get/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}Get Phone Number
put/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}Update Phone Number
delete/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}Delete Phone Number
post/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}/set-default-callerSet Default Caller Id
get/api/v1/organizations/langfuse-credentialsGet Langfuse Credentials
post/api/v1/organizations/langfuse-credentialsSave Langfuse Credentials
delete/api/v1/organizations/langfuse-credentialsDelete Langfuse Credentials
get/api/v1/organizations/campaign-defaultsGet Campaign Defaults
get/api/v1/model-connections/catalogGet Catalog
get/api/v1/model-connections/provider-connectionsList Connections
post/api/v1/model-connections/provider-connectionsCreate Connection
delete/api/v1/model-connections/provider-connections/{connection_uuid}Archive Connection
patch/api/v1/model-connections/provider-connections/{connection_uuid}Update Connection
post/api/v1/model-connections/provider-connections/{connection_uuid}/restoreRestore Connection
get/api/v1/model-connections/model-configurationsList Configurations
post/api/v1/model-connections/model-configurationsCreate Configuration
get/api/v1/model-connections/model-configurations/{configuration_uuid}Get Configuration
delete/api/v1/model-connections/model-configurations/{configuration_uuid}Archive Configuration
patch/api/v1/model-connections/model-configurations/{configuration_uuid}Update Configuration
post/api/v1/model-connections/model-configurations/{configuration_uuid}/restoreRestore Configuration
get/api/v1/model-connections/defaultGet Default Configuration
put/api/v1/model-connections/defaultSet Default Configuration
post/api/v1/model-connections/resolvePreview Configuration
get/api/v1/s3/signed-urlGenerate a signed S3 URL
get/api/v1/s3/file-metadataGet file metadata for debugging
post/api/v1/s3/presigned-upload-urlGenerate a presigned URL for direct CSV upload
get/api/v1/user/service-keysGet Service Keys
post/api/v1/user/service-keysCreate Service Key
delete/api/v1/user/service-keys/{service_key_id}Archive Service Key
put/api/v1/user/service-keys/{service_key_id}/reactivateReactivate Service Key
get/api/v1/organizations/concurrent-callsGet Organization Concurrent Calls
get/api/v1/organizations/usage/current-periodGet Current Period Usage
get/api/v1/organizations/billing/creditsGet Billing Credits
post/api/v1/organizations/usage/mps-credits/purchase-urlCreate Mps Credit Purchase Url
get/api/v1/organizations/billing/paymentsGet Billing Payments
get/api/v1/organizations/billing/invoices/{payment_order_id}/pdfDownload Billing Invoice
get/api/v1/organizations/usage/runsGet Usage History
get/api/v1/organizations/usage/runs/reportDownload Usage Runs Report
get/api/v1/organizations/usage/daily-breakdownGet Daily Usage Breakdown
get/api/v1/organizations/reports/dailyGet Daily Report
get/api/v1/organizations/reports/workflowsGet Workflow Options
get/api/v1/organizations/reports/daily/runsGet Daily Runs Detail
get/api/v1/turn/credentialsGet Turn Credentials
post/api/v1/public/embed/initInitialize Embed Session
options/api/v1/public/embed/initOptions Init
post/api/v1/public/embed/init/streamStream Initialize Embed Chat
options/api/v1/public/embed/init/streamOptions Init
get/api/v1/public/embed/config/{token}Get Embed Config
options/api/v1/public/embed/config/{token}Options Embed Config
get/api/v1/public/embed/turn-credentials/{session_token}Get Public Turn Credentials
options/api/v1/public/embed/turn-credentials/{session_token}Options Turn Credentials
get/api/v1/public/embed/chat/{session_token}Get Public Chat Session
options/api/v1/public/embed/chat/{session_token}Options Public Chat Session
post/api/v1/public/embed/chat/{session_token}/endEnd Public Chat Session
options/api/v1/public/embed/chat/{session_token}/endOptions Public Chat End
post/api/v1/public/embed/chat/{session_token}/messagesPost Public Chat Message
options/api/v1/public/embed/chat/{session_token}/messagesOptions Public Chat Messages
post/api/v1/public/embed/chat/{session_token}/messages/streamStream Public Chat Message
options/api/v1/public/embed/chat/{session_token}/messages/streamOptions Public Chat Messages
post/api/v1/public/agent/{uuid}Initiate Call
post/api/v1/public/agent/test/{uuid}Initiate Call Test
post/api/v1/public/agent/workflow/{workflow_uuid}Initiate Call By Workflow Uuid
post/api/v1/public/agent/test/workflow/{workflow_uuid}Initiate Call Test By Workflow Uuid
get/api/v1/public/download/workflow/{token}/{artifact_type}Download Workflow Artifact
get/api/v1/workflow/{workflow_id}/embed-tokenGet Embed Token
post/api/v1/workflow/{workflow_id}/embed-tokenCreate Or Update Embed Token
delete/api/v1/workflow/{workflow_id}/embed-tokenDeactivate Embed Token
post/api/v1/knowledge-base/upload-urlGet presigned URL for document upload
post/api/v1/knowledge-base/process-documentTrigger document processing
get/api/v1/knowledge-base/documentsList documents
get/api/v1/knowledge-base/documents/{document_uuid}Get document details
delete/api/v1/knowledge-base/documents/{document_uuid}Delete document
get/api/v1/knowledge-base/documents/{document_uuid}/contentGet editable document content
put/api/v1/knowledge-base/documents/{document_uuid}/contentReplace document content and re-index
post/api/v1/knowledge-base/searchSearch for similar chunks
post/api/v1/workflow-recordings/upload-urlGet presigned URLs for recording uploads
get/api/v1/workflow-recordings/List recordings
post/api/v1/workflow-recordings/Create recording records after upload
delete/api/v1/workflow-recordings/{recording_id}Delete a recording
patch/api/v1/workflow-recordings/{id}Update a recording's Recording ID
post/api/v1/workflow-recordings/transcribeTranscribe an audio file
get/api/v1/tts-cacheList Tts Cache
delete/api/v1/tts-cacheClear Tts Cache
get/api/v1/tts-cache/{entry_id}/audioPreview Tts Cache
delete/api/v1/tts-cache/{entry_id}Invalidate Tts Cache Entry
get/api/v1/folder/List Folders
post/api/v1/folder/Create Folder
put/api/v1/folder/{folder_id}Rename Folder
delete/api/v1/folder/{folder_id}Delete Folder
post/api/v1/auth/signupSignup
post/api/v1/auth/loginLogin
get/api/v1/auth/meGet Current User
get/api/v1/node-typesList Node Types
get/api/v1/node-types/{name}Get Node Type
get/api/v1/healthHealth
get/api/v1/health/active-callsActive Calls
get/api/v1/health/autoscale-metricAutoscale Metric

main

Changes to Get User Onboarding State

get/api/v1/user/onboarding-state

Nov 3, 2026faa00cf76fcb Revision changes
- info
  endpoint added