LlamaExtract

Get Run

Changed on
get/api/v1/extraction/runs/{run_id}

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/runs/{run_id}
  • Auth: HTTP bearer

Path parameters

run_idstring uuid required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring uuid required

The id of the extraction run

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring uuid required

The id of the project that the extraction run belongs to

extraction_agent_idstring uuid required

The id of the extraction agent

data_schemaobject required

The schema used for extraction

file_idstring uuid nullable

The id of the file that the extract was extracted from

status'CREATED' | 'PENDING' | 'SUCCESS' | 'ERROR' required
errorstring nullable

The error that occurred during extraction

job_idstring uuid nullable

The id of the job that the extraction run belongs to

extraction_metadataobject nullable

The metadata extracted from the file

from_uiboolean required

Whether this extraction run was triggered from the UI

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