Skip to main content
POST
Create session (REQUESTED)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-lx-consistency-token
string

Body

application/json
lat
number
required
Example:

4.66

lng
number
required
Example:

-74.05

maxDurationSeconds
number
required

Upper bound on session duration in seconds.

Example:

600

workspaceId
string

Optional — defaults to the caller's workspace; required for wallet sessions if it disagrees.

Example:

"8c3a5b6f-1d2e-4f7a-9b8c-d1e2f3a4b5c6"

waitTimeoutSeconds
number

Seconds the consumer is willing to wait for media to start. After created_at + waitTimeoutSeconds with no first decoded frame, the session transitions to EXPIRED without a meter or settlement. Independent of maxDurationSeconds. Must satisfy 5 ≤ n ≤ 3600. Defaults to 300 (5 minutes).

Example:

300

quoteId
string

Optional pre-fetched LxPriceQuote id to lock the rate.

Example:

"a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

Response

Request successful

statusCode
number
required
Example:

200

message
string
required
Example:

"Request successful"

data
object
required

Endpoint-specific payload. See the per-endpoint schema.

timestamp
string
required
Example:

"2026-05-13T12:00:00.000Z"