Skip to main content
POST
Create Launch Session

Authorizations

Authorization
string
header
required

Opaque partner access token (pat_...) issued by POST /v1/partner/oauth/token. Access tokens last 1 hour; refresh with the 90-day refresh token.

Headers

Idempotency-Key
string
required

Unique key per logical session (for example a UUID). Enables safe retries.

Body

application/json
external_client_id
string
required

Your platform's ID for the client. Used to remember the client mapping across sessions on this connection.

Required string length: 1 - 255
clinician_email
string
required

Must match the verified email of exactly one member of the connected practice. Matching is case-insensitive.

Required string length: 3 - 320
client_first_name
string | null

Shown to the clinician when mapping the client for the first time.

Maximum string length: 255
client_last_name
string | null

Shown to the clinician when mapping the client for the first time.

Maximum string length: 255

Response

Session created (or the existing session for a repeated Idempotency-Key).

session_id
string
required
status
enum<string>
required
Available options:
created,
opened,
completed,
expired
launch_url
string
required

Open this URL for the assigned clinician to write the report in Everbility.

expires_at
string<date-time>
required

Sessions expire 48 hours after creation if not completed.