Status

Check and manage the statuses of your image processing jobs. Whether you are handling a single job or managing a queue of bulk image processing tasks, the Status endpoints allow you to monitor the progress and completion of your tasks.

This is particularly useful for long-running jobs, where you can track progress and retrieve details such as percentage completion, estimated finish time, and current state (e.g., pending, processing, completed).

Get All Statuses

get

Retrieve the status of all image processing jobs.

Pagination (Highly Recommended): For better performance and to handle large numbers of statuses, pagination is highly recommended. Enable pagination by setting paginated=true. When pagination is enabled:

  • Use the limit parameter to control the number of results per page (default: 50, maximum: 100)

  • Use the cursor parameter to retrieve subsequent pages

  • The response will include pagination metadata with next_cursor and has_next_page fields

Non-Paginated Response: When paginated=false (default) or omitted, the endpoint returns all statuses as a simple array. This may be slow or fail for accounts with many statuses.

Authorizations
X-API-KeystringRequired

Authentication via the Topaz generated key in the X-API-Key header.

Query parameters
paginatedbooleanOptional

Enable pagination for the response. Highly recommended for better performance.

Default: falseExample: true
limitinteger · min: 1 · max: 100Optional

Number of results per page when pagination is enabled. Ignored if paginated=false. Defaults to 50, maximum is 100.

Default: 50Example: 50
cursorstringOptional

Cursor for pagination. Use the next_cursor value from the previous response to retrieve the next page. Ignored if paginated=false.

Example: eyJwcm9jZXNzX2lkIjoiZDdiM2IzYjMzLTdiM2ItNGIzYi04YjNiLTNiM2IzYjNiM2IzYiJ9
Responses
200

Statuses of all processes. The response format depends on whether pagination is enabled.

application/json
Responseone of
or
get
/status
GET /image/v1/status HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "process_id": "d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "source_id": "d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
    "filename": "image.png",
    "input_format": "png",
    "input_height": 720,
    "input_width": 1280,
    "output_format": "jpeg",
    "output_height": 1080,
    "output_width": 1920,
    "category": "Enhance",
    "model_type": "GAN",
    "model": "Standard V2",
    "crop_to_fill": false,
    "status": "Completed",
    "progress": 100,
    "eta": 1617220000,
    "creation_time": 1633024800,
    "modification_time": 1633038400,
    "credits": 2
  }
]

Delete All Statuses

delete

Remove all image processing job statuses. This operation can be used to delete the statuses of finished jobs, cleaning up the response of Get All Statuses, for example.

Authorizations
X-API-KeystringRequired

Authentication via the Topaz generated key in the X-API-Key header.

Responses
200

The number of statuses that were deleted.

application/json
delete
/status
DELETE /image/v1/status HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "deleted_count": 10
}

Get Status

get

Use this endpoint to retrieve status information for your image processing jobs.

Authorizations
X-API-KeystringRequired

Authentication via the Topaz generated key in the X-API-Key header.

Path parameters
process_idstring · uuidRequired

The UUID of the image processing job.

Responses
200

Status of the process

application/json
get
/status/{process_id}
GET /image/v1/status/{process_id} HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "process_id": "d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
  "source_id": "d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
  "filename": "image.png",
  "input_format": "png",
  "input_height": 720,
  "input_width": 1280,
  "output_format": "jpeg",
  "output_height": 1080,
  "output_width": 1920,
  "category": "Enhance",
  "model_type": "GAN",
  "model": "Standard V2",
  "subject_detection": "All",
  "face_enhancement": true,
  "face_enhancement_creativity": 0,
  "face_enhancement_strength": 0.8,
  "crop_to_fill": false,
  "options_json": "{\"creativity\": 90}",
  "status": "Completed",
  "progress": 100,
  "eta": 1617220000,
  "creation_time": 1633024800,
  "modification_time": 1633038400,
  "credits": 2
}

Delete Status

delete

Remove an image processing job status by its process_id. This operation can be used to delete the statuses of finished jobs, cleaning up the response of GET Status, for example.

Authorizations
X-API-KeystringRequired

Authentication via the Topaz generated key in the X-API-Key header.

Path parameters
process_idstring · uuidRequired

The UUID of the image processing job.

Responses
delete
/status/{process_id}
DELETE /image/v1/status/{process_id} HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Accept: */*

No content
PreviousLightingNextDownload

Last updated