Sign in
Beta
Sheets
Beta
Sheets

Get Spreadsheet Job

Changed on

Get a spreadsheet parsing job.

When include_results=True (default), the response will include extracted regions and results if the job is complete, eliminating the need for a separate /results call.

Experimental: This endpoint is not yet ready for production use and is subject to change at any time.

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

Request

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

Path parameters

spreadsheet_job_idstring required

Query parameters

include_resultsboolean
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

Enum for representing the status of a job

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

Changes