Validate Extraction Schema

POST/api/v1/extraction/extraction-agents/schema/validation

Validates an extraction agent's schema definition. Returns the normalized and validated schema if valid, otherwise raises an HTTP 400.

Cookie ParametersExpand Collapse

session: optional string

Body ParametersJSONExpand Collapse

data_schema: map[map[unknown] or array of unknown or string or 2 more] or string

Accepts one of the following:

UnionMember0 = map[map[unknown] or array of unknown or string or 2 more]

Accepts one of the following:

UnionMember0 = map[unknown]

UnionMember1 = array of unknown

UnionMember2 = string

UnionMember3 = number

UnionMember4 = boolean

UnionMember1 = string

ReturnsExpand Collapse

data_schema: map[map[unknown] or array of unknown or string or 2 more]

Accepts one of the following:

UnionMember0 = map[unknown]

UnionMember1 = array of unknown

UnionMember2 = string

UnionMember3 = number

UnionMember4 = boolean

Validate Extraction Schema

curl https://api.cloud.llamaindex.ai/api/v1/extraction/extraction-agents/schema/validation \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
    -d '{
          "data_schema": {
            "foo": {
              "foo": "bar"
            }
          }
        }'

{
  "data_schema": {
    "foo": {
      "foo": "bar"
    }
  }
}

Returns Examples

{
  "data_schema": {
    "foo": {
      "foo": "bar"
    }
  }
}