v1

latestOpenAPI 3.0.32026-07-24235275.4 KB

Bulk Status

Retrieve the status of a bulk ingestion job

Checks the status of a bulk ingestion job identified by bulkJobId. This endpoint returns the current state of the job (e.g. PENDING, IN_PROGRESS, COMPLETED, FAILED) along with metadata such as timestamps and error messages if applicable.

If the job has completed successfully, the response includes a downloadable link to a .jsonl (JSON Lines) file containing a record of each request and its corresponding response. User's can audit results or process downstream outcomes of the bulk operation. You can fetch requests up to 2 weeks old.

Scopes Required: No Additional scopes required.

Default Rate Limit: 100 requests per second

get/v2/bulk/job/{bulkJobId}

Path parameters

bulkJobIdstring required

id of the bulk job

Response

Returns the status of the bulk job

bulkJobIdstring

A unique identifier representing the submitted batch job. Use this ID to query the job's status, retrieve results, or diagnose any errors related to the job. This ID is returned upon successful job submission and required for all follow-up actions related to the batch.

statusstring

The current state of the batch job. Common values include:

IN_PROGRESS – The job has been accepted and is waiting to be processed.
COMPLETED – The job finished successfully.

totalRecordsinteger

The total number of records included in the batch job. This represents the full count of items submitted for processing, regardless of whether they ultimately succeeded or failed.

urlstring

A direct URL to download the results of the batch job, when available. This field is typically populated once the job has completed successfully. The file will contain per-record results in a JSON Lines (.jsonl) file.