Skip to main content
POST
/
api
/
v1
/
connection
/
connection-details
Connection Details
curl --request POST \
  --url https://dev.voice.ai/api/v1/connection/connection-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "<string>",
  "dynamic_variables": {},
  "agent_overrides": {
    "tts_params": {
      "voice_id": "<string>",
      "model": "voiceai-tts-v1-latest",
      "language": "en",
      "temperature": 1,
      "top_p": 0.8,
      "dictionary_id": "<string>"
    }
  }
}
'
{
  "server_url": "<string>",
  "participant_token": "<string>",
  "call_id": "<string>",
  "end_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Use your API key as the bearer token. Format: Authorization: Bearer

Body

application/json
​
agent_id
string | null

For saved agents

​
dynamic_variables
DynamicVariables · object

Optional runtime dynamic variables as a flat object of string, number, or boolean values

​
agent_overrides
RuntimeAgentConfigOverrides · object

Optional runtime config overrides. Supports a limited AgentConfig-shaped subset under agent_overrides.

Response

Successful Response

​
server_url
string
required
​
participant_token
string
required
​
call_id
string
required
​
end_token
string | null

Scoped token for ending this call. Pass to /calls/{call_id}/end to immediately free the concurrency slot.