v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-09194386949.7 KB

Beta

Sheets

Beta

Sheets

Get Spreadsheet Job

Get a spreadsheet parsing job. When include_results=True (default), embeds extracted regions and results if complete, skipping the separate /results call. Experimental: not production-ready and subject to change.

get/api/v1/beta/sheets/jobs/{spreadsheet_job_id}

Path parameters

spreadsheet_job_idstring required

Query parameters

include_resultsboolean

expandstring[]

Optional fields to populate on the response. Valid values: metadata_state_transitions.

project_idstring uuid nullable

organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring required

The ID of the job

user_idstring required

The ID of the user

project_idstring uuid required

The ID of the project

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

The status of the parsing job

configuration_idstring nullable

The saved product configuration ID used at create time, if any.

metadata_state_transitionsobject nullable

Per-status entry timestamps. Returned only when requested via ?expand=metadata_state_transitions.

created_atstring required

When the job was created

updated_atstring required

When the job was last updated

successboolean nullable

Whether the job completed successfully

errorsstring[]

Any errors encountered

file_idstring uuid nullable required

The ID of the input file

Example response

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