Sign in
V2
Extract

Validate Extraction Schema

Validate a JSON schema for extraction.

post/api/v2/extract/schema/validation

Cookies

sessionstring nullable

Request body

data_schemaobject required

JSON Schema to validate for use with extract jobs

Example request

{
  "data_schema": {
    "properties": {
      "vendor_name": {
        "description": "Name of the vendor or supplier",
        "type": "string"
      },
      "invoice_number": {
        "description": "Unique invoice identifier",
        "type": "string"
      },
      "total_amount": {
        "description": "Total invoice amount in dollars",
        "type": "number"
      },
      "line_items": {
        "description": "List of invoice line items",
        "items": {
          "properties": {
            "description": {
              "type": "string"
            },
            "quantity": {
              "type": "integer"
            },
            "unit_price": {
              "type": "number"
            }
          },
          "required": [
            "description",
            "quantity",
            "unit_price"
          ],
          "type": "object"
        },
        "type": "array"
      }
    },
    "required": [
      "vendor_name",
      "invoice_number",
      "total_amount"
    ],
    "type": "object"
  }
}

Response

Successful Response

data_schemaobject required

Validated JSON Schema, ready for use in extract jobs

Changes

Changed in 4 of the 33 revisions of this API.5