LlamaExtract

Generate Extraction Schema

Changed on

Generate or refine an extraction agent schema from a file, natural-language prompt, or existing schema.

post/api/v1/extraction/extraction-agents/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/v1/extraction/extraction-agents/schema/generate
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

promptstring nullable

Natural language description of the data structure to extract

file_idstring uuid nullable

Optional file ID to analyze for schema generation

Response

Successful Response

data_schemaobject required

The generated JSON schema

Changes

  • a38b684f8e1bRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status