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 the browser needs to join it. No request body. A fresh LiveKit room is minted with the Inspra voice worker dispatched into it; join with token, room, wsUrl and identity. An agent on a runtime that does not support web calls returns 422 unprocessable.

Requires Authorization: Bearer <api_key>. Create a key under Configuration → General → API Keys.

Path parameters

  • agent_idstringrequired
    UUID of the agent to start the web call with.

Response 201 Created

Web call session ready.

  • successbooleanrequired
    Always true when the API returned 201. Errors surface as 4xx/5xx with the Error envelope.
    true
  • providerstringrequired
    inspra
  • agent_idstringuuidrequired
    The agent the call is with.
  • tokenstringrequired
    LiveKit access token (JWT). The browser passes this to the LiveKit client to join the room.
  • roomstringrequired
    Unique LiveKit room name in the form web-{workspaceId}!{agentId}!{8-hex}. The frontend subscribes to this exact room.
  • identitystringrequired
    LiveKit participant identity for the human caller.
  • wsUrlstringrequired
    LiveKit WebSocket URL the browser connects to.

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.