Skip to main content
POST
Create Study With Participants

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string | null
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

Body

application/json

Create a ready BYOP study and its participants in one request.

study
PublicByopStudyCreate · object
required

Create fields for a BYOP study together with its participants.

participants
PublicParticipantInviteInput · object[]
required
Required array length: 1 - 100 elements

Response

Successful Response

study
PublicStudy · object
required

Full study shape returned by get-by-id (includes the heavy fields).

participants
PublicParticipant · object[]
required