Status

This section grants you system status

Get System Status

get

Get status of the video rendering system

Response body

Property	Type	Description
isAvailable	Boolean	System availability status
availabilityMessage	String	Availability message
queueState	Object	Queue utilization and job age details
queueState.utilization	Number	Total jobs (active and pending) divided by scaling group max capacity
queueState.avgJobAge	Number	Average age of job in queue, in minutes
queueState.maxJobAge	Number	Age of oldest job in queue, in minutes
supportedModels	Array	List of supported AI models' short code names

Authorizations

apiKey

X-API-KeystringRequired

Responses

200

Successful response

application/json

500

Internal server error

application/json

get

/video/status

HTTPcURLJavaScriptPython

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

{
  "isAvailable": false,
  "availabilityMessage": "Cloud rendering is temporarily disabled for maintenance",
  "queueState": {
    "utilization": 0.1,
    "avgJobAge": 2,
    "maxJobAge": 3
  },
  "supportedModels": [
    "aaa-9",
    "ahq-12",
    "alq-13",
    "alqs-2",
    "amq-13",
    "amqs-2",
    "apf-2",
    "apo-8",
    "chf-3",
    "chr-2",
    "ddv-3",
    "dtd-4",
    "dtds-2",
    "dtv-4",
    "dtvs-2",
    "gcg-5",
    "ghq-5",
    "iris-2",
    "iris-3",
    "nxf-1",
    "nyx-3",
    "prob-4",
    "rhea-1",
    "thd-3",
    "thf-4",
    "thm-2"
  ]
}