Validate a literal Form Contract v1 payload without persisting it.
POST /api/v1/forms/validate
Validate a literal Form Contract v1 payload without persisting it.
Access
Section titled “Access”Use a credential with commentary.forms.read.
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
Section titled “Parameters”| 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 |
Request body
Section titled “Request body”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 |
Call the endpoint
Section titled “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/forms/validate' \ --header 'Authorization: Bearer <your-token>' \ --header 'Content-Type: application/json' \ --data-binary @request.jsonResponses
Section titled “Responses”| Status | Meaning | Payload |
|---|---|---|
200 |
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
Section titled “Successful response fields”| Field | Type | Required | Description |
|---|---|---|---|
ok |
true |
No | |
valid |
boolean | No | |
contract |
FormContract | No | |
diagnostics |
array of object | No |
Recover from errors
Section titled “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.
Contract and related guidance
Section titled “Contract and related guidance”Operation ID: validateFormContract. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.