Research Studies

Preview or write Research Study export artifacts to GitHub through the optional writeback app.

Requires commentary.research.write, the research.studies.github_export license feature, the optional GitHub writeback app, an installed repository target, and signed-in write permission to the target repository. Writes JSON and Markdown export files in one commit when action=writeback.

post/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.

Headers

X-Commentary-Workspace-Idstring

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

X-Correlation-Idstring

Request body

action'preview_writeback' | 'writeback'
targetobject
commitMessagestring
openPullRequestboolean
pullRequestTitlestring
pullRequestBodystring

Response

Successful response.

object required

Changes

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