Skip to main content
POST
Start Session

Authorizations

Authorization
string
header
required

A personal access token (haico_pat_...), created under Profile → API keys. Send it as Authorization: Bearer <key>. The browser session JWT is also accepted but is an internal mechanism and is not part of the public contract.

Body

application/json

Begin or resume the caller's study session.

study_code
string | null
Maximum string length: 64
participant_code
string | null
Maximum string length: 32

Response

Successful Response

The session plus the responses submitted so far (drives resume/progress).

session
StudySessionSchema · object
required

A study session as returned to the participant.

responses
SurveyResponseSchema · object[]
required