Skip to main content
GET

Overview

The Get Split Status endpoint retrieves the status and results of a document splitting job. Use this endpoint to check if splitting is complete and download the resulting split documents.
Splitting jobs are processed asynchronously. Poll this endpoint to check completion status.

Path Parameters

string
required
The unique identifier of the splitting job

Response

string
Unique identifier for the splitting job
string
Current job status: “queued” while the job waits to be picked up, “processing” while it runs, then “completed” or “failed”
string
Progress message describing current processing stage
string
Presigned download URL for the original uploaded file. Expires roughly an hour after the response is generated; re-issue this request to get a fresh URL.
string
Name of the original file
object
Echo of the parameters used for this job
object
Split results. Always present as a key; null until status is “completed”
string
Error message (if job failed, otherwise null)

Polling for Job Completion

Here are complete examples that poll the splitting job until it completes:

Authorizations

api-key
string
header
required

Path Parameters

job_id
string
required

The unique identifier of the splitting job

Response

200 - application/json

Split job status and results retrieved successfully

job_id
string

Unique identifier for the splitting job

status
string

Current job status (queued, processing, completed, failed)

progress
string

Progress message

file_url
string

Presigned download URL for the original uploaded file. Expires roughly an hour after the response is generated; re-issue this request for a fresh URL.

file_name
string

Name of the original file

parameters
object

Job parameters

result
object

Split results (only present when status is completed)

error
string

Error message if job failed