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 up to 7 days old 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: false

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: 50

cursorstringOptional

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

Responses

200

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

application/json

400

The request contains malformed data in the body, path, or query parameters.

application/json

401

Authentication is required and has failed or has not yet been provided.

application/json

403

The API key doesn't have permissions to perform the request.

application/json

429

Too many requests hit the API too quickly. A backoff (e.g. exponential) is recommended for your requests.

application/json

500

Unexpected error on our end.

application/json

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

deleted_countintegerOptional

The number of statuses that were deleted.

Example: 10

401

Authentication is required and has failed or has not yet been provided.

application/json

403

The API key doesn't have permissions to perform the request.

application/json

429

Too many requests hit the API too quickly. A backoff (e.g. exponential) is recommended for your requests.

application/json

500

Unexpected error on our end.

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

process_idstringRequired

Unique identifier of the image processing job.

Example: d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b

source_idstringOptional

Unique identifier of the source image.

Example: d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b

filenamestringRequired

Name of the file being processed.

Example: image.png

input_formatstringRequired

Format of the input file.

Example: png

input_heightintegerRequired

Height of the input image in pixels.

Example: 720

input_widthintegerRequired

Width of the input image in pixels.

Example: 1280

output_formatstringRequired

Format of the output file.

Example: jpeg

output_heightintegerRequired

Height of the output image in pixels.

Example: 1080

output_widthintegerRequired

Width of the output image in pixels.

Example: 1920

categorystringRequired

Category of model used for processing.

Example: Enhance

model_typestringRequired

Type of model used for processing.

Example: GAN

modelstringRequired

Model used for processing.

Example: Standard V2

subject_detectionstringOptional

Level of subject detection.

Example: All

face_enhancementbooleanOptional

Whether face enhancement is enabled.

Example: true

face_enhancement_creativitynumberOptional

Level of face enhancement creativity (if enabled).

face_enhancement_strengthnumberOptional

Level of face enhancement strength (if enabled).

Example: 0.8

crop_to_fillbooleanRequired

Whether cropping to fill is enabled.

options_jsonstringOptional

Additional options in JSON format.

Example: {"creativity": 90}

statusstring · enumRequired

Status of the job.

Example: CompletedPossible values:

progressinteger · max: 100Required

Progress of the job as a percentage. Useful for displaying a progress bar or loading spinners etc.

Example: 100

etaintegerRequired

Estimated time of arrival (ETA) for the process to complete in Unix time.

Example: 1617220000

creation_timeintegerRequired

Creation time of the job in Unix epoch format.

Example: 1633024800

modification_timeintegerRequired

Last modification time of the job in Unix epoch format.

Example: 1633038400

creditsintegerRequired

Credits (to be) consumed on image processing completion.

Example: 2

400

The request contains malformed data in the body, path, or query parameters.

application/json

401

Authentication is required and has failed or has not yet been provided.

application/json

403

The API key doesn't have permissions to perform the request.

application/json

404

The requested resource does not exist.

application/json

429

Too many requests hit the API too quickly. A backoff (e.g. exponential) is recommended for your requests.

application/json

500

Unexpected error on our end.

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

204

The image processing job status was successfully deleted. No content returned.

400

The request contains malformed data in the body, path, or query parameters.

application/json

401

Authentication is required and has failed or has not yet been provided.

application/json

403

The API key doesn't have permissions to perform the request.

application/json

404

The requested resource does not exist.

application/json

409

The request conflicts with the current state.

application/json

429

Too many requests hit the API too quickly. A backoff (e.g. exponential) is recommended for your requests.

application/json

500

Unexpected error on our end.

application/json

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

PreviousTool NextDownload

Last updated 2 months ago

Good evening

hashtagGet All Statuses

hashtagDelete All Statuses

hashtagGet Status

hashtagDelete Status

Get All Statuses

Delete All Statuses

Get Status

Delete Status