simulate

Update the status of a specific call execution

patch/simulate/call-executions/{call_execution_id}/

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/simulate/call-executions/{call_execution_id}/
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in header X-Secret-Key

Request body

status'pending' | 'queued' | 'ongoing' | 'completed' | 'failed' | 'analyzing' | 'cancelled' required
ended_reasonstring nullable

Response

OK

idstring uuid
phone_numberstring nullable

Phone number called (null for TEXT/chat simulations)

service_provider_call_idstring
status'pending' | 'queued' | 'ongoing' | 'completed' | 'failed' | 'analyzing' | 'cancelled'

Current status of the call

started_atstring date-time nullable

When the call started

completed_atstring date-time nullable

When the call completed

duration_secondsinteger nullable

Duration of the call in seconds

recording_urlstring uri nullable

URL to the call recording

cost_centsinteger nullable

Cost of the call in cents

call_metadataobject

Additional metadata about the call

error_messagestring nullable

Error message if the call failed

scenario_namestring
transcriptsstring
created_atstring date-time
updated_atstring date-time
provider_call_dataobject nullable

Complete call data from the provider. Format: dict[provider_name, data] where provider_name must be from SupportedProviders

stereo_recording_urlstring uri nullable

Stereo recording URL from Vapi

ended_reasonstring nullable

Reason why the call ended

stt_cost_centsinteger nullable

STT cost in cents

llm_cost_centsinteger nullable

LLM cost in cents

tts_cost_centsinteger nullable

TTS cost in cents

overall_scorenumber nullable

Overall call performance score

response_time_msinteger nullable

Average response time in milliseconds

response_time_secondsstring
assistant_idstring nullable

Assistant ID used for the call (system side)

customer_numberstring nullable

Customer phone number (E.164 format)

call_typestring nullable

Type of call (e.g., outboundPhoneCall)

ended_atstring date-time nullable

When the call ended

analysis_dataobject nullable

Call analysis data from the service provider

evaluation_dataobject nullable

Call evaluation data from the service provider

message_countinteger nullable

Number of messages in the call

transcript_availableboolean

Whether transcript is available

recording_availableboolean

Whether recording is available

eval_outputsobject nullable

Evaluation output

call_summarystring nullable

Call summary from the service

agent_versionstring uuid nullable
customer_cost_centsinteger nullable

Total customer-reported cost in cents

system_metricsstring
cost_breakdownstring
customer_call_idstring nullable

Customer call ID if available

simulation_call_type'voice' | 'text'

Type of simulation call

processing_skippedstring
processing_skip_reasonstring

Changes

No recorded changes to this operation across all 1 revision of this API.