Skip to main content
GET
/
api
/
scenes
/
{scene_id}
Get Scene
curl --request GET \
  --url https://apis.viggle.ai/api/scenes/{scene_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "660e8400-e29b-41d4-a716-446655440000",
  "name": "Dance Sequence",
  "status": "pending",
  "duration_seconds": 6.67,
  "fps": 30,
  "total_frames": 200,
  "width": 1920,
  "height": 1080,
  "job_id": "scene_660e8400e29b",
  "error_message": "<string>",
  "credits_used": 6.67,
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}
Retrieve details for a specific scene. Use this endpoint to poll for processing status.
Poll every 5 seconds until status is ready or failed.

​
Example

import requests

scene_id = "YOUR_SCENE_ID"
url = f"https://apis.viggle.ai/api/scenes/{scene_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

response = requests.get(url, headers=headers)
result = response.json()

if result.get("error_code"):
    print(f"Error: {result['error_code']} - {result.get('message')}")
else:
    scene = result["data"]
    print(f"Name: {scene['name']}")
    print(f"Status: {scene['status']}")

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Path Parameters

​
scene_id
string
required

Response

Scene details

​
id
string
Example:

"660e8400-e29b-41d4-a716-446655440000"

​
name
string
Example:

"Dance Sequence"

​
status
enum<string>
Available options:
pending,
ready,
failed
​
duration_seconds
number | null
Example:

6.67

​
fps
number | null
Example:

30

​
total_frames
integer | null
Example:

200

​
width
integer | null
Example:

1920

​
height
integer | null
Example:

1080

​
job_id
string | null
Example:

"scene_660e8400e29b"

​
error_message
string | null
​
credits_used
number | null
Example:

6.67

​
created_at
string<date-time> | null
​
completed_at
string<date-time> | null