Quickstart

This walks through the shortest path from an API key to a rendered video: find a template, check what it needs, generate, poll for the result, download it.

Get an API key

Create a key from the dashboard’s API Keys page. Copy the raw key immediately — it’s shown once.

export TRUEFAN_API_KEY="tf_live_..."

List your templates

Find the template_id of a template you’ve already built in the editor.

curl "https://dev-backend-ai.truefans.in/api/external/v1/templates/" \
  -H "Authorization: Bearer $TRUEFAN_API_KEY"

Response (abridged)

{
  "templates": [
    {
      "template_id": "7a4facd6-136f-4d8a-8db6-0eb3b3e7086f",
      "name": "Customer shoutout",
      "aspect_ratio": "16:9",
      "estimated_credits": "0.68"
    }
  ],
  "pagination": { "page": 1, "page_size": 30, "total": 1, "total_pages": 1 }
}

Check what the template needs

Every template has a different set of variables — this is computed live, so it’s always accurate.

curl "https://dev-backend-ai.truefans.in/api/external/v1/templates/7a4facd6-136f-4d8a-8db6-0eb3b3e7086f/schema/" \
  -H "Authorization: Bearer $TRUEFAN_API_KEY"

Response

{
  "template_id": "7a4facd6-136f-4d8a-8db6-0eb3b3e7086f",
  "name": "Customer shoutout",
  "variables": [
    { "name": "customer_name", "example_value": "Anmol" },
    { "name": "score", "example_value": "95" }
  ],
  "bulk_generate": {
    "method": "POST",
    "path": "/api/external/v1/templates/7a4facd6-136f-4d8a-8db6-0eb3b3e7086f/bulk-generate/",
    "body": { "rows": [{ "customer_name": "Anmol", "score": "95" }], "batch_name": "string (optional)" }
  }
}

Generate a video

Send one row in rows for a single video:

curl -X POST "https://dev-backend-ai.truefans.in/api/external/v1/templates/7a4facd6-136f-4d8a-8db6-0eb3b3e7086f/bulk-generate/" \
  -H "Authorization: Bearer $TRUEFAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows": [{"customer_name": "Anmol", "score": "95"}]}'

Response

{
  "bulk_job_id": "8c1f2e3a-...",
  "status": "pending",
  "row_count": 1,
  "estimated_credits": "0.68"
}

Generation happens asynchronously — this response confirms the job was accepted, not that the video is ready.

Poll for the result

curl "https://dev-backend-ai.truefans.in/api/external/v1/bulk-jobs/8c1f2e3a-.../status/" \
  -H "Authorization: Bearer $TRUEFAN_API_KEY"

Response (once complete)

{
  "bulk_job_id": "8c1f2e3a-...",
  "status": "done",
  "summary": { "total": 1, "success": 1, "failed": 0, "pending": 0 },
  "csv_ready": true
}

Instead of polling, you can configure a webhook to be notified the moment the job completes.

Download the result

Once csv_ready is true, download the finished video’s URL:

curl "https://dev-backend-ai.truefans.in/api/external/v1/bulk-jobs/8c1f2e3a-.../export.csv" \
  -H "Authorization: Bearer $TRUEFAN_API_KEY" \
  -O -J

results.csv

external_id,generation_id,customer_name,score,result_video_url
,f339beb9-305d-4a01-89ef-669b7ec70de3,Anmol,95,https://assets-studio.truefans.in/editor/.../output.mp4

Next steps

Generate many at once

Pass a longer list of rows to render many personalized videos in one call

Skip polling

Get an HTTP callback the moment a video finishes

Get Started

Core Concepts

Guides

Next steps

Generate many at once

Skip polling

​Next steps

Generate many at once

Skip polling

Next steps