Docs
Open dashboard

Create web call

POST/calls/web/{agent_id}

Starts a browser-based call with the agent named in the path and returns what that agent's provider SDK needs to join it. No request body. The response shape follows provider. For an inspra agent a fresh LiveKit room is minted with the Inspra voice worker dispatched into it; join with token, room, wsUrl and identity. For a vapi agent the response carries the integration's public key (public_key, also echoed as token) and the VAPI assistant id (external_agent_id); pass both to the VAPI Web SDK. For a retell agent it carries a per-call access_token and call_id minted by Retell; pass the token to the Retell Web SDK. VAPI and Retell agents must already be synced with their provider and have an integration with the right key (a public key for VAPI, a secret key for Retell), or the request is rejected with 400. Any other provider returns 422 unprocessable.

Requires Authorization: Bearer <api_key>. Create a key in the Inspra dashboard under Workspace Settings → API Keys.

Path parameters

  • agent_idstringrequired
    UUID of the agent to start the web call with (Inspra, VAPI or Retell).

Response 201 Created

Web call session ready.

Errors

  • 401Unauthorized
    Missing, malformed, or invalid API key.
  • 403Forbidden
    Workspace unavailable, suspended, or paywalled.
  • 404Not Found
    Resource not found in this workspace.
  • 422Unprocessable Entity
    Semantically invalid (well-formed but unprocessable for this resource).
  • 429Too Many Requests
    Workspace request limit exceeded; shared across all its API keys.
  • 502Bad Gateway
    Upstream voice provider failure.