Extract

Generate Extraction Schema

Changed on Oct 17, 2026

Generate a JSON schema and return a product configuration request.

post/api/v2/extract/schema/generate

Request

Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
URL: https://api.cloud.llamaindex.ai/api/v2/extract/schema/generate
Auth: HTTP bearer

Query parameters

project_idstring uuid nullable

organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

namestring nullable

Name for the generated configuration (auto-generated if omitted)

promptstring nullable

Natural language description of the data structure to extract

file_idstring nullable

Optional file ID to analyze for schema generation

data_schemaobject nullable

Optional schema to validate, refine, or extend

Example request

{
  "name": "invoice_extraction",
  "prompt": "Extract vendor name, invoice number, date, line items with descriptions and amounts, and total amount from invoices."
}

Response

Successful Response

namestring required

Human-readable name for this configuration.

Example response

{
  "parameters": {
    "splitting_strategy": {
      "custom_instructions": "Start a new segment at every signature page."
    },
    "version": "latest",
    "parse_tier": "fast",
    "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555",
    "target_pages": "1,3,5-7"
  }
}

Changes

Oct 17, 2026809d302cdb1e Revision changes
- warning
  added the new 2026-10-16 enum value to the //////// response property for the response status
- warning
  added the new 2026-10-16 enum value to the /// response property for the response status
- info
  removed the 2026-10-15 enum value from the //////// response property for the response status
- info
  removed the 2026-10-15 enum value from the /// response property for the response status
Oct 16, 2026a38b684f8e1b Revision changes
- breaking
  response property parameters/oneOf[subschema #4: ParseV2Parameters]/output_options/images_to_save list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  the //// response property's maxLength was increased from 500 to 2000 for the response status
- warning
  removed the optional property // from the response with the status
- warning
  added the new 2026-06-15 enum value to the //////// response property for the response status
- warning
  added the new 2026-06-15 enum value to the /// response property for the response status
- warning
  added the new 2026-09-28 enum value to the //////// response property for the response status
- warning
  added the new 2026-09-28 enum value to the /// response property for the response status
- warning
  added the new 2026-10-15 enum value to the //////// response property for the response status
- warning
  added the new 2026-10-15 enum value to the /// response property for the response status
- warning
  added the new agentic enum value to the /// response property for the response status
- warning
  added the new agentic_plus enum value to the /// response property for the response status
- warning
  added the new agentic_plus enum value to the // response property for the response status
- warning
  added the new cost_effective enum value to the /// response property for the response status
- warning
  added the new fast enum value to the /// response property for the response status
- warning
  added the new turbo enum value to the // response property for the response status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property // to the response with the status
- info
  removed the 2025-12-11 enum value from the //////// response property for the response status
- info
  removed the 2025-12-11 enum value from the /// response property for the response status
- info
  removed the 2026-05-26 enum value from the //////// response property for the response status
- info
  removed the 2026-05-26 enum value from the /// response property for the response status
- info
  removed the 2026-05-28 enum value from the //////// response property for the response status
- info
  removed the 2026-05-28 enum value from the /// response property for the response status

Operation history (22 revisions)