Get progress of a video generation request
curl --request GET \
--url https://api.example.com/v1/queue/progress/{queueId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/v1/queue/progress/{queueId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/v1/queue/progress/{queueId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/queue/progress/{queueId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/queue/progress/{queueId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/queue/progress/{queueId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/queue/progress/{queueId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "<string>",
"message": "<string>",
"details": {
"status": "<string>",
"generationProgress": 123,
"renderProgress": 123
}
}Queue
Get Queue Progress
Endpoint to check the progress of a specific video generation request in the queue.
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>'import requests
url = "https://api.example.com/v1/queue/progress/{queueId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/v1/queue/progress/{queueId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/queue/progress/{queueId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/queue/progress/{queueId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/queue/progress/{queueId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/queue/progress/{queueId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
| Parameter | Type | Required | Description |
|---|---|---|---|
queueId | string | Yes | The 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
queueIdformat. - 404: Queue item not found.
- 500: Server error.

