Skip to main content
POST
Create Call

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard [blocked].

Body

application/json
customers
object[]

This is used to issue batch calls to multiple customers.

Only relevant for outboundPhoneCall. To call a single customer, use customer instead.

name
string

This is the name of the call. This is just for your own reference.

Maximum string length: 40
schedulePlan
object

This is the schedule plan of the call.

transport
object

This is the transport of the call.

assistantId
string

This is the assistant ID that will be used for the call. To use a transient assistant, use assistant instead.

To start a call with:

  • Assistant, use assistantId or assistant
  • Squad, use squadId or squad
  • Workflow, use workflowId or workflow
assistant
object

This is the assistant that will be used for the call. To use an existing assistant, use assistantId instead.

To start a call with:

  • Assistant, use assistant
  • Squad, use squad
  • Workflow, use workflow
assistantOverrides
object

These are the overrides for the assistant or assistantId's settings and template variables.

squadId
string

This is the squad that will be used for the call. To use a transient squad, use squad instead.

To start a call with:

  • Assistant, use assistant or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
squad
object

This is a squad that will be used for the call. To use an existing squad, use squadId instead.

To start a call with:

  • Assistant, use assistant or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
workflowId
string

This is the workflow that will be used for the call. To use a transient workflow, use workflow instead.

To start a call with:

  • Assistant, use assistant or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
workflow
object

This is a workflow that will be used for the call. To use an existing workflow, use workflowId instead.

To start a call with:

  • Assistant, use assistant or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
workflowOverrides
object

These are the overrides for the workflow or workflowId's settings and template variables.

phoneNumberId
string

This is the phone number that will be used for the call. To use a transient number, use phoneNumber instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

phoneNumber
object

This is the phone number that will be used for the call. To use an existing number, use phoneNumberId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customerId
string

This is the customer that will be called. To call a transient customer , use customer instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customer
object

This is the customer that will be called. To call an existing customer, use customerId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Response

201 - application/json
id
string
required

This is the unique identifier for the call.

orgId
string
required

This is the unique identifier for the org that this call belongs to.

createdAt
string<date-time>
required

This is the ISO 8601 date-time string of when the call was created.

updatedAt
string<date-time>
required

This is the ISO 8601 date-time string of when the call was last updated.

type
enum<string>

This is the type of call.

Available options:
inboundPhoneCall,
outboundPhoneCall,
webCall,
cozmox.websocketCall
costs
(TransportCost · object | TranscriberCost · object | ModelCost · object | VoiceCost · object | cozmoxCost · object | VoicemailDetectionCost · object | AnalysisCost · object | KnowledgeBaseCost · object)[]

These are the costs of individual components of the call in USD.

messages
(UserMessage · object | SystemMessage · object | BotMessage · object | ToolCallMessage · object | ToolCallResultMessage · object)[]
phoneCallProvider
enum<string>
deprecated

This is the provider of the call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Available options:
twilio,
vonage,
cozmox,
telnyx
phoneCallTransport
enum<string>

This is the transport of the phone call.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

Available options:
sip,
pstn
status
enum<string>

This is the status of the call.

Available options:
scheduled,
queued,
ringing,
in-progress,
forwarding,
ended
endedReason
enum<string>

This is the explanation for how the call ended.

Available options:
call-start-error-neither-assistant-nor-server-set,
assistant-request-failed,
assistant-request-returned-error,
assistant-request-returned-unspeakable-error,
assistant-request-returned-invalid-assistant,
assistant-request-returned-no-assistant,
assistant-request-returned-forwarding-phone-number,
scheduled-call-deleted,
call.start.error-cozmoxfault-get-org,
call.start.error-cozmoxfault-get-subscription,
call.start.error-get-assistant,
call.start.error-get-phone-number,
call.start.error-get-customer,
call.start.error-get-resources-validation,
call.start.error-cozmox-number-international,
call.start.error-cozmox-number-outbound-daily-limit,
call.start.error-get-transport,
call.start.error-subscription-wallet-does-not-exist,
call.start.error-subscription-frozen,
call.start.error-subscription-insufficient-credits,
call.start.error-subscription-upgrade-failed,
call.start.error-subscription-concurrency-limit-reached,
assistant-not-valid,
database-error,
assistant-not-found,
pipeline-error-openai-voice-failed,
pipeline-error-cartesia-voice-failed,
pipeline-error-deepgram-voice-failed,
pipeline-error-eleven-labs-voice-failed,
pipeline-error-playht-voice-failed,
pipeline-error-lmnt-voice-failed,
pipeline-error-azure-voice-failed,
pipeline-error-rime-ai-voice-failed,
pipeline-error-smallest-ai-voice-failed,
pipeline-error-neuphonic-voice-failed,
pipeline-error-hume-voice-failed,
pipeline-error-sesame-voice-failed,
pipeline-error-inworld-voice-failed,
pipeline-error-tavus-video-failed,
call.in-progress.error-cozmoxfault-openai-voice-failed,
call.in-progress.error-cozmoxfault-cartesia-voice-failed,
call.in-progress.error-cozmoxfault-deepgram-voice-failed,
call.in-progress.error-cozmoxfault-eleven-labs-voice-failed,
call.in-progress.error-cozmoxfault-playht-voice-failed,
call.in-progress.error-cozmoxfault-lmnt-voice-failed,
call.in-progress.error-cozmoxfault-azure-voice-failed,
call.in-progress.error-cozmoxfault-rime-ai-voice-failed,
call.in-progress.error-cozmoxfault-smallest-ai-voice-failed,
call.in-progress.error-cozmoxfault-neuphonic-voice-failed,
call.in-progress.error-cozmoxfault-hume-voice-failed,
call.in-progress.error-cozmoxfault-sesame-voice-failed,
call.in-progress.error-cozmoxfault-inworld-voice-failed,
call.in-progress.error-cozmoxfault-tavus-video-failed,
pipeline-error-cozmox-llm-failed,
pipeline-error-cozmox-400-bad-request-validation-failed,
pipeline-error-cozmox-401-unauthorized,
pipeline-error-cozmox-403-model-access-denied,
pipeline-error-cozmox-429-exceeded-quota,
pipeline-error-cozmox-500-server-error,
pipeline-error-cozmox-503-server-overloaded-error,
call.in-progress.error-cozmoxfault-cozmox-llm-failed,
call.in-progress.error-cozmoxfault-cozmox-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-cozmox-401-unauthorized,
call.in-progress.error-cozmoxfault-cozmox-403-model-access-denied,
call.in-progress.error-cozmoxfault-cozmox-429-exceeded-quota,
call.in-progress.error-providerfault-cozmox-500-server-error,
call.in-progress.error-providerfault-cozmox-503-server-overloaded-error,
pipeline-error-deepgram-transcriber-failed,
call.in-progress.error-cozmoxfault-deepgram-transcriber-failed,
pipeline-error-gladia-transcriber-failed,
call.in-progress.error-cozmoxfault-gladia-transcriber-failed,
pipeline-error-speechmatics-transcriber-failed,
call.in-progress.error-cozmoxfault-speechmatics-transcriber-failed,
pipeline-error-assembly-ai-transcriber-failed,
pipeline-error-assembly-ai-returning-400-insufficent-funds,
pipeline-error-assembly-ai-returning-400-paid-only-feature,
pipeline-error-assembly-ai-returning-401-invalid-credentials,
pipeline-error-assembly-ai-returning-500-invalid-schema,
pipeline-error-assembly-ai-returning-500-word-boost-parsing-failed,
call.in-progress.error-cozmoxfault-assembly-ai-transcriber-failed,
call.in-progress.error-cozmoxfault-assembly-ai-returning-400-insufficent-funds,
call.in-progress.error-cozmoxfault-assembly-ai-returning-400-paid-only-feature,
call.in-progress.error-cozmoxfault-assembly-ai-returning-401-invalid-credentials,
call.in-progress.error-cozmoxfault-assembly-ai-returning-500-invalid-schema,
call.in-progress.error-cozmoxfault-assembly-ai-returning-500-word-boost-parsing-failed,
pipeline-error-talkscriber-transcriber-failed,
call.in-progress.error-cozmoxfault-talkscriber-transcriber-failed,
pipeline-error-azure-speech-transcriber-failed,
call.in-progress.error-cozmoxfault-azure-speech-transcriber-failed,
call.in-progress.error-pipeline-no-available-llm-model,
worker-shutdown,
vonage-disconnected,
vonage-failed-to-connect-call,
vonage-completed,
phone-call-provider-bypass-enabled-but-no-call-received,
call.in-progress.error-providerfault-transport-never-connected,
call.in-progress.error-cozmoxfault-worker-not-available,
call.in-progress.error-cozmoxfault-transport-never-connected,
call.in-progress.error-cozmoxfault-transport-connected-but-call-not-active,
call.in-progress.error-cozmoxfault-call-started-but-connection-to-transport-missing,
call.in-progress.error-cozmoxfault-worker-died,
call.in-progress.twilio-completed-call,
call.in-progress.sip-completed-call,
call.in-progress.error-cozmoxfault-openai-llm-failed,
call.in-progress.error-cozmoxfault-azure-openai-llm-failed,
call.in-progress.error-cozmoxfault-groq-llm-failed,
call.in-progress.error-cozmoxfault-google-llm-failed,
call.in-progress.error-cozmoxfault-xai-llm-failed,
call.in-progress.error-cozmoxfault-mistral-llm-failed,
call.in-progress.error-cozmoxfault-inflection-ai-llm-failed,
call.in-progress.error-cozmoxfault-cerebras-llm-failed,
call.in-progress.error-cozmoxfault-deep-seek-llm-failed,
call.in-progress.error-cozmoxfault-chat-pipeline-failed-to-start,
pipeline-error-openai-400-bad-request-validation-failed,
pipeline-error-openai-401-unauthorized,
pipeline-error-openai-401-incorrect-api-key,
pipeline-error-openai-401-account-not-in-organization,
pipeline-error-openai-403-model-access-denied,
pipeline-error-openai-429-exceeded-quota,
pipeline-error-openai-429-rate-limit-reached,
pipeline-error-openai-500-server-error,
pipeline-error-openai-503-server-overloaded-error,
pipeline-error-openai-llm-failed,
call.in-progress.error-cozmoxfault-openai-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-openai-401-unauthorized,
call.in-progress.error-cozmoxfault-openai-401-incorrect-api-key,
call.in-progress.error-cozmoxfault-openai-401-account-not-in-organization,
call.in-progress.error-cozmoxfault-openai-403-model-access-denied,
call.in-progress.error-cozmoxfault-openai-429-exceeded-quota,
call.in-progress.error-cozmoxfault-openai-429-rate-limit-reached,
call.in-progress.error-providerfault-openai-500-server-error,
call.in-progress.error-providerfault-openai-503-server-overloaded-error,
pipeline-error-azure-openai-400-bad-request-validation-failed,
pipeline-error-azure-openai-401-unauthorized,
pipeline-error-azure-openai-403-model-access-denied,
pipeline-error-azure-openai-429-exceeded-quota,
pipeline-error-azure-openai-500-server-error,
pipeline-error-azure-openai-503-server-overloaded-error,
pipeline-error-azure-openai-llm-failed,
call.in-progress.error-cozmoxfault-azure-openai-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-azure-openai-401-unauthorized,
call.in-progress.error-cozmoxfault-azure-openai-403-model-access-denied,
call.in-progress.error-cozmoxfault-azure-openai-429-exceeded-quota,
call.in-progress.error-providerfault-azure-openai-500-server-error,
call.in-progress.error-providerfault-azure-openai-503-server-overloaded-error,
pipeline-error-google-400-bad-request-validation-failed,
pipeline-error-google-401-unauthorized,
pipeline-error-google-403-model-access-denied,
pipeline-error-google-429-exceeded-quota,
pipeline-error-google-500-server-error,
pipeline-error-google-503-server-overloaded-error,
pipeline-error-google-llm-failed,
call.in-progress.error-cozmoxfault-google-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-google-401-unauthorized,
call.in-progress.error-cozmoxfault-google-403-model-access-denied,
call.in-progress.error-cozmoxfault-google-429-exceeded-quota,
call.in-progress.error-providerfault-google-500-server-error,
call.in-progress.error-providerfault-google-503-server-overloaded-error,
pipeline-error-xai-400-bad-request-validation-failed,
pipeline-error-xai-401-unauthorized,
pipeline-error-xai-403-model-access-denied,
pipeline-error-xai-429-exceeded-quota,
pipeline-error-xai-500-server-error,
pipeline-error-xai-503-server-overloaded-error,
pipeline-error-xai-llm-failed,
call.in-progress.error-cozmoxfault-xai-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-xai-401-unauthorized,
call.in-progress.error-cozmoxfault-xai-403-model-access-denied,
call.in-progress.error-cozmoxfault-xai-429-exceeded-quota,
call.in-progress.error-providerfault-xai-500-server-error,
call.in-progress.error-providerfault-xai-503-server-overloaded-error,
pipeline-error-mistral-400-bad-request-validation-failed,
pipeline-error-mistral-401-unauthorized,
pipeline-error-mistral-403-model-access-denied,
pipeline-error-mistral-429-exceeded-quota,
pipeline-error-mistral-500-server-error,
pipeline-error-mistral-503-server-overloaded-error,
pipeline-error-mistral-llm-failed,
call.in-progress.error-cozmoxfault-mistral-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-mistral-401-unauthorized,
call.in-progress.error-cozmoxfault-mistral-403-model-access-denied,
call.in-progress.error-cozmoxfault-mistral-429-exceeded-quota,
call.in-progress.error-providerfault-mistral-500-server-error,
call.in-progress.error-providerfault-mistral-503-server-overloaded-error,
pipeline-error-inflection-ai-400-bad-request-validation-failed,
pipeline-error-inflection-ai-401-unauthorized,
pipeline-error-inflection-ai-403-model-access-denied,
pipeline-error-inflection-ai-429-exceeded-quota,
pipeline-error-inflection-ai-500-server-error,
pipeline-error-inflection-ai-503-server-overloaded-error,
pipeline-error-inflection-ai-llm-failed,
call.in-progress.error-cozmoxfault-inflection-ai-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-inflection-ai-401-unauthorized,
call.in-progress.error-cozmoxfault-inflection-ai-403-model-access-denied,
call.in-progress.error-cozmoxfault-inflection-ai-429-exceeded-quota,
call.in-progress.error-providerfault-inflection-ai-500-server-error,
call.in-progress.error-providerfault-inflection-ai-503-server-overloaded-error,
pipeline-error-deep-seek-400-bad-request-validation-failed,
pipeline-error-deep-seek-401-unauthorized,
pipeline-error-deep-seek-403-model-access-denied,
pipeline-error-deep-seek-429-exceeded-quota,
pipeline-error-deep-seek-500-server-error,
pipeline-error-deep-seek-503-server-overloaded-error,
pipeline-error-deep-seek-llm-failed,
call.in-progress.error-cozmoxfault-deep-seek-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-deep-seek-401-unauthorized,
call.in-progress.error-cozmoxfault-deep-seek-403-model-access-denied,
call.in-progress.error-cozmoxfault-deep-seek-429-exceeded-quota,
call.in-progress.error-providerfault-deep-seek-500-server-error,
call.in-progress.error-providerfault-deep-seek-503-server-overloaded-error,
pipeline-error-groq-400-bad-request-validation-failed,
pipeline-error-groq-401-unauthorized,
pipeline-error-groq-403-model-access-denied,
pipeline-error-groq-429-exceeded-quota,
pipeline-error-groq-500-server-error,
pipeline-error-groq-503-server-overloaded-error,
pipeline-error-groq-llm-failed,
call.in-progress.error-cozmoxfault-groq-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-groq-401-unauthorized,
call.in-progress.error-cozmoxfault-groq-403-model-access-denied,
call.in-progress.error-cozmoxfault-groq-429-exceeded-quota,
call.in-progress.error-providerfault-groq-500-server-error,
call.in-progress.error-providerfault-groq-503-server-overloaded-error,
pipeline-error-cerebras-400-bad-request-validation-failed,
pipeline-error-cerebras-401-unauthorized,
pipeline-error-cerebras-403-model-access-denied,
pipeline-error-cerebras-429-exceeded-quota,
pipeline-error-cerebras-500-server-error,
pipeline-error-cerebras-503-server-overloaded-error,
pipeline-error-cerebras-llm-failed,
call.in-progress.error-cozmoxfault-cerebras-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-cerebras-401-unauthorized,
call.in-progress.error-cozmoxfault-cerebras-403-model-access-denied,
call.in-progress.error-cozmoxfault-cerebras-429-exceeded-quota,
call.in-progress.error-providerfault-cerebras-500-server-error,
call.in-progress.error-providerfault-cerebras-503-server-overloaded-error,
pipeline-error-anthropic-400-bad-request-validation-failed,
pipeline-error-anthropic-401-unauthorized,
pipeline-error-anthropic-403-model-access-denied,
pipeline-error-anthropic-429-exceeded-quota,
pipeline-error-anthropic-500-server-error,
pipeline-error-anthropic-503-server-overloaded-error,
pipeline-error-anthropic-llm-failed,
call.in-progress.error-cozmoxfault-anthropic-llm-failed,
call.in-progress.error-cozmoxfault-anthropic-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-anthropic-401-unauthorized,
call.in-progress.error-cozmoxfault-anthropic-403-model-access-denied,
call.in-progress.error-cozmoxfault-anthropic-429-exceeded-quota,
call.in-progress.error-providerfault-anthropic-500-server-error,
call.in-progress.error-providerfault-anthropic-503-server-overloaded-error,
pipeline-error-anthropic-bedrock-400-bad-request-validation-failed,
pipeline-error-anthropic-bedrock-401-unauthorized,
pipeline-error-anthropic-bedrock-403-model-access-denied,
pipeline-error-anthropic-bedrock-429-exceeded-quota,
pipeline-error-anthropic-bedrock-500-server-error,
pipeline-error-anthropic-bedrock-503-server-overloaded-error,
pipeline-error-anthropic-bedrock-llm-failed,
call.in-progress.error-cozmoxfault-anthropic-bedrock-llm-failed,
call.in-progress.error-cozmoxfault-anthropic-bedrock-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-anthropic-bedrock-401-unauthorized,
call.in-progress.error-cozmoxfault-anthropic-bedrock-403-model-access-denied,
call.in-progress.error-cozmoxfault-anthropic-bedrock-429-exceeded-quota,
call.in-progress.error-providerfault-anthropic-bedrock-500-server-error,
call.in-progress.error-providerfault-anthropic-bedrock-503-server-overloaded-error,
pipeline-error-anthropic-vertex-400-bad-request-validation-failed,
pipeline-error-anthropic-vertex-401-unauthorized,
pipeline-error-anthropic-vertex-403-model-access-denied,
pipeline-error-anthropic-vertex-429-exceeded-quota,
pipeline-error-anthropic-vertex-500-server-error,
pipeline-error-anthropic-vertex-503-server-overloaded-error,
pipeline-error-anthropic-vertex-llm-failed,
call.in-progress.error-cozmoxfault-anthropic-vertex-llm-failed,
call.in-progress.error-cozmoxfault-anthropic-vertex-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-anthropic-vertex-401-unauthorized,
call.in-progress.error-cozmoxfault-anthropic-vertex-403-model-access-denied,
call.in-progress.error-cozmoxfault-anthropic-vertex-429-exceeded-quota,
call.in-progress.error-providerfault-anthropic-vertex-500-server-error,
call.in-progress.error-providerfault-anthropic-vertex-503-server-overloaded-error,
pipeline-error-together-ai-400-bad-request-validation-failed,
pipeline-error-together-ai-401-unauthorized,
pipeline-error-together-ai-403-model-access-denied,
pipeline-error-together-ai-429-exceeded-quota,
pipeline-error-together-ai-500-server-error,
pipeline-error-together-ai-503-server-overloaded-error,
pipeline-error-together-ai-llm-failed,
call.in-progress.error-cozmoxfault-together-ai-llm-failed,
call.in-progress.error-cozmoxfault-together-ai-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-together-ai-401-unauthorized,
call.in-progress.error-cozmoxfault-together-ai-403-model-access-denied,
call.in-progress.error-cozmoxfault-together-ai-429-exceeded-quota,
call.in-progress.error-providerfault-together-ai-500-server-error,
call.in-progress.error-providerfault-together-ai-503-server-overloaded-error,
pipeline-error-anyscale-400-bad-request-validation-failed,
pipeline-error-anyscale-401-unauthorized,
pipeline-error-anyscale-403-model-access-denied,
pipeline-error-anyscale-429-exceeded-quota,
pipeline-error-anyscale-500-server-error,
pipeline-error-anyscale-503-server-overloaded-error,
pipeline-error-anyscale-llm-failed,
call.in-progress.error-cozmoxfault-anyscale-llm-failed,
call.in-progress.error-cozmoxfault-anyscale-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-anyscale-401-unauthorized,
call.in-progress.error-cozmoxfault-anyscale-403-model-access-denied,
call.in-progress.error-cozmoxfault-anyscale-429-exceeded-quota,
call.in-progress.error-providerfault-anyscale-500-server-error,
call.in-progress.error-providerfault-anyscale-503-server-overloaded-error,
pipeline-error-openrouter-400-bad-request-validation-failed,
pipeline-error-openrouter-401-unauthorized,
pipeline-error-openrouter-403-model-access-denied,
pipeline-error-openrouter-429-exceeded-quota,
pipeline-error-openrouter-500-server-error,
pipeline-error-openrouter-503-server-overloaded-error,
pipeline-error-openrouter-llm-failed,
call.in-progress.error-cozmoxfault-openrouter-llm-failed,
call.in-progress.error-cozmoxfault-openrouter-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-openrouter-401-unauthorized,
call.in-progress.error-cozmoxfault-openrouter-403-model-access-denied,
call.in-progress.error-cozmoxfault-openrouter-429-exceeded-quota,
call.in-progress.error-providerfault-openrouter-500-server-error,
call.in-progress.error-providerfault-openrouter-503-server-overloaded-error,
pipeline-error-perplexity-ai-400-bad-request-validation-failed,
pipeline-error-perplexity-ai-401-unauthorized,
pipeline-error-perplexity-ai-403-model-access-denied,
pipeline-error-perplexity-ai-429-exceeded-quota,
pipeline-error-perplexity-ai-500-server-error,
pipeline-error-perplexity-ai-503-server-overloaded-error,
pipeline-error-perplexity-ai-llm-failed,
call.in-progress.error-cozmoxfault-perplexity-ai-llm-failed,
call.in-progress.error-cozmoxfault-perplexity-ai-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-perplexity-ai-401-unauthorized,
call.in-progress.error-cozmoxfault-perplexity-ai-403-model-access-denied,
call.in-progress.error-cozmoxfault-perplexity-ai-429-exceeded-quota,
call.in-progress.error-providerfault-perplexity-ai-500-server-error,
call.in-progress.error-providerfault-perplexity-ai-503-server-overloaded-error,
pipeline-error-deepinfra-400-bad-request-validation-failed,
pipeline-error-deepinfra-401-unauthorized,
pipeline-error-deepinfra-403-model-access-denied,
pipeline-error-deepinfra-429-exceeded-quota,
pipeline-error-deepinfra-500-server-error,
pipeline-error-deepinfra-503-server-overloaded-error,
pipeline-error-deepinfra-llm-failed,
call.in-progress.error-cozmoxfault-deepinfra-llm-failed,
call.in-progress.error-cozmoxfault-deepinfra-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-deepinfra-401-unauthorized,
call.in-progress.error-cozmoxfault-deepinfra-403-model-access-denied,
call.in-progress.error-cozmoxfault-deepinfra-429-exceeded-quota,
call.in-progress.error-providerfault-deepinfra-500-server-error,
call.in-progress.error-providerfault-deepinfra-503-server-overloaded-error,
pipeline-error-runpod-400-bad-request-validation-failed,
pipeline-error-runpod-401-unauthorized,
pipeline-error-runpod-403-model-access-denied,
pipeline-error-runpod-429-exceeded-quota,
pipeline-error-runpod-500-server-error,
pipeline-error-runpod-503-server-overloaded-error,
pipeline-error-runpod-llm-failed,
call.in-progress.error-cozmoxfault-runpod-llm-failed,
call.in-progress.error-cozmoxfault-runpod-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-runpod-401-unauthorized,
call.in-progress.error-cozmoxfault-runpod-403-model-access-denied,
call.in-progress.error-cozmoxfault-runpod-429-exceeded-quota,
call.in-progress.error-providerfault-runpod-500-server-error,
call.in-progress.error-providerfault-runpod-503-server-overloaded-error,
pipeline-error-custom-llm-400-bad-request-validation-failed,
pipeline-error-custom-llm-401-unauthorized,
pipeline-error-custom-llm-403-model-access-denied,
pipeline-error-custom-llm-429-exceeded-quota,
pipeline-error-custom-llm-500-server-error,
pipeline-error-custom-llm-503-server-overloaded-error,
pipeline-error-custom-llm-llm-failed,
call.in-progress.error-cozmoxfault-custom-llm-llm-failed,
call.in-progress.error-cozmoxfault-custom-llm-400-bad-request-validation-failed,
call.in-progress.error-cozmoxfault-custom-llm-401-unauthorized,
call.in-progress.error-cozmoxfault-custom-llm-403-model-access-denied,
call.in-progress.error-cozmoxfault-custom-llm-429-exceeded-quota,
call.in-progress.error-providerfault-custom-llm-500-server-error,
call.in-progress.error-providerfault-custom-llm-503-server-overloaded-error,
pipeline-error-custom-voice-failed,
pipeline-error-cartesia-socket-hang-up,
pipeline-error-cartesia-requested-payment,
pipeline-error-cartesia-500-server-error,
pipeline-error-cartesia-502-server-error,
pipeline-error-cartesia-503-server-error,
pipeline-error-cartesia-522-server-error,
call.in-progress.error-cozmoxfault-cartesia-socket-hang-up,
call.in-progress.error-cozmoxfault-cartesia-requested-payment,
call.in-progress.error-providerfault-cartesia-500-server-error,
call.in-progress.error-providerfault-cartesia-503-server-error,
call.in-progress.error-providerfault-cartesia-522-server-error,
pipeline-error-eleven-labs-voice-not-found,
pipeline-error-eleven-labs-quota-exceeded,
pipeline-error-eleven-labs-unauthorized-access,
pipeline-error-eleven-labs-unauthorized-to-access-model,
pipeline-error-eleven-labs-professional-voices-only-for-creator-plus,
pipeline-error-eleven-labs-blocked-free-plan-and-requested-upgrade,
pipeline-error-eleven-labs-blocked-concurrent-requests-and-requested-upgrade,
pipeline-error-eleven-labs-blocked-using-instant-voice-clone-and-requested-upgrade,
pipeline-error-eleven-labs-system-busy-and-requested-upgrade,
pipeline-error-eleven-labs-voice-not-fine-tuned,
pipeline-error-eleven-labs-invalid-api-key,
pipeline-error-eleven-labs-invalid-voice-samples,
pipeline-error-eleven-labs-voice-disabled-by-owner,
pipeline-error-eleven-labs-cozmox-voice-disabled-by-owner,
pipeline-error-eleven-labs-blocked-account-in-probation,
pipeline-error-eleven-labs-blocked-content-against-their-policy,
pipeline-error-eleven-labs-missing-samples-for-voice-clone,
pipeline-error-eleven-labs-voice-not-fine-tuned-and-cannot-be-used,
pipeline-error-eleven-labs-voice-not-allowed-for-free-users,
pipeline-error-eleven-labs-max-character-limit-exceeded,
pipeline-error-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification,
pipeline-error-eleven-labs-500-server-error,
pipeline-error-eleven-labs-503-server-error,
call.in-progress.error-cozmoxfault-eleven-labs-voice-not-found,
call.in-progress.error-cozmoxfault-eleven-labs-quota-exceeded,
call.in-progress.error-cozmoxfault-eleven-labs-unauthorized-access,
call.in-progress.error-cozmoxfault-eleven-labs-unauthorized-to-access-model,
call.in-progress.error-cozmoxfault-eleven-labs-professional-voices-only-for-creator-plus,
call.in-progress.error-cozmoxfault-eleven-labs-blocked-free-plan-and-requested-upgrade,
call.in-progress.error-cozmoxfault-eleven-labs-blocked-concurrent-requests-and-requested-upgrade,
call.in-progress.error-cozmoxfault-eleven-labs-blocked-using-instant-voice-clone-and-requested-upgrade,
call.in-progress.error-cozmoxfault-eleven-labs-system-busy-and-requested-upgrade,
call.in-progress.error-cozmoxfault-eleven-labs-voice-not-fine-tuned,
call.in-progress.error-cozmoxfault-eleven-labs-invalid-api-key,
call.in-progress.error-cozmoxfault-eleven-labs-invalid-voice-samples,
call.in-progress.error-cozmoxfault-eleven-labs-voice-disabled-by-owner,
call.in-progress.error-cozmoxfault-eleven-labs-blocked-account-in-probation,
call.in-progress.error-cozmoxfault-eleven-labs-blocked-content-against-their-policy,
call.in-progress.error-cozmoxfault-eleven-labs-missing-samples-for-voice-clone,
call.in-progress.error-cozmoxfault-eleven-labs-voice-not-fine-tuned-and-cannot-be-used,
call.in-progress.error-cozmoxfault-eleven-labs-voice-not-allowed-for-free-users,
call.in-progress.error-cozmoxfault-eleven-labs-max-character-limit-exceeded,
call.in-progress.error-cozmoxfault-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification,
call.in-progress.error-providerfault-eleven-labs-500-server-error,
call.in-progress.error-providerfault-eleven-labs-503-server-error,
pipeline-error-playht-request-timed-out,
pipeline-error-playht-invalid-voice,
pipeline-error-playht-unexpected-error,
pipeline-error-playht-out-of-credits,
pipeline-error-playht-invalid-emotion,
pipeline-error-playht-voice-must-be-a-valid-voice-manifest-uri,
pipeline-error-playht-401-unauthorized,
pipeline-error-playht-403-forbidden-out-of-characters,
pipeline-error-playht-403-forbidden-api-access-not-available,
pipeline-error-playht-429-exceeded-quota,
pipeline-error-playht-502-gateway-error,
pipeline-error-playht-504-gateway-error,
call.in-progress.error-cozmoxfault-playht-request-timed-out,
call.in-progress.error-cozmoxfault-playht-invalid-voice,
call.in-progress.error-cozmoxfault-playht-unexpected-error,
call.in-progress.error-cozmoxfault-playht-out-of-credits,
call.in-progress.error-cozmoxfault-playht-invalid-emotion,
call.in-progress.error-cozmoxfault-playht-voice-must-be-a-valid-voice-manifest-uri,
call.in-progress.error-cozmoxfault-playht-401-unauthorized,
call.in-progress.error-cozmoxfault-playht-403-forbidden-out-of-characters,
call.in-progress.error-cozmoxfault-playht-403-forbidden-api-access-not-available,
call.in-progress.error-cozmoxfault-playht-429-exceeded-quota,
call.in-progress.error-providerfault-playht-502-gateway-error,
call.in-progress.error-providerfault-playht-504-gateway-error,
pipeline-error-custom-transcriber-failed,
call.in-progress.error-cozmoxfault-custom-transcriber-failed,
pipeline-error-eleven-labs-transcriber-failed,
call.in-progress.error-cozmoxfault-eleven-labs-transcriber-failed,
pipeline-error-deepgram-returning-400-no-such-model-language-tier-combination,
pipeline-error-deepgram-returning-401-invalid-credentials,
pipeline-error-deepgram-returning-403-model-access-denied,
pipeline-error-deepgram-returning-404-not-found,
pipeline-error-deepgram-returning-500-invalid-json,
pipeline-error-deepgram-returning-502-network-error,
pipeline-error-deepgram-returning-502-bad-gateway-ehostunreach,
pipeline-error-deepgram-returning-econnreset,
call.in-progress.error-cozmoxfault-deepgram-returning-400-no-such-model-language-tier-combination,
call.in-progress.error-cozmoxfault-deepgram-returning-401-invalid-credentials,
call.in-progress.error-cozmoxfault-deepgram-returning-404-not-found,
call.in-progress.error-cozmoxfault-deepgram-returning-403-model-access-denied,
call.in-progress.error-providerfault-deepgram-returning-500-invalid-json,
call.in-progress.error-providerfault-deepgram-returning-502-network-error,
call.in-progress.error-providerfault-deepgram-returning-502-bad-gateway-ehostunreach,
pipeline-error-google-transcriber-failed,
call.in-progress.error-cozmoxfault-google-transcriber-failed,
pipeline-error-openai-transcriber-failed,
call.in-progress.error-cozmoxfault-openai-transcriber-failed,
assistant-ended-call,
assistant-said-end-call-phrase,
assistant-ended-call-with-hangup-task,
assistant-ended-call-after-message-spoken,
assistant-forwarded-call,
assistant-join-timed-out,
call.in-progress.error-assistant-did-not-receive-customer-audio,
call.in-progress.error-transfer-failed,
customer-busy,
customer-ended-call,
customer-did-not-answer,
customer-did-not-give-microphone-permission,
exceeded-max-duration,
manually-canceled,
phone-call-provider-closed-websocket,
call.forwarding.operator-busy,
silence-timed-out,
call.in-progress.error-sip-inbound-call-failed-to-connect,
call.in-progress.error-providerfault-outbound-sip-403-forbidden,
call.in-progress.error-providerfault-outbound-sip-407-proxy-authentication-required,
call.in-progress.error-providerfault-outbound-sip-503-service-unavailable,
call.in-progress.error-providerfault-outbound-sip-480-temporarily-unavailable,
call.in-progress.error-sip-outbound-call-failed-to-connect,
call.ringing.hook-executed-say,
call.ringing.hook-executed-transfer,
call.ringing.sip-inbound-caller-hungup-before-call-connect,
call.ringing.error-sip-inbound-call-failed-to-connect,
twilio-failed-to-connect-call,
twilio-reported-customer-misdialed,
vonage-rejected,
voicemail
destination
NumberTransferDestination · object

This is the destination where the call ended up being transferred to. If the call was not transferred, this will be empty.

startedAt
string<date-time>

This is the ISO 8601 date-time string of when the call was started.

endedAt
string<date-time>

This is the ISO 8601 date-time string of when the call was ended.

cost
number

This is the cost of the call in USD.

costBreakdown
object

This is the cost of the call in USD.

artifactPlan
object

This is a copy of assistant artifact plan. This isn't actually stored on the call but rather just returned in POST /call/web to enable artifact creation client side.

analysis
object

This is the analysis of the call. Configure in assistant.analysisPlan.

monitor
object

This is to real-time monitor the call. Configure in assistant.monitorPlan.

artifact
object

These are the artifacts created from the call. Configure in assistant.artifactPlan.

phoneCallProviderId
string
deprecated

The ID of the call as provided by the phone number service. callSid in Twilio. conversationUuid in Vonage. callControlId in Telnyx.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

campaignId
string

This is the campaign ID that the call belongs to.

assistantId
string

This is the assistant ID that will be used for the call. To use a transient assistant, use assistant instead.

To start a call with:

  • Assistant, use assistantId or assistant
  • Squad, use squadId or squad
  • Workflow, use workflowId or workflow
assistant
object

This is the assistant that will be used for the call. To use an existing assistant, use assistantId instead.

To start a call with:

  • Assistant, use assistant
  • Squad, use squad
  • Workflow, use workflow
assistantOverrides
object

These are the overrides for the assistant or assistantId's settings and template variables.

squadId
string

This is the squad that will be used for the call. To use a transient squad, use squad instead.

To start a call with:

  • Assistant, use assistant or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
squad
object

This is a squad that will be used for the call. To use an existing squad, use squadId instead.

To start a call with:

  • Assistant, use assistant or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
workflowId
string

This is the workflow that will be used for the call. To use a transient workflow, use workflow instead.

To start a call with:

  • Assistant, use assistant or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
workflow
object

This is a workflow that will be used for the call. To use an existing workflow, use workflowId instead.

To start a call with:

  • Assistant, use assistant or assistantId
  • Squad, use squad or squadId
  • Workflow, use workflow or workflowId
workflowOverrides
object

These are the overrides for the workflow or workflowId's settings and template variables.

phoneNumberId
string

This is the phone number that will be used for the call. To use a transient number, use phoneNumber instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

phoneNumber
object

This is the phone number that will be used for the call. To use an existing number, use phoneNumberId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customerId
string

This is the customer that will be called. To call a transient customer , use customer instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

customer
object

This is the customer that will be called. To call an existing customer, use customerId instead.

Only relevant for outboundPhoneCall and inboundPhoneCall type.

name
string

This is the name of the call. This is just for your own reference.

Maximum string length: 40
schedulePlan
object

This is the schedule plan of the call.

transport
object

This is the transport of the call.