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

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

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.

Access

Use a credential with commentary.research.write.

Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. Set up developer access.

Parameters

Name	Location	Type	Required	Description
`studyId`	path	string	Yes	Research Study id.
`X-Commentary-Workspace-Id`	header	string	No	Must match the credential workspace. This header cannot widen grant authority.
`X-Correlation-Id`	header	string	No

Request body

Required. Supported content types: application/json.

Field	Type	Required
`action`	`"preview_writeback"` · `"writeback"`	No
`target`	object	No
`commitMessage`	string	No
`openPullRequest`	boolean	No
`pullRequestTitle`	string	No
`pullRequestBody`	string	No

Call the endpoint

Replace path placeholders and your credential. For body operations, create request.json using the required fields above; this command does not invent resource identifiers or consent.

curl --request POST \
  'https://commentary.dev/api/v1/research-studies/<studyId>/export' \
  --header 'Authorization: Bearer <your-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

Status	Meaning	Payload
`200`	Successful response.	object
`202`	Successful response.	object
`400`	The request was invalid.	ExternalError
`401`	Authentication is required.	ExternalError
`403`	The token or session does not have permission for this resource.	ExternalError
`404`	The resource was not found.	ExternalError
`429`	The request was rate limited.	ExternalError

Successful response fields

Value type: object.

Recover from errors

Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.

Operation ID: writeResearchStudyExport. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.