API Reference

X-API-Key: sf_live_a1b2c3d4e5f6...

# Or using Authorization header:
Authorization: Bearer sf_live_a1b2c3d4e5f6...

https://app.sigfigsstudio.com/api

curl -X POST https://app.sigfigsstudio.com/api/templates \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sf_live_YOUR_KEY" \
  -d '{
    "name": "Quarterly Review",
    "scenes": [
      { "primitiveId": "title-intro", "voScript": "Welcome to Q[quarter] [year]." },
      { "primitiveId": "stat-counters", "voScript": "[revenue] in revenue. [growth]% growth." },
      { "primitiveId": "bar-race" },
      { "primitiveId": "comparison-bars" },
      { "primitiveId": "outro" }
    ],
    "dataSlots": [
      { "key": "revenue", "type": "number", "required": true },
      { "key": "growth", "type": "number" },
      { "key": "quarter", "type": "text", "required": true }
    ],
    "defaults": { "voiceId": "en-GB-RyanNeural", "accentColor": "#6366F1" }
  }'

curl -X POST https://app.sigfigsstudio.com/api/templates \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sf_live_YOUR_KEY" \
  -d '{
    "name": "My Custom Emeritus",
    "forkFrom": "emeritus",
    "scenes": [
      { "primitiveId": "title-intro", "voScript": "Celebrating [name]." },
      { "primitiveId": "radar" },
      { "primitiveId": "bar-race" },
      { "primitiveId": "world-map" },
      { "primitiveId": "outro" }
    ]
  }'

{
  "success": true,
  "template": {
    "id": "clx1abc2def3...",
    "name": "My Custom Emeritus",
    "scenes": [...],
    "baseTemplateId": "emeritus",
    "visibility": "private"
  },
  "message": "Template forked from emeritus."
}

curl https://app.sigfigsstudio.com/api/primitives

# Filter by category
curl https://app.sigfigsstudio.com/api/primitives?category=Data%20Viz

{
  "success": true,
  "primitives": [
    {
      "id": "bar-race",
      "label": "Bar Chart Race",
      "category": "Data Viz",
      "description": "Animated ranking race over time",
      "animationOptions": ["animate-on-init"],
      "defaultDuration": 6,
      "dataInputs": ["items[]", "values[]"]
    },
    ...
  ],
  "categories": ["Text", "Data Viz", "Gamification", "Comparison", ...],
  "total": 72
}

import requests

API_KEY = "sf_live_YOUR_KEY"
BASE = "https://app.sigfigsstudio.com/api"

# Render a video
job = requests.post(f"{BASE}/render", json={
    "templateId": "emeritus",
    "data": {"authorId": "A5001825849"},
}, headers={"X-API-Key": API_KEY}).json()

print(f"Job created: {job['jobId']}")

# Poll for completion
import time
while True:
    status = requests.get(
        f"{BASE}/render/{job['jobId']}",
        headers={"X-API-Key": API_KEY}
    ).json()
    if status["job"]["status"] == "complete":
        print(f"Video: {status['job']['outputUrl']}")
        break
    time.sleep(5)

const API_KEY = "sf_live_YOUR_KEY";
const BASE = "https://app.sigfigsstudio.com/api";

// Render a video
const { jobId } = await fetch(`${BASE}/render`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": API_KEY,
  },
  body: JSON.stringify({
    templateId: "client-welcome",
    data: {
      company_name: "Meridian Health",
      person_name: "Sarah Chen",
      industry: "Healthcare",
    },
  }),
}).then(r => r.json());

// Poll for completion
const poll = setInterval(async () => {
  const { job } = await fetch(
    `${BASE}/render/${jobId}`,
    { headers: { "X-API-Key": API_KEY } }
  ).then(r => r.json());

  if (job.status === "complete") {
    clearInterval(poll);
    console.log("Video:", job.outputUrl);
  }
}, 5000);