Skip to content

Validate Extraction Schema

extract.validate_schema(ExtractValidateSchemaParams**kwargs) -> ExtractV2SchemaValidateResponse
POST/api/v2/extract/schema/validation

Validate a JSON schema for extraction.

ParametersExpand Collapse
data_schema: Dict[str, Union[Dict[str, object], Iterable[object], str, 3 more]]

JSON Schema to validate for use with extract jobs

One of the following:
Dict[str, object]
Iterable[object]
str
float
bool
ReturnsExpand Collapse
class ExtractV2SchemaValidateResponse:

Response schema for schema validation.

data_schema: Dict[str, Union[Dict[str, object], List[object], str, 3 more]]

Validated JSON Schema, ready for use in extract jobs

One of the following:
Dict[str, object]
List[object]
str
float
bool

Validate Extraction Schema

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
extract_v2_schema_validate_response = client.extract.validate_schema(
    data_schema={
        "foo": {
            "foo": "bar"
        }
    },
)
print(extract_v2_schema_validate_response.data_schema)
{
  "data_schema": {
    "foo": {
      "foo": "bar"
    }
  }
}
Returns Examples
{
  "data_schema": {
    "foo": {
      "foo": "bar"
    }
  }
}
Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/