Forms

Validate a literal Form Contract v1 payload without persisting it.

post/api/v1/forms/validate

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/forms/validate
  • Auth: HTTP bearer

Headers

X-Commentary-Workspace-Idstring

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

X-Correlation-Idstring

Request body

contractFormContract

Normalized Commentary Form Contract v1.

contractSourcestring

Literal JSON or YAML form contract source.

sourceFormat'json' | 'yaml' | 'auto'
referenceIdstring
titlestring
descriptionstring
visibility'private' | 'shared' | 'public_placeholder'
sourceType'commentary' | 'github' | 'embedded' | 'custom'
sourceMetadataobject
destinationConfigobject
agentAliasstring
clientNamestring

Response

Successful response.

okunknown
validboolean
contractFormContract

Normalized Commentary Form Contract v1.

diagnosticsobject[]

Changes

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