Research Studies

Submit an evidence-linked Research Study finding or report.

Supports action=submit_finding and action=upsert_report. Requires commentary.research.write, the research.studies.agent_api feature, and study external-agent settings that allow findings or reports. Suggested issue text is stored and exported only; this endpoint does not create GitHub issues.

post/api/v1/research-studies/{studyId}

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/research-studies/{studyId}
  • 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'submit_finding' | 'upsert_report' required
titlestring
summarystring
severitystring
confidencestring
markdownstring
sectionsobject
evidenceReferencesobject[]

Response

Successful response.

object required

Changes

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