document-operations

validate_extract_schema

Validate an extraction schema without creating a job or consuming credits.

Cost class: fast (pure validation, no I/O, no model inference).

Use this before submitting an extract job to catch schema errors up front. On success valid=True and normalized_schema carries the compiled form the extraction pipeline will use. On failure valid=False and errors lists every violation — the whole list, not just the first.

Args: body: Exactly one of schema_id or schema. Optional schema_version pins a registry version when schema_id is set. caller: Authenticated tenant used to resolve tenant/platform schemas. session: Database session.

Returns: An :class:ExtractSchemaValidationResponse.

Raises: PlatformError: schema_not_found when schema_id is unknown.

post/v1/extract/schema-validation

Request

Request body

schema_idstring nullable

Catalog schema family id (sch_...). Mutually exclusive with an inline schema.

schema_versioninteger nullable

Pin a published catalog version. Omit with schema_id to use the latest version.

schemaobject nullable

Inline JSON Schema to validate. Mutually exclusive with schema_id.

Response

Successful Response

validboolean required

True when the schema can be used as an extract schema.

normalized_schemaobject nullable

Compiled schema when valid is true. Null when the input was rejected.

Changes

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