LlamaExtract

Run Job

Changed on
post/api/v1/extraction/jobs

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/jobs
  • Auth: HTTP bearer

Query parameters

from_uiboolean
project_idstring uuid nullable

Cookies

sessionstring nullable

Request body

priority'low' | 'medium' | 'high' | 'critical' nullable

The priority for the request. This field may be ignored or overwritten depending on the organization tier.

extraction_agent_idstring uuid required

The id of the extraction agent

file_idstring uuid required

The id of the file

Example request

{
  "webhook_configurations": [
    {
      "webhook_url": "https://example.com/webhooks/llamacloud",
      "webhook_headers": {
        "Authorization": "Bearer sk-..."
      },
      "webhook_signing_secret": "whsec_...",
      "webhook_events": [
        "parse.success",
        "parse.error"
      ],
      "webhook_output_format": "json"
    }
  ]
}

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

  • a38b684f8e1bRevision changes
    • info

      added the new optional query request parameter project_id

    • info

      added the new optional request property ///

    • info

      added the new batch.cancelled enum value to the request property /////

    • info

      added the new batch.error enum value to the request property /////

    • info

      added the new batch.pending enum value to the request property /////

    • info

      added the new batch.running enum value to the request property /////

    • info

      added the new batch.success enum value to the request property /////

    • info

      added the new classify.running enum value to the request property /////

    • info

      added the new sheets.cancelled enum value to the request property /////

    • info

      added the new sheets.error enum value to the request property /////

    • info

      added the new sheets.partial_success enum value to the request property /////

    • info

      added the new sheets.pending enum value to the request property /////

    • info

      added the new sheets.success enum value to the request property /////

    • info

      added the new split.cancelled enum value to the request property /////

    • info

      added the new split.error enum value to the request property /////

    • info

      added the new split.pending enum value to the request property /////

    • info

      added the new split.processing enum value to the request property /////

    • info

      added the new split.success enum value to the request property /////

    • info

      added the new verify.cancelled enum value to the request property /////

    • info

      added the new verify.error enum value to the request property /////

    • info

      added the new verify.pending enum value to the request property /////

    • info

      added the new verify.running enum value to the request property /////

    • info

      added the new verify.success enum value to the request property /////

    • info

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

    • info

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

  • 614771991b52Revision changes
    • breaking

      removed the enum value classify.running of the request property /////

    • breaking

      removed the enum value sheets.cancelled of the request property /////

    • breaking

      removed the enum value sheets.error of the request property /////

    • breaking

      removed the enum value sheets.partial_success of the request property /////

    • breaking

      removed the enum value sheets.pending of the request property /////

    • breaking

      removed the enum value sheets.success of the request property /////

    • warning

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

    • warning

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