Forms

Preview result writeback or explicitly import canonical git-hosted result files.

Import and preview actions require commentary.forms.writeback and the forms.github_writeback license feature. Import validates canonical JSON/YAML result files, deduplicates by external id, records audit events, and stores imported submissions with git sync metadata.

post/api/v1/forms/{formId}/git-results

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/forms/{formId}/git-results
  • Auth: HTTP bearer

Path parameters

formIdstring required

Form id or reference id.

Headers

X-Commentary-Workspace-Idstring

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

X-Correlation-Idstring

Request body

action'import' | 'preview_writeback'
submissionIdstring
submissionIdsstring[]
pathsstring[]
summarystring
commitMessagestring
openPullRequestboolean
pullRequestTitlestring
pullRequestBodystring
agentAliasstring
clientNamestring

Response

Successful response.

object required

Changes

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