Start a live session

POST

/api/live/session/start

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

or

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Live session started

Body

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://my.xentree.com/api/live/session/start' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "session_type": "voice"
}'

Response Example

200 - Example 1

{
    "session_id": 0,
    "live_seconds_remaining": 0,
    "live_monthly_limit_seconds": 0,
    "nickname": "string"
}

Modified at 2026-04-17 06:07:00

Get remaining Xentree Live quota

Update an active live session heartbeat