Get Extract Task

curl --request GET \
  --url https://apis.viggle.ai/api/extract/{task_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apis.viggle.ai/api/extract/{task_id}"

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/extract/{task_id}', 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/{task_id}",
  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/extract/{task_id}"

	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/extract/{task_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apis.viggle.ai/api/extract/{task_id}")

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

{
  "task_id": "ext_a1b2c3d4e5f60718",
  "kind": "static_bin",
  "created_at": "2026-06-12T08:00:00+00:00",
  "updated_at": "2026-06-12T08:03:21+00:00",
  "result": {
    "success": true,
    "stripped_bin_url": "<string>",
    "render_output_urls": [
      "<string>"
    ],
    "glb_url": "<string>",
    "fbx_url": "<string>"
  },
  "error": "The extract task failed.",
  "error_code": "CS-UORC01-017"
}

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

{
  "detail": {
    "error_code": "CS-UORC01-003",
    "message": "Task not found. It may have expired — task records are kept for 1 hour after creation."
  }
}

GET

api

extract

{task_id}

Get Extract Task

curl --request GET \
  --url https://apis.viggle.ai/api/extract/{task_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apis.viggle.ai/api/extract/{task_id}"

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/extract/{task_id}', 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/{task_id}",
  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/extract/{task_id}"

	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/extract/{task_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apis.viggle.ai/api/extract/{task_id}")

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

{
  "task_id": "ext_a1b2c3d4e5f60718",
  "kind": "static_bin",
  "created_at": "2026-06-12T08:00:00+00:00",
  "updated_at": "2026-06-12T08:03:21+00:00",
  "result": {
    "success": true,
    "stripped_bin_url": "<string>",
    "render_output_urls": [
      "<string>"
    ],
    "glb_url": "<string>",
    "fbx_url": "<string>"
  },
  "error": "The extract task failed.",
  "error_code": "CS-UORC01-017"
}

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

{
  "detail": {
    "error_code": "CS-UORC01-003",
    "message": "Task not found. It may have expired — task records are kept for 1 hour after creation."
  }
}

Check where an extract task is at. This comes back right away, so poll it every 5–10 seconds until status is complete or failed.

Permissions. You can only query tasks created by you or your organization — other tasks return 404.

Results expire after 1 hour. Task records are kept for 1 hour after creation; afterwards polling returns 404 CS-UORC01-003. Take your results within 1 hour of creating the task.

State machine

queued → processing → complete | failed

Response fields

Field	Description
`task_id`	The extract task id
`kind`	`static_bin` or `dynamic_fbx`
`status`	`queued`, `processing`, `complete`, or `failed`
`result`	Present when `status` is `complete` — carries signed download links (see below). `null` otherwise
`error`	Short error label when `status` is `failed`
`error_code`	Structured error code when `status` is `failed` (e.g. `CS-UORC01-017`)

Terminal state: `complete`

When status is complete, result returns each artifact as a temporary signed download link via *_url / *_urls fields. Links are valid for 1 hour and re-signed on every poll — if a link expires, just GET again to receive a fresh one. static-bin completed example:

{
  "task_id": "ext_a1b2c3d4e5f60718",
  "kind": "static_bin",
  "status": "complete",
  "created_at": "2026-06-12T08:00:00+00:00",
  "updated_at": "2026-06-12T08:06:40+00:00",
  "result": {
    "success": true,
    "stripped_bin_url": "https://storage.googleapis.com/...character_stripped.bin?X-Goog-Signature=...",
    "render_output_urls": [
      "https://storage.googleapis.com/...thumbnails/thumb0.png?X-Goog-Signature=..."
    ]
  },
  "error": null,
  "error_code": null
}

For dynamic-fbx, result carries the glb / fbx download links (glb_url, fbx_url).

Terminal state: `failed`

When the task fails, the GET itself returns HTTP 200 — the failure is reported in the body’s status / error / error_code fields.

{
  "task_id": "ext_0f9e8d7c6b5a4332",
  "kind": "dynamic_fbx",
  "status": "failed",
  "created_at": "2026-06-12T08:00:00+00:00",
  "updated_at": "2026-06-12T08:02:10+00:00",
  "result": null,
  "error": "The extract task failed.",
  "error_code": "CS-UORC01-017"
}

Polling examples

import requests
import time

task_id = "ext_a1b2c3d4e5f60718"
url = f"https://apis.viggle.ai/api/extract/{task_id}"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

while True:
    data = requests.get(url, headers=headers).json()
    print(f"Status: {data['status']}")

    if data["status"] == "complete":
        print(data["result"])
        break
    elif data["status"] == "failed":
        print(f"Error {data.get('error_code')}: {data.get('error')}")
        break

    time.sleep(5)

const taskId = "ext_a1b2c3d4e5f60718";
const url = `https://apis.viggle.ai/api/extract/${taskId}`;
const headers = { "Authorization": "Bearer YOUR_API_KEY" };

while (true) {
  const data = await fetch(url, { headers }).then(r => r.json());
  console.log(`Status: ${data.status}`);

  if (data.status === "complete") {
    console.log(data.result);
    break;
  } else if (data.status === "failed") {
    console.error(`Error ${data.error_code}: ${data.error}`);
    break;
  }

  await new Promise(r => setTimeout(r, 5000));
}

curl -s "https://apis.viggle.ai/api/extract/ext_a1b2c3d4e5f60718" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authorizations

Authorization

string

header

required

API key passed as Bearer token

Path Parameters

task_id

string

required

Response

Extract task status

task_id

string

Example:

"ext_a1b2c3d4e5f60718"

kind

enum<string>

Available options:

static_bin,

dynamic_fbx

Example:

"static_bin"

status

enum<string>

Task status. Poll until complete or failed.

Available options:

queued,

processing,

complete,

failed

created_at

string<date-time> | null

Example:

"2026-06-12T08:00:00+00:00"

updated_at

string<date-time> | null

Example:

"2026-06-12T08:03:21+00:00"

result

object | null

Present when status is complete. Carries temporary signed download links via *_url / *_urls fields (valid 1 hour, re-signed on every poll). For static_bin: stripped_bin_url, render_output_urls. For dynamic_fbx: glb_url, fbx_url.

Show child attributes

error

string | null

Short error label when status is failed.

Example:

"The extract task failed."

error_code

string | null

Structured error code when status is failed (e.g. CS-UORC01-017).

Example:

"CS-UORC01-017"

Extract Motion (dynamic-fbx)Get Credit Balance

Characters

Scenes

Render

Extract

Credits

Get Extract Task

State machine

Response fields

Terminal state: `complete`

Terminal state: `failed`

Polling examples

Authorizations

Path Parameters

Response

​State machine

​Response fields

​Terminal state: complete

​Terminal state: failed

​Polling examples

Authorizations

Path Parameters

Response

State machine

Response fields

Terminal state: `complete`

Terminal state: `failed`

Polling examples