> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ndi.nace.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi.json post /v1/extract/schema-validation
openapi: 3.1.0
info:
  description: >-
    Document intelligence: parse, split, classify, extract, and ground files, or
    build a searchable workspace. Authenticate with ``X-API-Key``.
  title: NDI Platform API
  version: 0.1.0
servers:
  - url: https://ndi-api.nace.ai
security: []
tags: []
paths:
  /v1/extract/schema-validation:
    post:
      tags:
        - document-operations
      summary: validate_extract_schema
      description: >-
        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.
      operationId: validate_extract_schema_v1_extract_schema_validation_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/ndi_service__app__platform_api__document_operations__schemas__ExtractSchemaValidationRequest
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ndi_service__app__platform_api__document_operations__schemas__ExtractSchemaValidationResponse
          description: Successful Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Gateway Timeout
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  detail: null
                  message: >-
                    Request body has extra fields that this operation does not
                    accept.
                  request_id: req-01j9k2n3p4q5r6s7t8v9
                  retryable: false
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: >-
            Typed error envelope used by every 4xx and 5xx. ``error.code``
            distinguishes the failure; HTTP status is a consequence of the code.
      security:
        - APIKeyHeader: []
components:
  schemas:
    ndi_service__app__platform_api__document_operations__schemas__ExtractSchemaValidationRequest:
      additionalProperties: false
      description: |-
        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``.
      properties:
        schema:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/JsonValue'
              type: object
            - type: 'null'
          title: Schema
        schema_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Schema Id
        schema_version:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
          title: Schema Version
      title: ExtractSchemaValidationRequest
      type: object
    ndi_service__app__platform_api__document_operations__schemas__ExtractSchemaValidationResponse:
      additionalProperties: false
      description: |-
        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.
      properties:
        errors:
          items:
            $ref: '#/components/schemas/SchemaError'
          title: Errors
          type: array
        normalized_schema:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/JsonValue'
              type: object
            - type: 'null'
          title: Normalized Schema
        valid:
          title: Valid
          type: boolean
      required:
        - valid
      title: ExtractSchemaValidationResponse
      type: object
    ErrorEnvelope:
      description: Every non-2xx body on ``/v1``.
      example:
        error:
          code: invalid_request
          detail: null
          message: Request body has extra fields that this operation does not accept.
          request_id: req-01j9k2n3p4q5r6s7t8v9
          retryable: false
      properties:
        error:
          $ref: '#/components/schemas/Error'
      required:
        - error
      title: ErrorEnvelope
      type: object
    JsonValue: {}
    SchemaError:
      additionalProperties: false
      description: One violation from ``POST /v1/extract/schema-validation``.
      properties:
        message:
          title: Message
          type: string
        path:
          title: Path
          type: string
      required:
        - path
        - message
      title: SchemaError
      type: object
    Error:
      description: The error object, per spec 12 §1.8.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        detail:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Structured payload, when the code carries one.
          title: Detail
        message:
          description: Human- and model-readable; says what to do differently.
          title: Message
          type: string
        request_id:
          description: Per-request correlation id; matches the ``X-Request-Id`` header.
          title: Request Id
          type: string
        retryable:
          description: Whether retrying the identical request could succeed.
          title: Retryable
          type: boolean
      required:
        - code
        - message
        - retryable
        - request_id
      title: Error
      type: object
    ErrorCode:
      description: |-
        Every error the ``/v1`` surface can return.

        Clients must treat this as an **open** enum: a new member is an additive
        change (spec 12 §9), and a client that crashes on an unknown code makes
        every future error a breaking change.
      enum:
        - invalid_request
        - unsupported_file_type
        - file_too_large
        - invalid_schema
        - invalid_sql
        - invalid_path_prefix
        - command_not_permitted
        - batch_too_large
        - domain_validation_failed
        - default_label_required
        - wait_required_for_zero_retention
        - workspace_not_found
        - file_not_found
        - job_not_found
        - upload_not_found
        - node_not_found
        - schema_not_found
        - domain_not_found
        - session_not_found
        - access_label_not_found
        - path_conflict
        - schema_version_conflict
        - access_label_name_taken
        - workspace_name_taken
        - access_label_in_use
        - upload_expired
        - file_not_ingested
        - workspace_deleting
        - workspace_not_deletable
        - ingestion_in_progress
        - job_not_cancellable
        - confirmation_required
        - domain_not_published
        - domain_in_use
        - reserved_domain_slug
        - kg_not_built
        - kg_build_in_progress
        - session_busy
        - range_not_satisfiable
        - result_expired
        - access_denied
        - access_backstop_violation
        - access_mode_not_implemented
        - rate_limited
        - concurrency_limit_reached
        - quota_exceeded
        - corrupt_file
        - zero_byte_file
        - encrypted_file
        - parse_failed
        - ocr_failed
        - conversion_failed
        - sheetless_workbook
        - unplayable_media
        - unclassified_pages
        - job_cancelled
        - job_timeout
        - upstream_unavailable
        - internal_error
        - unauthorized
        - not_implemented
      title: ErrorCode
      type: string
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````