Skip to main content
POST
Customize Study Plan

Authorizations

Authorization
string
header
required

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

Path Parameters

study_id
string
required

Body

application/json

One user turn for the stateful Customize Plan conversation.

message
string
required
Required string length: 1 - 20000
concept_image
PublicCustomizeConceptImage · object | null

Optional native concept-image attachment for this turn. The backend validates, stores, and makes it available to Customize Plan.

Response

Successful Response

The next Customize Plan message plus the study's resulting state.

message
string
required
response_type
enum<string>
required
Available options:
question,
message,
study_plan
conversation_id
string
required
study
PublicStudySummary · object
required

Lightweight study shape returned by the list endpoint (heavy fields such as the study plan and screener questions are stripped — fetch by id).