v34

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

Beta

Sheets

Beta

Sheets

Create Spreadsheet Job

Create a spreadsheet parsing job.

Provide at most one of configuration (an inline parsing configuration) or configuration_id (a saved configuration preset). If neither is provided, a default configuration is used. Optionally include webhook_configurations to receive sheets.* status notifications.

Experimental: not production-ready and subject to change.

post/api/v1/beta/sheets/jobs

Query parameters

project_idstring uuid nullable

organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

configuration_idstring nullable

Saved configuration ID

file_idstring uuid required

The ID of the file to parse

Example request

{
  "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",
  "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 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"
      }
    ]
  }
}