POST
Create Stream Connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agent_id
string<uuid>
required

The published voice agent that answers on this connection.

dialect
enum<string>
required

Which platform's WebSocket protocol this partner speaks. One of sparktg, twilio, plivo, exotel, vonage.

Available options:
twilio,
sparktg,
plivo,
exotel,
vonage
name
string
required

What this partner integration is called in the dashboard.

Required string length: 1 - 120
region
enum<string>
default:us

Where calls are hosted; it decides the URL.

Available options:
us,
in

Response

Successful Response

One connection, as a caller sees it.

url is the whole configuration a partner needs, in full, on every read: it carries no credential, so there is nothing here to mask and nothing to show once and never again.

agent_id
string<uuid>
required
agent_name
string | null
required
created_at
string<date-time>
required
dialect
enum<string>
required
Available options:
twilio,
sparktg,
plivo,
exotel,
vonage
id
string<uuid>
required
name
string
required
readiness
enum<string>
required
Available options:
live,
needs_agent,
disabled
region
enum<string>
required
Available options:
us,
in
status
enum<string>
required
Available options:
active,
disabled
updated_at
string<date-time>
required
url
string
required