LlamaExtract

Extract Stateless

Changed on

Stateless extraction using a default agent in the user's default project; requires data_schema, config, and one of file_id / text / base64 file data.

post/api/v1/extraction/run

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

file_idstring uuid nullable

The ID of the file to extract from

textstring nullable

The text content to extract from

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

  • b17341164de9Revision changes
    • info

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

    • info

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

  • d40e17e17bd1Revision changes
    • 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 /////