Skip to main content
POST
/
v1
/
calls
Create Call
curl --request POST \
  --url https://api.example.com/v1/calls \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent_id": "<string>",
  "tags": {},
  "livekit_username": "User"
}
'
{
  "id": "<string>",
  "agent_id": "<string>",
  "started_at": "<string>",
  "ended_at": "<string>",
  "livekit_url": "<string>",
  "livekit_token": "<string>",
  "tags": {}
}

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Body

application/json

Request body to create a call.

agent_id
string
required

ID of agent managing the call.

tags
Tags · object

Tags for the call

livekit_username
string
default:User

Display name of user in the LiveKit room.

Minimum string length: 1

Response

Created Call with ID and LiveKit connection details.

Response model for a call including LiveKit connection details.

id
string
required

Unique identifier of the object in the database.

Example:

"01234567-89ab-cdef-0123-456789abcdef"

agent_id
string
required

ID of agent managing the call.

started_at
string
required

Start time in ISO 8601 format.

ended_at
string | null
required

End time in ISO 8601 format. If null, call might still be ongoing.

livekit_url
string
required

LiveKit server URL to connect to.

livekit_token
string
required

JWT for joining the LiveKit room.

tags
Tags · object

Tags for the call