Skip to main content
POST
Generate Report

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

Response

Successful Response

study_id
string
required

The study this report was generated for

report
string | null

Rendered report (the references section is moved to references)

references
PublicReportReference · object[]
interview_count
integer
default:0

Number of interviews included in the report

is_stale
boolean | null

True if the report's inputs drifted since it was generated (regenerate to refresh); None = unknown

created_at
string<date-time> | null
updated_at
string<date-time> | null