job.get()
Retrieves the status and result of an asynchronous job.
result = client.job.get(job_id="your-job-id")
if result.status == "Completed":
print(result.result)
elif result.status == "Failed":
print(f"Job failed: {result.reason}")
else:
print(f"Job status: {result.status}, progress: {result.progress}")
Parameters
The ID of the job to retrieve.
Response
JobGetResponse
AsyncJobResponse | EnhancedAsyncJobResponse
Returns the job status and result.
The status of the job. One of: Pending, Completed, Failed, Idle.
The progress of the job as a percentage (0-100).
The reason for failure if the job failed.
The result of the job if completed. Can be a ParseResponse, ExtractResponse, SplitResponse, EditResponse, PipelineResponse, or V3ExtractResponse.
Show EnhancedAsyncJobResponse
The status of the job. One of: Pending, Completed, Failed, Idle.
The progress of the job as a percentage (0-100).
The reason for failure if the job failed.
The result of the job if completed.
Storage bucket information for the job.
When the job was created.
The duration of the job in seconds.
The number of pages processed.
The raw configuration used for the job.
Source document information.
The total number of pages in the document.
The type of job. One of: Parse, Extract, Split, Edit, Pipeline.
job.get_all()
Retrieves a paginated list of all jobs.
response = client.job.get_all(
limit=50,
cursor=None,
exclude_configs=True
)
for job in response.jobs:
print(f"Job {job.id}: {job.status}")
# Get next page
if response.next_cursor:
next_page = client.job.get_all(cursor=response.next_cursor)
Parameters
Cursor for pagination. Use the next_cursor from the previous response to fetch the next page.
Exclude raw_config from response to reduce size.
Maximum number of jobs to return per page. Defaults to 100, max 500.
Response
Returns a paginated list of jobs.An array of job objects with their status and metadata.
Cursor to use for fetching the next page of results.
job.cancel()
Cancels a pending or in-progress job.
client.job.cancel(job_id="your-job-id")
Parameters
The ID of the job to cancel.
Response
Returns a success confirmation.