Forms

Get a form contract and metadata.

Review-scoped tokens can read embedded forms only when query parameters identify the covered review context.

get/api/v1/forms/{formId}

Request

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

Path parameters

formIdstring required

Form id or reference id.

Query parameters

provider'github'
ownerstring

Repository owner.

repostring

Repository name.

printeger

Pull request number.

prNumberinteger

Pull request number alias used by Brain endpoints.

branchstring

Branch ref for branch document review.

branchRefstring

Branch ref alias used by Brain endpoints.

rootFolderstring

Knowledge Brain root folder.

brainRootFolderstring

Knowledge Brain root folder alias.

draftReviewSessionIdstring
filePathstring
documentVersionIdstring
formInstanceIdstring

Headers

X-Commentary-Workspace-Idstring

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

X-Correlation-Idstring

Response

Successful response.

okunknown

Changes

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