Skip to main content
POST
Resume a paused run

Authorizations

X-API-Key
string
header
required

Batch, Crawl, the Extract endpoints and the account endpoint read the same key from the X-API-Key header.

Path Parameters

job_id
string
required

Identifier returned when the job was created.

Response

The run, resumed.

One run of a job.

run_id
string
job_id
string
run_sequence
integer

1 for the first run, then one more per rerun or scheduled fire.

status
enum<string>

completed, failed, stopped and deleted are terminal.

Available options:
pending,
running,
completed,
failed,
stopped,
deleted
pause_state
enum<string>

paused after pauseBatchRun; status does not change.

Available options:
active,
paused
trigger
enum<string>

What started the run.

Available options:
manual,
scheduled
last_batch_received
boolean

Open jobs: whether the final addBatchTasks call arrived.

stats
object

Task counters. completed is successful plus failed.

failure_reason
string

Only when the whole run failed. Open set; new values may appear.

Examples:

"insufficient_credits"

"subscription_inactive"

"api_key_cap_reached"

failure_detail
string

What happened, for example which cap and when it resets.

created_at
string<date-time>
updated_at
string<date-time>