Quickstart

What you need: one API key starting with vg_ and either an active credit balance or an active Unlimited package.

Create a job

POST /api/v1/generate accepts a prompt, a model name, and a few parameters. The answer is 202 Accepted — the job is queued, not finished.

cURL
Node.js
Python

curl -X POST https://vidgen.id/api/v1/generate \
  -H "Authorization: Bearer vg_GANTI_DENGAN_KEY_KAMU" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "seedance-2-5-flash",
    "prompt": "Seekor rubah melintasi salju tipis di pagi buta, kamera steadicam mengikuti dari samping",
    "parameters": {
      "duration": "5",
      "ratio": "16:9",
      "resolution": "720p"
    }
  }'

const res = await fetch("https://vidgen.id/api/v1/generate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VIDGEN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    model: "seedance-2-5-flash",
    prompt: "Seekor rubah melintasi salju tipis di pagi buta, kamera steadicam mengikuti dari samping",
    parameters: { duration: "5", ratio: "16:9", resolution: "720p" },
  }),
});

const { job } = await res.json();
console.log(job.id, job.status);

import os
import requests

res = requests.post(
    "https://vidgen.id/api/v1/generate",
    headers={"Authorization": f"Bearer {os.environ['VIDGEN_API_KEY']}"},
    json={
        "model": "seedance-2-5-flash",
        "prompt": "Seekor rubah melintasi salju tipis di pagi buta, kamera steadicam mengikuti dari samping",
        "parameters": {"duration": "5", "ratio": "16:9", "resolution": "720p"},
    },
)

job = res.json()["job"]
print(job["id"], job["status"])

Read the response

The structure is always the same:

{
  "success": true,
  "job": {
    "id": "9f2c1d34-a8b7-4e0f-9a1b-2c3d4e5f6a7b",
    "status": "queued",
    "model": "seedance-2-5-flash",
    "category": "Video",
    "prompt": "Seekor rubah melintasi salju tipis di pagi buta...",
    "creditsCharged": 3,
    "createdAt": "2026-11-04T09:12:44.000Z"
  },
  "queue": {
    "position": 2,
    "status": "queued"
  }
}

Store job.id. Everything that happens next is read through that id.

creditsCharged was already deducted at this step. If the job eventually fails, the credits are refunded automatically — but if you resend the same prompt without an idempotencyKey, you will pay twice.

Poll until it finishes

GET /api/v1/jobs/{jobId} returns the latest status. Check every 5 seconds; short clips usually finish within a few minutes, but queue length plays a part.

curl https://vidgen.id/api/v1/jobs/9f2c1d34-a8b7-4e0f-9a1b-2c3d4e5f6a7b \
  -H "Authorization: Bearer vg_GANTI_DENGAN_KEY_KAMU"

{
  "success": true,
  "job": {
    "id": "9f2c1d34-a8b7-4e0f-9a1b-2c3d4e5f6a7b",
    "status": "succeeded",
    "model": "seedance-2-5-flash",
    "category": "Video",
    "queuePosition": null,
    "result": {
      "url": "https://vidgen.id/api/media-proxy?token=...",
      "duration": 5,
      "width": 1280,
      "height": 720
    },
    "errorMessage": null,
    "creditsCharged": 3,
    "createdAt": "2026-11-04T09:12:44.000Z",
    "updatedAt": "2026-11-04T09:15:02.000Z"
  }
}

Possible statuses: queued, dispatching, processing, succeeded, failed, cancelled. Until the status is succeeded, the result field is null.

Download and store it

result.url is guaranteed to be publicly accessible for 24 hours. After that the link stops working.

curl -L -o video.mp4 "https://vidgen.id/api/media-proxy?token=..."

Save the file to your own storage (S3, R2, disk) as soon as the status is succeeded. Do not keep the URL as your archive.

Common next steps

Choose a model and parameters — the catalog can be read at runtime through GET /api/v1/models.
Send reference images/video — for face-lock, products, or motion control.
Safe retries with idempotencyKey.
Error code table.

Get started

Concepts

Guides

Common next steps

​Common next steps

Common next steps