Import Template

curl --request POST \
  --url https://apis.viggle.ai/api/scenes/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_uuid": "template_uuid",
  "name": "Group Dance"
}
'

import requests

url = "https://apis.viggle.ai/api/scenes/import"

payload = {
    "template_uuid": "template_uuid",
    "name": "Group Dance"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({template_uuid: 'template_uuid', name: 'Group Dance'})
};

fetch('https://apis.viggle.ai/api/scenes/import', 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/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'template_uuid' => 'template_uuid',
    'name' => 'Group Dance'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apis.viggle.ai/api/scenes/import"

	payload := strings.NewReader("{\n  \"template_uuid\": \"template_uuid\",\n  \"name\": \"Group Dance\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apis.viggle.ai/api/scenes/import")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"template_uuid\": \"template_uuid\",\n  \"name\": \"Group Dance\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apis.viggle.ai/api/scenes/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"template_uuid\": \"template_uuid\",\n  \"name\": \"Group Dance\"\n}"

response = http.request(request)
puts response.read_body

{
  "scene_id": "770e8400-e29b-41d4-a716-446655440000",
  "job_id": "scene_770e8400e29b",
  "status": "pending",
  "message": "Scene import initiated. Check status for updates.",
  "character_uuids": [
    "person_a1b2c3d4",
    "person_e5f6g7h8"
  ]
}

{
  "detail": "Invalid or missing API key. Pass it as Authorization: Bearer sk-..."
}

{
  "detail": {
    "error_code": "CS-UORC01-003",
    "message": "Template not found. Double-check the template_uuid."
  }
}

POST

api

scenes

import

Import Template

curl --request POST \
  --url https://apis.viggle.ai/api/scenes/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_uuid": "template_uuid",
  "name": "Group Dance"
}
'

import requests

url = "https://apis.viggle.ai/api/scenes/import"

payload = {
    "template_uuid": "template_uuid",
    "name": "Group Dance"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({template_uuid: 'template_uuid', name: 'Group Dance'})
};

fetch('https://apis.viggle.ai/api/scenes/import', 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/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'template_uuid' => 'template_uuid',
    'name' => 'Group Dance'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apis.viggle.ai/api/scenes/import"

	payload := strings.NewReader("{\n  \"template_uuid\": \"template_uuid\",\n  \"name\": \"Group Dance\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apis.viggle.ai/api/scenes/import")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"template_uuid\": \"template_uuid\",\n  \"name\": \"Group Dance\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apis.viggle.ai/api/scenes/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"template_uuid\": \"template_uuid\",\n  \"name\": \"Group Dance\"\n}"

response = http.request(request)
puts response.read_body

{
  "scene_id": "770e8400-e29b-41d4-a716-446655440000",
  "job_id": "scene_770e8400e29b",
  "status": "pending",
  "message": "Scene import initiated. Check status for updates.",
  "character_uuids": [
    "person_a1b2c3d4",
    "person_e5f6g7h8"
  ]
}

{
  "detail": "Invalid or missing API key. Pass it as Authorization: Bearer sk-..."
}

{
  "detail": {
    "error_code": "CS-UORC01-003",
    "message": "Template not found. Double-check the template_uuid."
  }
}

Bring a scene into your account straight from a Viggle template. There are two kinds:

Multi-person templates — come with tracked person UUIDs for each person in the video
Video templates — plain video scenes, no person tracking

You don’t need to tell us which is which — we figure out the type automatically from the UUID.

You can browse and copy template UUIDs over at viggle.ai — the Import Templates guide walks you through it. Importing is free; you only pay credits when you render.

Parameters

Send as JSON (Content-Type: application/json).

Parameter	Type	Required	Description
`template_uuid`	string	✅	The Viggle template UUID (multi-person or video template).
`name`	string		Optional display name for the imported scene.

Response

{
  "scene_id": "770e8400-e29b-41d4-a716-446655440000",
  "job_id": "scene_770e8400e29b",
  "status": "pending",
  "message": "Scene import initiated. Check status for updates.",
  "character_uuids": ["person_a1b2c3d4", "person_e5f6g7h8"]
}

Field	Description
`scene_id`	Scene UUID. Poll Get Scene with it until `status` is `ready`.
`status`	Starts at `pending`; the import runs in the background.
`character_uuids`	Tracked person UUIDs, for multi-person templates only. Empty/absent for plain video templates.

Example

import requests

url = "https://apis.viggle.ai/api/scenes/import"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
data = {
    "template_uuid": "YOUR_TEMPLATE_UUID",
}

response = requests.post(url, headers=headers, json=data)
response.raise_for_status()
result = response.json()
print(f"Scene ID: {result['scene_id']}")
print(f"Status: {result['status']}")
if result.get("character_uuids"):
    print("Tracked persons:")
    for uuid in result["character_uuids"]:
        print(f"  - {uuid}")

const response = await fetch("https://apis.viggle.ai/api/scenes/import", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    template_uuid: "YOUR_TEMPLATE_UUID",
  }),
});

const result = await response.json();

if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(`Scene ID: ${result.scene_id}`);
console.log(`Status: ${result.status}`);
if (result.character_uuids) {
  console.log("Tracked persons:");
  result.character_uuids.forEach((uuid) => console.log(`  - ${uuid}`));
}

curl -X POST https://apis.viggle.ai/api/scenes/import \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"template_uuid": "YOUR_TEMPLATE_UUID"}'

Authorizations

Authorization

string

header

required

API key passed as Bearer token

Body

application/json

template_uuid

string

required

Viggle template UUID (multi-person or video template)

Example:

"template_uuid"

name

string

Optional display name for the scene

Example:

"Group Dance"

Response

Scene imported

scene_id

string

Scene UUID

Example:

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

job_id

string

Example:

"scene_770e8400e29b"

status

string

Example:

"pending"

message

string

Example:

"Scene import initiated. Check status for updates."

character_uuids

string[]

UUIDs of tracked persons in the template.

Example:

["person_a1b2c3d4", "person_e5f6g7h8"]

Delete Scene Render API Overview

Characters

Scenes

Render

Extract

Credits

Import Template

Parameters

Response

Example

Authorizations

Body

Response

​Parameters

​Response

​Example

Authorizations

Body

Response

Parameters

Response

Example