Skip to main content
POST
/
v1
/
calls
/
web
Create Web Call
curl --request POST \
  --url https://api.oneinbox.ai/v1/calls/web \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "variables": {},
  "overrides": {
    "llm": {
      "model": "<string>",
      "temperature": 123,
      "system_prompt": "<string>"
    },
    "transcriber": {
      "model": "<string>",
      "language": "<string>"
    },
    "tts": {
      "voice_id": "<string>",
      "model": "<string>",
      "speed": 123,
      "stability": 123
    },
    "first_message": "<string>"
  },
  "metadata": {}
}
'
{
  "id": "<string>",
  "agent_id": "<string>",
  "type": "<string>",
  "status": "<string>",
  "room_name": "<string>",
  "server_url": "<string>",
  "participant_token": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Your API key sent as a Bearer credential — Authorization: Bearer <api_key>, where <api_key> starts with oi_sk_ (create one via POST /v1/api-keys). Although the field is labelled 'token', paste your API key here. A dashboard JWT is also accepted on this header for the same endpoints.

Body

application/json
agent_id
string<uuid>
required
variables
Variables · object
overrides
CallOverrides · object

Per-call overrides — merged on top of the agent's stored config at dispatch.

metadata
Metadata · object

Response

Successful Response

id
string
required
agent_id
string
required
type
string
required
status
string
required
room_name
string
required
server_url
string
required
participant_token
string
required
created_at
string<date-time>
required