Research Studies

Export Research Study results as structured JSON or report-friendly Markdown.

Structured and Markdown exports include study metadata, session metadata, event timelines, comments and replies, form responses, agent interventions, stable empty findings/report sections, and evidence references. GitHub write capability is not required for read exports.

get/api/v1/research-studies/{studyId}/export

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/research-studies/{studyId}/export
  • Auth: HTTP bearer

Path parameters

studyIdstring required

Research Study id.

Query parameters

format'json' | 'markdown'
action'export' | 'status'

Headers

X-Commentary-Workspace-Idstring

Must match the credential workspace. This header cannot widen grant authority.

X-Correlation-Idstring

Response

Successful response.

object required

Changes

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