List Scenes
curl --request GET \
--url https://apis.viggle.ai/api/scenes \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.viggle.ai/api/scenes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.viggle.ai/api/scenes', 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://apis.viggle.ai/api/scenes",
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: Bearer <token>"
],
]);
$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://apis.viggle.ai/api/scenes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apis.viggle.ai/api/scenes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.viggle.ai/api/scenes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"scenes": [
{
"id": "<string>",
"name": "<string>",
"duration_seconds": 123,
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
],
"total": 123
}{
"detail": "Invalid or missing API key. Pass it as Authorization: Bearer sk-..."
}Scenes
List Scenes
List all scenes for your account
GET
/
api
/
scenes
List Scenes
curl --request GET \
--url https://apis.viggle.ai/api/scenes \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.viggle.ai/api/scenes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.viggle.ai/api/scenes', 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://apis.viggle.ai/api/scenes",
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: Bearer <token>"
],
]);
$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://apis.viggle.ai/api/scenes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apis.viggle.ai/api/scenes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.viggle.ai/api/scenes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"scenes": [
{
"id": "<string>",
"name": "<string>",
"duration_seconds": 123,
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
],
"total": 123
}{
"detail": "Invalid or missing API key. Pass it as Authorization: Bearer sk-..."
}Lists all the scenes on your account, newest first. Use it to grab a scene’s
id for rendering, or to see which ones have finished processing and are ready to go.
Got a lot of scenes? Page through them with limit and offset.
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 50 | Max scenes to return (1–100). |
offset | integer | 0 | Number of scenes to skip, for pagination. |
Response
{
"scenes": [
{
"id": "660e8400-e29b-41d4-a716-446655440000",
"name": "Dance Sequence",
"status": "ready",
"duration_seconds": 6.67,
"created_at": "2026-06-12T08:00:00Z",
"completed_at": "2026-06-12T08:01:10Z"
}
],
"total": 1
}
| Field | Description |
|---|---|
scenes[] | The page of scenes, newest first. |
scenes[].id | Scene UUID — pass this as scene_id when rendering. |
scenes[].status | pending, ready, or failed. |
scenes[].duration_seconds | Length of the source video. |
total | Number of scenes returned in this page. |
Example
import requests
url = "https://apis.viggle.ai/api/scenes"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.get(url, headers=headers, params={"limit": 50, "offset": 0})
response.raise_for_status()
result = response.json()
for scene in result["scenes"]:
print(f"{scene['id']}: {scene['name']} ({scene['status']})")
const response = await fetch("https://apis.viggle.ai/api/scenes?limit=50&offset=0", {
headers: { "Authorization": "Bearer YOUR_API_KEY" },
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const result = await response.json();
result.scenes.forEach((scene) => {
console.log(`${scene.id}: ${scene.name} (${scene.status})`);
});
curl -X GET "https://apis.viggle.ai/api/scenes?limit=50&offset=0" \
-H "Authorization: Bearer YOUR_API_KEY"
Next steps
Pick a scene whosestatus is ready and use its id as scene_id in a render job. To inspect one scene, call Get Scene.Authorizations
API key passed as Bearer token
Query Parameters
Required range:
1 <= x <= 100Required range:
x >= 0⌘I

