LlamaExtract

Run Job

post/api/v1/extraction/jobs

Query parameters

from_uiboolean

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_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

Changed in 3 of the 33 revisions of this API.210

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

      response-optional-property-added

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

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

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

      request-property-enum-value-added

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

      request-property-enum-value-added

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

      request-property-enum-value-added

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

      request-property-enum-value-added

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

      request-property-enum-value-added

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

      request-property-enum-value-added

  • 1bbc901f8c0d22See the full diff
    • removed the enum value gemini-1.5-flash of the request property ///

      request-property-enum-value-removed

    • removed the enum value gemini-1.5-pro of the request property ///

      request-property-enum-value-removed

    • removed the gemini-1.5-flash enum value from the /// response property for the response status

      response-property-enum-value-removed

    • removed the gemini-1.5-pro enum value from the /// response property for the response status

      response-property-enum-value-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog