Download

Access presigned URLs for downloading input or processed images. These endpoints allow you to securely retrieve the input or the processed image with an expiring URL.

Download Output

get

A presigned download link to the image is provided in the response, as well as an expiration time (in Unix time). If the image is not ready, this request will fail with a conflict error. Images are stored for 7 days after the image has been processed.

Authorizations

apiKeyAuth

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

Presigned download URL

application/json

download_urlstringRequired

The presigned URL for downloading the image. This URL is temporary and will expire after 1 hour.

Example: https://<...>/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?<presigned_headers>

head_urlstringRequired

The presigned URL for fetching the metadata of the image's file. Useful for retrieving the image's size before download. This URL is temporary and will expire after 1 hour.

Example: https://<...>/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?<presigned_headers>

expiryintegerRequired

The expiration time (in Unix epoch) of the presigned download link, set as 1 hour after download link generation. After this time, the link will no longer be valid.

Example: 1617220000

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

get

/download/{process_id}

HTTPcURLJavaScriptPython

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

{
  "download_url": "https://<...>/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?<presigned_headers>",
  "head_url": "https://<...>/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?<presigned_headers>",
  "expiry": 1617220000
}

Download Input

get

A presigned download link to the input image is provided in the response, as well as an expiration time (in Unix time). Input images are stored for 7 days after the image has been uploaded.

Authorizations

apiKeyAuth

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

Presigned download URL

application/json

download_urlstringRequired

The presigned URL for downloading the image. This URL is temporary and will expire after 1 hour.

Example: https://<...>/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?<presigned_headers>

head_urlstringRequired

The presigned URL for fetching the metadata of the image's file. Useful for retrieving the image's size before download. This URL is temporary and will expire after 1 hour.

Example: https://<...>/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?<presigned_headers>

expiryintegerRequired

The expiration time (in Unix epoch) of the presigned download link, set as 1 hour after download link generation. After this time, the link will no longer be valid.

Example: 1617220000

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

/download/input/{process_id}

HTTPcURLJavaScriptPython

GET /image/v1/download/input/{process_id} HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "download_url": "https://<...>/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?<presigned_headers>",
  "head_url": "https://<...>/d7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b?<presigned_headers>",
  "expiry": 1617220000
}