Create Call
Creates a new call using the specified system prompt and other properties
Authorizations
API key
Query Parameters
The UUID of a prior call. When specified, the new call will use the same properites as the prior call unless overriden in this request's body. The new call will also use the prior call's message history as its own initial_messages. (It's illegal to also set initial_messages in the body.)
Body
A request to start a call.
Who should talk first when the call starts. Typically set to FIRST_SPEAKER_USER for outgoing
calls and left as the default (FIRST_SPEAKER_AGENT) otherwise.
Deprecated. Prefer firstSpeakerSettings
. If both are set, they must match.
FIRST_SPEAKER_UNSPECIFIED
, FIRST_SPEAKER_AGENT
, FIRST_SPEAKER_USER
The settings for the initial message to get a conversation started.
Defaults to agent: {}
which means the agent will start the conversation with an
(interruptible) greeting generated based on the system prompt and any initial messages.
(If first_speaker is set and this is not, first_speaker will be used instead.)
Messages spoken by the agent when the user is inactive for the specified duration. Durations are cumulative, so a message m > 1 with duration 30s will be spoken 30 seconds after message m-1.
The conversation history to start from for this call.
The medium to use for the call initially. May be altered by the client later. Defaults to voice.
MESSAGE_MEDIUM_UNSPECIFIED
, MESSAGE_MEDIUM_VOICE
, MESSAGE_MEDIUM_TEXT
A timeout for joining the call. Defaults to 30 seconds.
A BCP47 language code that may be used to guide speech recognition and synthesis.
The maximum duration of the call. Defaults to 1 hour.
The medium used for this call.
The model used for generations. Defaults to fixie-ai/ultravox.
Whether the call should be recorded.
The tools available to the agent for (the first stage of) this call.
The system prompt provided to the model during generations.
The model temperature, between 0 and 1. Defaults to 0.
What the agent should say immediately before hanging up if the call's time limit is reached.
Indicates whether a transcript is optional for the call.
VAD settings for the call.
The ID (or name if unique) of the voice the agent should use for this call.
Response
The version of the client that joined this call.
The reason the call ended.
unjoined
- Client never joinedhangup
- Client hung upagent_hangup
- Agent hung uptimeout
- Call timed outconnection_error
- Connection error
unjoined
, hangup
, agent_hangup
, timeout
, connection_error
The number of errors in this call.
Who was supposed to talk first when the call started. Typically set to FIRST_SPEAKER_USER for outgoing calls and left as the default (FIRST_SPEAKER_AGENT) otherwise.
FIRST_SPEAKER_AGENT
, FIRST_SPEAKER_USER
Settings for the initial message to get the call started.
The medium used initially by the agent. May later be changed by the client.
MESSAGE_MEDIUM_VOICE
, MESSAGE_MEDIUM_TEXT
A short summary of the call.
A summary of the call.
Messages spoken by the agent when the user is inactive for the specified duration. Durations are cumulative, so a message m > 1 with duration 30s will be spoken 30 seconds after message m-1.
BCP47 language code that may be used to guide speech recognition.
16
Details about a call's protocol. By default, calls occur over WebRTC using the Ultravox client SDK. Setting a different call medium will prepare the server for a call using a different protocol. At most one call medium may be set.
0 < x < 1
Indicates whether a transcript is optional for the call.
VAD settings for the call.