Initiate WebRTC Call

Creates a session and dispatches an AI agent for a WebRTC voice call. Returns connection credentials that work seamlessly with our Vonative client SDKs. This is the WebRTC equivalent of dialing a phone number, it connects the caller directly to an agent for browser/mobile voice.

Endpoint

Request Body

assistant_id
string
required
The UUID of the assistant to dispatch.
client_type
string
The platform of the connecting client. (web, mobile, terminal). Defaults to web.
reconnectable
boolean
Whether the call allows reconnecting after a drop. Defaults to false.
metadata
object
Custom metadata to pass to the agent.
variable_values
object
Variables for prompt templating (e.g. {"name": "John"}).

Authentication

(Optionally use the X-Vonative-Api-Key header)

Example Request

Response

Response Fields

Using the response with @vonative/react

For a complete walkthrough, see the Web Quickstart.

Reconnect to a Call

Returns a fresh scoped token for an existing call if it was created with reconnectable: true.

End session

Errors

See also