Skip to main content
GET
/
image
/
task
/
status
/
{taskId}
Check task status
curl --request GET \
  --url https://whilter-api-host/image/task/status/{taskId} \
  --header 'Authorization: Bearer <token>'
{
  "task-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "COMPLETED",
  "file-path": "<string>",
  "total-count": 100000,
  "processed": 100000,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
taskId
string<uuid>
required

The unique identifier of the task to check

Response

200 - application/json

Task status retrieved successfully

​
task-id
string<uuid>

Unique identifier of the task

​
status
enum<string>

Current status of the task

Available options:
COMPLETED,
PENDING,
IN PROGRESS,
FAILED
​
file-path
string | null

S3 path to the output file (available when completed)

​
total-count
integer

Total Number of records

Example:

100000

​
processed
integer

Number of tasks processed

Example:

100000

​
message
string

Response message