Get Request Status

This section allows you to get the status of a request

Get Video Request Status

get

Get status of the request.

If processing is complete, the response will include a signed URL to access the enhanced video.

Make sure to download and save the video within the TTL provided in the response (24 hours by default). New URLs with new TTL can be generated by calling this endpoint, but we retain your data for only a limited number of days. The video will be permanently deleted from our system afterwards.

Response body

Property	Type	Description
status	String	Current processing status
progress	Number	Total request progress (percentage)
estimates	Object	Refer to RequestEstimates
outputSize	String	Size of output video
averageFps	Number	Average FPS of processing nodes
combinedFps	Number	Combined FPS of all nodes
processingJobs	Array	Refer to VideoProcessingStatIntermediate below
download	Object	Refer to EnhancedDownloadSignedUrlResponse below

---

RequestEstimates

cost and time are arrays with two integers each, representing lower and upper bounds of the estimate.

Property	Type	Description
cost	Array	Cost range (in credits)
time	Array	Time range (in seconds)

---

VideoProcessingStatIntermediate

Property	Type	Description
chunkId	UUID	Unique chunk identifier
chunkIndex	Integer	Index of the chunk
taskIndex	Integer	Task index for chunk processing
status	String	Status (queued, processing, complete, etc.)
gpuUtilization	Integer	GPU utilization in percentage
gpuMemoryUtilization	Integer	GPU memory usage percentage
fps	Number	Processing speed of the node
progress	Number	Processing progress (percentage)

---

EnhancedDownloadSignedUrlResponse

Property	Type	Description
url	String	Signed download URL for the enhanced file
expiresIn	Integer	TTL in milliseconds
expiresAt	Integer	Time in milliseconds since UTC epoch

Authorizations

apiKey

X-API-KeystringRequired

Path parameters

requestIdstring · uuidRequiredExample: c1f96dc2-c448-00e6-82ed-14ecb6403c62

Responses

200

Successful response

application/json

statusstring · enumOptionalExample: processingPossible values:

progressnumberOptional

Total progress of the request in percentage

Example: 82

outputSizestringOptionalExample: 10 GB

averageFpsnumberOptional

Average processing speed of each node

Example: 1.23

combinedFpsnumberOptional

Combined processing speed of all nodes

Example: 12.34

messagestringOptionalExample: Processing

401

Unauthorized

application/json

403

Forbidden

application/json

404

Enhancement request with the provided ID not found

application/json

500

Internal server error

application/json

get

/video/{requestId}/status

HTTPcURLJavaScriptPython

GET /video/{requestId}/status HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "status": "processing",
  "progress": 82,
  "estimates": {
    "cost": [
      10,
      12
    ],
    "time": [
      600,
      700
    ]
  },
  "outputSize": "10 GB",
  "averageFps": 1.23,
  "combinedFps": 12.34,
  "message": "Processing",
  "processingJobs": [
    {
      "chunkId": "0193b36c-b37f-7997-ab75-c85f61b451e8",
      "chunkIndex": 0,
      "taskIndex": 0,
      "status": "processing",
      "gpuUtilization": 56,
      "gpuMemoryUtilization": 65,
      "sampleCount": 20,
      "currentFrame": 123,
      "expectedOutputFrames": 320,
      "latestLogTs": 1727213410471,
      "currentSize": 123456,
      "fps": 2.34,
      "progress": 90
    },
    {
      "chunkId": "0193b36c-b37f-7997-ab75-c85f61b451e9",
      "chunkIndex": 1,
      "taskIndex": 0,
      "status": "processing",
      "gpuUtilization": 65,
      "gpuMemoryUtilization": 56,
      "sampleCount": 20,
      "currentFrame": 123,
      "expectedOutputFrames": 319,
      "latestLogTs": 1727213410471,
      "currentSize": 123456,
      "fps": 2.34,
      "progress": 89
    }
  ],
  "download": {
    "url": "https://videocloud.r2.cloudflarestorage.com/0193893a-a2ba-799e-b258-928f02c0f419/enhanced.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256...x-id=GetObject",
    "expiresIn": 86400000,
    "expiresAt": 1727213400000
  }
}