Skip to main content
POST
validate_extract_schema

Authorizations

X-API-Key
string
header
required

Body

application/json

Body for POST /v1/extract/schema-validation.

Same mutual-exclusion rule as :class:ExtractRequest: exactly one of schema_id or schema must be present. Optional schema_version pins a registry version when resolving schema_id.

schema
Schema · object | null
schema_id
string | null
schema_version
integer | null
Required range: x >= 1

Response

Successful Response

Result of POST /v1/extract/schema-validation.

On a valid schema, valid=True and normalized_schema carries the compiled form. On an invalid schema, valid=False and errors lists every violation found — the whole list, not just the first.

valid
boolean
required
errors
SchemaError · object[]
normalized_schema
Normalized Schema · object | null