Skip to main content
POST

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

X-UI-Organization-ID
string | null

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

Path Parameters

study_id
string
required
call_id
string
required

Body

application/json
permissions
enum<string>[]

Defaults to observe, steer, and end. Pass [observe] explicitly for view-only access. A read-scoped key can grant all observer capabilities.

Required array length: 1 - 3 elements
Available options:
observe,
steer,
end
expires_in_seconds
integer
default:900
Required range: 60 <= x <= 3600

Response

Successful Response

id
string
required
observer_url
string
required

Short-lived bearer link to the User Intuition observer page. Share only with authorized observers.

expires_at
string<date-time>
required
permissions
enum<string>[]
required
Available options:
observe,
steer,
end