Extract Motion (dynamic-fbx)

curl --request POST \
  --url https://apis.viggle.ai/api/extract/dynamic-fbx \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form video='@example-file' \
  --form task_id=ext_0f9e8d7c6b5a4332 \
  --form enable_smoothing=false \
  --form target_fps=30

import requests

url = "https://apis.viggle.ai/api/extract/dynamic-fbx"

files = { "video": ("example-file", open("example-file", "rb")) }
payload = {
    "task_id": "ext_0f9e8d7c6b5a4332",
    "enable_smoothing": "false",
    "target_fps": "30"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('video', '<string>');
form.append('task_id', 'ext_0f9e8d7c6b5a4332');
form.append('enable_smoothing', 'false');
form.append('target_fps', '30');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://apis.viggle.ai/api/extract/dynamic-fbx', 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/extract/dynamic-fbx",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_id\"\r\n\r\next_0f9e8d7c6b5a4332\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enable_smoothing\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_fps\"\r\n\r\n30\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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/extract/dynamic-fbx"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_id\"\r\n\r\next_0f9e8d7c6b5a4332\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enable_smoothing\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_fps\"\r\n\r\n30\r\n-----011000010111000001101001--")

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

	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.post("https://apis.viggle.ai/api/extract/dynamic-fbx")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_id\"\r\n\r\next_0f9e8d7c6b5a4332\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enable_smoothing\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_fps\"\r\n\r\n30\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apis.viggle.ai/api/extract/dynamic-fbx")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_id\"\r\n\r\next_0f9e8d7c6b5a4332\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enable_smoothing\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_fps\"\r\n\r\n30\r\n-----011000010111000001101001--"

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

{
  "task_id": "ext_a1b2c3d4e5f60718",
  "kind": "static_bin",
  "workflow_id": "uorc-extract-ext_a1b2c3d4e5f60718",
  "status": "queued"
}

{
  "detail": {
    "error_code": "CS-UORC01-002",
    "message": "Validation failed. Check that the video file is present and target_fps is greater than 0."
  }
}

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

{
  "detail": {
    "error_code": "CS-UORC01-008",
    "message": "Insufficient credits. Top up your balance to continue."
  }
}

{
  "detail": {
    "error_code": "CS-UORC01-015",
    "message": "A task with this id already exists. Use a new task_id."
  }
}

{
  "detail": {
    "error_code": "CS-UORC01-016",
    "message": "Extract service is temporarily unavailable. Retry in a few seconds."
  }
}

POST

api

extract

dynamic-fbx

Extract Motion (dynamic-fbx)

curl --request POST \
  --url https://apis.viggle.ai/api/extract/dynamic-fbx \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form video='@example-file' \
  --form task_id=ext_0f9e8d7c6b5a4332 \
  --form enable_smoothing=false \
  --form target_fps=30

import requests

url = "https://apis.viggle.ai/api/extract/dynamic-fbx"

files = { "video": ("example-file", open("example-file", "rb")) }
payload = {
    "task_id": "ext_0f9e8d7c6b5a4332",
    "enable_smoothing": "false",
    "target_fps": "30"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('video', '<string>');
form.append('task_id', 'ext_0f9e8d7c6b5a4332');
form.append('enable_smoothing', 'false');
form.append('target_fps', '30');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://apis.viggle.ai/api/extract/dynamic-fbx', 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/extract/dynamic-fbx",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_id\"\r\n\r\next_0f9e8d7c6b5a4332\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enable_smoothing\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_fps\"\r\n\r\n30\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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/extract/dynamic-fbx"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_id\"\r\n\r\next_0f9e8d7c6b5a4332\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enable_smoothing\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_fps\"\r\n\r\n30\r\n-----011000010111000001101001--")

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

	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.post("https://apis.viggle.ai/api/extract/dynamic-fbx")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_id\"\r\n\r\next_0f9e8d7c6b5a4332\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enable_smoothing\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_fps\"\r\n\r\n30\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apis.viggle.ai/api/extract/dynamic-fbx")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"task_id\"\r\n\r\next_0f9e8d7c6b5a4332\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enable_smoothing\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"target_fps\"\r\n\r\n30\r\n-----011000010111000001101001--"

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

{
  "task_id": "ext_a1b2c3d4e5f60718",
  "kind": "static_bin",
  "workflow_id": "uorc-extract-ext_a1b2c3d4e5f60718",
  "status": "queued"
}

{
  "detail": {
    "error_code": "CS-UORC01-002",
    "message": "Validation failed. Check that the video file is present and target_fps is greater than 0."
  }
}

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

{
  "detail": {
    "error_code": "CS-UORC01-008",
    "message": "Insufficient credits. Top up your balance to continue."
  }
}

{
  "detail": {
    "error_code": "CS-UORC01-015",
    "message": "A task with this id already exists. Use a new task_id."
  }
}

{
  "detail": {
    "error_code": "CS-UORC01-016",
    "message": "Extract service is temporarily unavailable. Retry in a few seconds."
  }
}

Upload a motion video and get the animation back as animation.glb + animation.fbx. Send it as multipart/form-data.

Asynchronous task. This endpoint returns a task_id immediately and does not block. Poll Get Extract Task until status is complete.State machine: queued → processing → complete | failed

Binary upload. Send the raw file directly as multipart/form-data — no URL or storage path is required.

Video limits: uploads are limited to 100 MB file size and 0.5–600 seconds (10 minutes) duration. Resolution must be at least 64×64 with even width and height. Files outside these limits are rejected with 400 CS-UORC01-002.

Parameters

Send as multipart/form-data.

Parameter	Type	Required	Default	Description
`video`	file	✅	—	Motion-source video (MP4, MOV, WebM). See limits above.
`enable_smoothing`	boolean		`false`	Enable motion smoothing on the extracted animation.
`target_fps`	number		—	Target frame rate (must be > 0). Omit to skip resampling.
`task_id`	string		—	Optional client-supplied id for idempotent retries.

Pricing

Motion extraction is billed by input video duration: 5 credits per second, rounded up to the whole second. Credits are reserved when the task is created, settled when the task completes successfully, and automatically refunded if the task fails. Insufficient balance returns 402 CS-UORC01-008.

Idempotent retries

The task_id form field is optional. Supplying your own task_id enables idempotent retries: re-creating with the same task_id returns 409 CS-UORC01-015. If omitted, the server generates one (format ext_ + 16 hex chars).

Response

{
  "task_id": "ext_0f9e8d7c6b5a4332",
  "kind": "dynamic_fbx",
  "workflow_id": "uorc-extract-ext_0f9e8d7c6b5a4332",
  "status": "queued"
}

workflow_id is an internal processing identifier — clients can ignore it and poll using task_id.

Error Handling

If the request fails, the response includes a structured error with an error_code:

{
  "detail": {
    "error_code": "CS-UORC01-002",
    "error": "invalid_request",
    "message": "target_fps must be > 0."
  }
}

Common error codes for this endpoint:

Code	Cause	Fix
`CS-UORC01-006`	Missing API key	Add `Authorization: Bearer sk-...` header
`CS-UORC01-007`	Invalid or expired API key	Check your key is correct
`CS-UORC01-002`	Validation failed (empty file, `target_fps <= 0`)	Check your form fields
`CS-UORC01-008`	Insufficient credits	Top up credits
`CS-UORC01-015`	`task_id` already in use	Use a new `task_id`
`CS-UORC01-016`	Extract service temporarily unavailable	Retry in a few seconds (HTTP 502)

See Error Codes for the full list. When contacting [email protected], include the error_code and your task_id.

Examples

import requests

url = "https://apis.viggle.ai/api/extract/dynamic-fbx"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

with open("dance.mp4", "rb") as vid:
    resp = requests.post(
        url,
        headers=headers,
        files={"video": ("dance.mp4", vid, "video/mp4")},
        data={"enable_smoothing": "true", "target_fps": "30"},
    )

data = resp.json()
if "detail" in data:
    print(f"Error {data['detail']['error_code']}: {data['detail']['message']}")
else:
    print(f"Task created: {data['task_id']}")
    print(f"Poll: GET /api/extract/{data['task_id']}")

const form = new FormData();
form.append("video", await fetch("dance.mp4").then(r => r.blob()), "dance.mp4");
form.append("enable_smoothing", "true");
form.append("target_fps", "30");

const resp = await fetch("https://apis.viggle.ai/api/extract/dynamic-fbx", {
  method: "POST",
  headers: { "Authorization": "Bearer YOUR_API_KEY" },
  body: form,
});

const data = await resp.json();
if (data.detail) {
  console.error(`Error ${data.detail.error_code}: ${data.detail.message}`);
} else {
  console.log(`Task created: ${data.task_id}`);
}

curl -s -X POST "https://apis.viggle.ai/api/extract/dynamic-fbx" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "[email protected]" \
  -F "enable_smoothing=true" \
  -F "target_fps=30"

Next Steps

After creating the task, poll Get Extract Task every 5-10 seconds. When status is complete, read the signed download links from result (glb_url, fbx_url).

Authorizations

Authorization

string

header

required

API key passed as Bearer token

Body

multipart/form-data

video

file

required

Input video file (motion source). MP4, MOV, WebM, etc.

task_id

string

Optional client-supplied task id for idempotent retries. Reusing an existing id returns 409. If omitted, the server generates one (format ext_ + 16 hex chars).

Example:

"ext_0f9e8d7c6b5a4332"

enable_smoothing

boolean

default:false

Whether to enable motion smoothing.

target_fps

number<float>

Target frame rate. Must be > 0. Omit to skip resampling.

Example:

30

Response

Extract task created

task_id

string

Task id. Use it to poll GET /api/extract/{task_id}.

Example:

"ext_a1b2c3d4e5f60718"

kind

enum<string>

Extract task kind.

Available options:

static_bin,

dynamic_fbx

Example:

"static_bin"

workflow_id

string

Internal processing identifier. Clients can ignore it — poll with task_id.

Example:

"uorc-extract-ext_a1b2c3d4e5f60718"

status

string

Example:

"queued"

Extract Character (static-bin)Get Extract Task

Characters

Scenes

Render

Extract

Credits

Extract Motion (dynamic-fbx)

Parameters

Pricing

Idempotent retries

Response

Error Handling

Examples

Next Steps

Authorizations

Body

Response

​Parameters

​Pricing

​Idempotent retries

​Response

​Error Handling

​Examples

​Next Steps

Authorizations

Body

Response

Parameters

Pricing

Idempotent retries

Response

Error Handling

Examples

Next Steps