Jobs

Get the state of a background job

get/api/v1/jobs/{id}

Request

  • Base URL: https://curlshot.com
  • URL: https://curlshot.com/api/v1/jobs/{id}
  • Auth: one of:
    • API key in query parameter access_key
    • API key in header X-Access-Key
    • HTTP bearer

Path parameters

idstring required

The job_id returned when the job was queued.

Response

The job.

job_idstring required
batch_idstring nullable
status'queued' | 'processing' | 'done' | 'failed' required
job_urlstring uri required
error_code'invalid_url' | 'host_not_allowed' | 'navigation_failed' | 'timeout' | 'selector_not_found' | 'page_blocked' | 'concurrency_limit' | 'content_too_large' | 'internal_error' | 'renderer_busy' | 'renderer_unavailable' | 'invalid_options' | 'access_key_required' | 'access_key_invalid' | 'signature_required' | 'signature_invalid' | 'quota_exceeded' | 'rate_limited' | 'job_not_found' | 'service_unavailable' | 'invalid_request' | 'email_not_verified' | 'feature_not_available' | 'request_expired' | 'not_found' | 'file_not_found' | 'method_not_allowed' | 'queue_limit' | 'failure_limit' | 'null' nullable
error_messagestring nullable
created_atstring date-time
finished_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.