Skip to content

Search stays in your browser.

Open app

Reject standalone Forms API creation.

POST /api/v1/forms

Standalone Forms API creation has been removed. Agents should create or update draft review files through draft-review APIs, or author Git-backed form definitions in the reviewed source.

Use a credential with commentary.forms.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.

Name Location Type Required Description
X-Commentary-Workspace-Id header string No Must match the credential workspace. This header cannot widen grant authority.
X-Correlation-Id header string No

Required. Supported content types: application/json.

Field Type Required Description
contract FormContract No
contractSource string No Literal JSON or YAML form contract source.
sourceFormat "json" · "yaml" · "auto" No
referenceId string No
title string No
description string No
visibility "private" · "shared" · "public_placeholder" No
sourceType "commentary" · "github" · "embedded" · "custom" No
sourceMetadata object No
destinationConfig object No
agentAlias string No
clientName string No

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.

Terminal window
curl --request POST \
'https://commentary.dev/api/v1/forms' \
--header 'Authorization: Bearer <your-token>' \
--header 'Content-Type: application/json' \
--data-binary @request.json
Status Meaning Payload
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
410 Standalone form creation has been removed. ExternalError
429 The request was rate limited. ExternalError

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: createForm. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.