Studies

Queue a study export

Queue any supported study export in the background processor. Poll getStudyExportStatus with the returned job ID and download the storage-backed artifact when complete.

post/api/v1/studies/{studyId}/export

Request

  • Base URL: https://api.getminds.ai
  • URL: https://api.getminds.ai/api/v1/studies/{studyId}/export
  • Auth: HTTP bearer

Path parameters

studyIdstring uuid required

Study UUID.

Request body

kind'executive_brief' | 'full_report' | 'raw_data'
format'pdf' | 'md' | 'docx' | 'pptx' | 'csv' | 'xls' | 'sav'
length'short' | 'standard' | 'detailed'
forceboolean
scheduledRunIdstring uuid

Response

Export queued.

Changes

No recorded changes to this operation across all 1 revision of this API.