Link Search Menu Expand Document

Background Jobs Check

Checks status of background job that was previously created with API.

Available Methods

[POST] /job/check

jobId required
ID of background that was started asynchronously. To start a new async background job, you should set async to true for API methods.
force optional
Set to true to forcibly check the status of the background job. Intended to be used with really long and heavy background jobs only.

Returns JSON with the status of the background job.

Available status values:

  • working background job is currently in work or does not exist.
  • success background job was successfully finished.
  • failed background job failed for some reason (see message for more details).
  • aborted background job was aborted.
  • unknown unknown background job id. Available only when force is set to true for input request.

  • Method: POST
  • URL: /v1/job/check

Query parameters

No query parameters accepted.

Body payload

    "jobid": "12345"

Example responses

    "status": "working",
    "remainingCredits": 60227

Code Snippet

curl --location --request POST '' \
--header 'x-api-key: ' \
--data-raw '{
    "jobid": "12345"