LlamaExtract
post/api/v1/extraction/jobs/file

Request

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

Query parameters

from_uiboolean
project_idstring uuid nullable

Cookies

sessionstring nullable

Request body multipart/form-data

extraction_agent_idstring uuid required

The id of the extraction agent

filestring binary required

The file to run the job on

data_schema_overridestring nullable

The data schema to override the extraction agent's data schema with as a JSON string

config_overridestring nullable

The config to override the extraction agent's config with as a JSON string

Response

Successful Response

idstring uuid required

The id of the extraction job

status'PENDING' | 'SUCCESS' | 'ERROR' | 'PARTIAL_SUCCESS' | 'CANCELLED' required

The status of the extraction job

errorstring nullable

The error that occurred during extraction

file_idstring uuid nullable

The id of the file that the extract was extracted from

Changes

    • breaking

      the request property contentMediaType changed from to application/octet-stream

    • info

      added the new optional query request parameter project_id

    • info

      the request property format was generalized from binary to no format

    • info

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

    • info

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

    • warning

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

    • warning

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