Skip to main content
GET
/
v1
/
queue
/
progress
/
{queueId}
Get progress of a video generation request
curl --request GET \
  --url https://api.example.com/v1/queue/progress/{queueId} \
  --header 'Authorization: <api-key>'
{
  "status": "<string>",
  "message": "<string>",
  "details": {
    "status": "<string>",
    "generationProgress": 123,
    "renderProgress": 123
  }
}
Note: This operation does not consume any account credits.

​
Get Queue Progress

This endpoint allows you to check the progress of a specific video generation request in the queue.

​
Request

  • Endpoint: GET /v1/queue/progress/{queueId}
  • Authorization: Bearer token required

​
Path Parameters

ParameterTypeRequiredDescription
queueIdstringYesThe ID of the queue item to check.

​
Example Request

curl -X GET https://api.videnly.com/v1/queue/progress/xxxxxxxxxxxxxxxxxxxxxxxx \
-H "Authorization: Bearer YOUR_API_KEY"

​
Response

A successful response will return the current status and progress of the specified queue item.

​
Example Response

{
   "status": "success",
   "message": "Queue item progress retrieved successfully",
   "details": {
      "status": "pending",
      "generationProgress": 50,
      "renderProgress": 0
   }
}
  • status: Overall status of the request.
  • message: Descriptive message of the result.
  • details: Object containing the current status of the queue item and its progress.

​
Possible Error Responses

  • 400: Invalid queueId format.
  • 404: Queue item not found.
  • 500: Server error.

Authorizations

​
Authorization
string
header
required

Use format Bearer YOUR_API_KEY.

Path Parameters

​
queueId
string
required

The unique ID of the queue item to retrieve progress for

Response

Queue item progress retrieved successfully

​
status
string
​
message
string
​
details
object