Make a video

curl --request POST \
  --url https://api.sigmora.org/v1/video/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "prompt": "A 30-second launch video for PocketLedger: snap a receipt, and the budget updates before you leave the shop. End on the free trial.",
  "aspect": "9:16",
  "duration": "30s-1min",
  "brandKitId": "brd_4b81",
  "attachments": [
    {
      "url": "https://cdn.example.com/products/pocketledger-phone.png",
      "name": "The app on a phone",
      "type": "image"
    }
  ],
  "review": "plan"
}
'

import requests

url = "https://api.sigmora.org/v1/video/create"

payload = {
    "prompt": "A 30-second launch video for PocketLedger: snap a receipt, and the budget updates before you leave the shop. End on the free trial.",
    "aspect": "9:16",
    "duration": "30s-1min",
    "brandKitId": "brd_4b81",
    "attachments": [
        {
            "url": "https://cdn.example.com/products/pocketledger-phone.png",
            "name": "The app on a phone",
            "type": "image"
        }
    ],
    "review": "plan"
}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prompt: 'A 30-second launch video for PocketLedger: snap a receipt, and the budget updates before you leave the shop. End on the free trial.',
    aspect: '9:16',
    duration: '30s-1min',
    brandKitId: 'brd_4b81',
    attachments: [
      {
        url: 'https://cdn.example.com/products/pocketledger-phone.png',
        name: 'The app on a phone',
        type: 'image'
      }
    ],
    review: 'plan'
  })
};

fetch('https://api.sigmora.org/v1/video/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "quote": {
    "capability": "<string>",
    "credits": 123,
    "balance": 123,
    "sufficient": true,
    "budgetCapped": true
  }
}

{
  "success": true,
  "jobId": "<string>",
  "projectId": "<string>",
  "projectUrl": "<string>",
  "status": "queued",
  "quotedCredits": 123,
  "job": {
    "id": "job_4k1b7d",
    "kind": "video.render",
    "status": "queued",
    "workflow": "ugc",
    "projectUrl": "<string>",
    "pendingUserInput": {
      "kind": "plan_review",
      "message": "<string>"
    },
    "plan": {},
    "output": {
      "status": "pending",
      "downloadUrl": "<string>",
      "playbackUrl": "<string>",
      "thumbnailUrl": "<string>",
      "expiresAt": "<string>",
      "videoJobId": "<string>"
    },
    "sources": [
      {
        "sourceKind": "licensed_library",
        "provider": "<string>",
        "providerAssetId": "<string>",
        "sourceUrl": "<string>",
        "mediaType": "image",
        "title": "<string>",
        "credit": "<string>",
        "rightsStatus": "licensed",
        "usages": [
          {
            "scene": 0,
            "startSeconds": 123,
            "endSeconds": 123,
            "sceneId": "<string>"
          }
        ]
      }
    ],
    "sourcesTiming": "estimated",
    "phase": "<string>",
    "artifacts": {
      "assetId": "<string>",
      "video": "https://api.sigmora.org/render/job_4k1b7d/download/video?exp=1785700000&sig=9f2c&ws=ws_acme",
      "playback": "<string>",
      "download": "<string>",
      "thumbnail": "<string>",
      "srt": "<string>",
      "vtt": "<string>",
      "youtube": "<string>",
      "metadata": "<string>",
      "scriptReview": "<string>",
      "runJson": "<string>",
      "descriptors": [
        {
          "kind": "<string>",
          "sha256": "<string>",
          "bytes": 4503599627370495,
          "mime": "<string>",
          "url": "<string>",
          "expiresAt": "2023-11-07T05:31:56Z",
          "durable": true,
          "name": "<string>"
        }
      ],
      "outputKind": "<string>",
      "parentJobId": "<string>",
      "summary": {},
      "packaging": {},
      "review": {}
    },
    "qualityEvidence": {
      "schemaVersion": "video-quality-evidence.v1",
      "engine": "<string>",
      "runId": "<string>",
      "recordedAt": "2023-11-07T05:31:56Z",
      "quality": "<string>",
      "duration": {
        "actualSeconds": 1,
        "targetSeconds": 1,
        "toleranceSeconds": 1,
        "withinTarget": true
      },
      "qa": {
        "passed": true,
        "failed": [
          "<string>"
        ],
        "publishBlocking": [
          "<string>"
        ],
        "checks": [
          {
            "name": "<string>",
            "passed": true,
            "message": "<string>",
            "blocking": true,
            "metric": "<unknown>"
          }
        ],
        "reportDigest": "<string>"
      },
      "captionDelivery": {
        "enabled": true,
        "mode": "<string>",
        "srt": "<string>",
        "vtt": "<string>",
        "softTrack": true,
        "burnProvenance": "<string>",
        "style": "<string>",
        "evidence": {}
      },
      "renderAudit": {},
      "sourceEvidence": {
        "check": {},
        "citations": [
          {
            "url": "<string>",
            "title": "",
            "claimIds": [
              "<string>"
            ],
            "sha256": "<string>"
          }
        ],
        "rights": [
          {
            "status": "<string>",
            "confirmed": true,
            "assetId": "<string>",
            "sourceUrl": "<string>",
            "owner": "<string>",
            "license": "<string>",
            "attribution": "<string>",
            "confirmedBy": "<string>",
            "confirmedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "ledger": {}
      },
      "capability": {
        "service": "<string>",
        "schemaRevision": "<string>",
        "schemaDigest": "<string>",
        "snapshot": {}
      },
      "artifacts": [
        {
          "kind": "<string>",
          "sha256": "<string>",
          "bytes": 4503599627370495,
          "mime": "<string>",
          "url": "<string>",
          "expiresAt": "2023-11-07T05:31:56Z",
          "durable": true,
          "name": "<string>"
        }
      ],
      "release": {
        "draft": true,
        "durable": true,
        "eligible": true,
        "publishState": "<string>"
      },
      "productionProfile": {},
      "productionAttestation": {},
      "productionEvidenceContentId": "<string>"
    },
    "productionEvidenceContentId": "<string>",
    "contentEngineContentId": "<string>",
    "releaseIdentity": {
      "callbackJobId": "<string>",
      "evidenceRunId": "<string>",
      "videoContentJobId": "<string>",
      "productionEvidenceJobId": "<string>"
    },
    "wholeCutReview": {
      "schemaVersion": "whole-cut-review.v1",
      "durationSec": 1,
      "framesSampled": 4503599627370495,
      "sheets": 4503599627370495,
      "visionModel": "<string>",
      "findings": [
        {
          "kind": "black",
          "atSec": 1,
          "severity": "low",
          "fixable": true,
          "fix": "loudness_normalize",
          "message": "<string>",
          "endSec": 1,
          "params": {}
        }
      ],
      "fixed": [
        {
          "fix": "loudness_normalize",
          "atSec": 1,
          "message": "<string>",
          "removedSec": 1
        }
      ],
      "visionSkipped": "<string>"
    },
    "package": {
      "status": "pending",
      "shorts": 123,
      "clips": [
        {}
      ],
      "error": "<string>"
    },
    "error": "<string>",
    "errorCode": "<string>",
    "errorHint": "<string>"
  }
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Make a video

Make a video from a prompt in one call: planned, narrated and rendered. Answers at once with one jobId; poll GET /v1/jobs/ through queued, planning, awaiting_user_input (with review: "plan", answered by POST /v1/video/create//followups), rendering, then done with output.downloadUrl and sources[], or failed. Calls beyond the render capacity wait their turn; none is refused for being busy. The render is charged only when the renderer accepts it and refunded if it fails. Quote first with X-Sigmora-Quote-Only.

POST

video

create

Make a video

curl --request POST \
  --url https://api.sigmora.org/v1/video/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "prompt": "A 30-second launch video for PocketLedger: snap a receipt, and the budget updates before you leave the shop. End on the free trial.",
  "aspect": "9:16",
  "duration": "30s-1min",
  "brandKitId": "brd_4b81",
  "attachments": [
    {
      "url": "https://cdn.example.com/products/pocketledger-phone.png",
      "name": "The app on a phone",
      "type": "image"
    }
  ],
  "review": "plan"
}
'

import requests

url = "https://api.sigmora.org/v1/video/create"

payload = {
    "prompt": "A 30-second launch video for PocketLedger: snap a receipt, and the budget updates before you leave the shop. End on the free trial.",
    "aspect": "9:16",
    "duration": "30s-1min",
    "brandKitId": "brd_4b81",
    "attachments": [
        {
            "url": "https://cdn.example.com/products/pocketledger-phone.png",
            "name": "The app on a phone",
            "type": "image"
        }
    ],
    "review": "plan"
}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prompt: 'A 30-second launch video for PocketLedger: snap a receipt, and the budget updates before you leave the shop. End on the free trial.',
    aspect: '9:16',
    duration: '30s-1min',
    brandKitId: 'brd_4b81',
    attachments: [
      {
        url: 'https://cdn.example.com/products/pocketledger-phone.png',
        name: 'The app on a phone',
        type: 'image'
      }
    ],
    review: 'plan'
  })
};

fetch('https://api.sigmora.org/v1/video/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "quote": {
    "capability": "<string>",
    "credits": 123,
    "balance": 123,
    "sufficient": true,
    "budgetCapped": true
  }
}

{
  "success": true,
  "jobId": "<string>",
  "projectId": "<string>",
  "projectUrl": "<string>",
  "status": "queued",
  "quotedCredits": 123,
  "job": {
    "id": "job_4k1b7d",
    "kind": "video.render",
    "status": "queued",
    "workflow": "ugc",
    "projectUrl": "<string>",
    "pendingUserInput": {
      "kind": "plan_review",
      "message": "<string>"
    },
    "plan": {},
    "output": {
      "status": "pending",
      "downloadUrl": "<string>",
      "playbackUrl": "<string>",
      "thumbnailUrl": "<string>",
      "expiresAt": "<string>",
      "videoJobId": "<string>"
    },
    "sources": [
      {
        "sourceKind": "licensed_library",
        "provider": "<string>",
        "providerAssetId": "<string>",
        "sourceUrl": "<string>",
        "mediaType": "image",
        "title": "<string>",
        "credit": "<string>",
        "rightsStatus": "licensed",
        "usages": [
          {
            "scene": 0,
            "startSeconds": 123,
            "endSeconds": 123,
            "sceneId": "<string>"
          }
        ]
      }
    ],
    "sourcesTiming": "estimated",
    "phase": "<string>",
    "artifacts": {
      "assetId": "<string>",
      "video": "https://api.sigmora.org/render/job_4k1b7d/download/video?exp=1785700000&sig=9f2c&ws=ws_acme",
      "playback": "<string>",
      "download": "<string>",
      "thumbnail": "<string>",
      "srt": "<string>",
      "vtt": "<string>",
      "youtube": "<string>",
      "metadata": "<string>",
      "scriptReview": "<string>",
      "runJson": "<string>",
      "descriptors": [
        {
          "kind": "<string>",
          "sha256": "<string>",
          "bytes": 4503599627370495,
          "mime": "<string>",
          "url": "<string>",
          "expiresAt": "2023-11-07T05:31:56Z",
          "durable": true,
          "name": "<string>"
        }
      ],
      "outputKind": "<string>",
      "parentJobId": "<string>",
      "summary": {},
      "packaging": {},
      "review": {}
    },
    "qualityEvidence": {
      "schemaVersion": "video-quality-evidence.v1",
      "engine": "<string>",
      "runId": "<string>",
      "recordedAt": "2023-11-07T05:31:56Z",
      "quality": "<string>",
      "duration": {
        "actualSeconds": 1,
        "targetSeconds": 1,
        "toleranceSeconds": 1,
        "withinTarget": true
      },
      "qa": {
        "passed": true,
        "failed": [
          "<string>"
        ],
        "publishBlocking": [
          "<string>"
        ],
        "checks": [
          {
            "name": "<string>",
            "passed": true,
            "message": "<string>",
            "blocking": true,
            "metric": "<unknown>"
          }
        ],
        "reportDigest": "<string>"
      },
      "captionDelivery": {
        "enabled": true,
        "mode": "<string>",
        "srt": "<string>",
        "vtt": "<string>",
        "softTrack": true,
        "burnProvenance": "<string>",
        "style": "<string>",
        "evidence": {}
      },
      "renderAudit": {},
      "sourceEvidence": {
        "check": {},
        "citations": [
          {
            "url": "<string>",
            "title": "",
            "claimIds": [
              "<string>"
            ],
            "sha256": "<string>"
          }
        ],
        "rights": [
          {
            "status": "<string>",
            "confirmed": true,
            "assetId": "<string>",
            "sourceUrl": "<string>",
            "owner": "<string>",
            "license": "<string>",
            "attribution": "<string>",
            "confirmedBy": "<string>",
            "confirmedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "ledger": {}
      },
      "capability": {
        "service": "<string>",
        "schemaRevision": "<string>",
        "schemaDigest": "<string>",
        "snapshot": {}
      },
      "artifacts": [
        {
          "kind": "<string>",
          "sha256": "<string>",
          "bytes": 4503599627370495,
          "mime": "<string>",
          "url": "<string>",
          "expiresAt": "2023-11-07T05:31:56Z",
          "durable": true,
          "name": "<string>"
        }
      ],
      "release": {
        "draft": true,
        "durable": true,
        "eligible": true,
        "publishState": "<string>"
      },
      "productionProfile": {},
      "productionAttestation": {},
      "productionEvidenceContentId": "<string>"
    },
    "productionEvidenceContentId": "<string>",
    "contentEngineContentId": "<string>",
    "releaseIdentity": {
      "callbackJobId": "<string>",
      "evidenceRunId": "<string>",
      "videoContentJobId": "<string>",
      "productionEvidenceJobId": "<string>"
    },
    "wholeCutReview": {
      "schemaVersion": "whole-cut-review.v1",
      "durationSec": 1,
      "framesSampled": 4503599627370495,
      "sheets": 4503599627370495,
      "visionModel": "<string>",
      "findings": [
        {
          "kind": "black",
          "atSec": 1,
          "severity": "low",
          "fixable": true,
          "fix": "loudness_normalize",
          "message": "<string>",
          "endSec": 1,
          "params": {}
        }
      ],
      "fixed": [
        {
          "fix": "loudness_normalize",
          "atSec": 1,
          "message": "<string>",
          "removedSec": 1
        }
      ],
      "visionSkipped": "<string>"
    },
    "package": {
      "status": "pending",
      "shorts": 123,
      "clips": [
        {}
      ],
      "error": "<string>"
    },
    "error": "<string>",
    "errorCode": "<string>",
    "errorHint": "<string>"
  }
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

A workspace API key.

Headers

idempotency-key

string

required

Required durable retry key. Reuse only for the identical logical request; a different payload returns conflict.

Required string length: 1 - 255

x-sigmora-quote-only

string

Send 1 to get the price and balance without running anything.

Allowed value: "1"

x-sigmora-max-credits

string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json

prompt

string

required

What the video is: the brief, the script, or notes. Up to 12,000 characters.

Required string length: 1 - 12000

projectId

string

The project to make it in. Omitted: a new project is created and its id returned.

Required string length: 1 - 200

aspect

enum<string>

The delivered frame: 9:16 (default), 16:9, 1:1, 4:5 or 21:9.

Available options:

9:16,

16:9,

1:1,

4:5,

21:9

duration

About how long: a bucket (<10s, 10-30s, 30s-1min, 1-5min) or whole seconds from 3 to 600. Omitted: the planner fits the brief (or the style reference).

Available options:

<10s,

10-30s,

30s-1min,

1-5min

templateId

enum<string>

A house video template to lock the look to (see video.options). Omitted: the brand kit default, else the planner picks.

Available options:

editorial-signal,

night-interface,

evidence-ledger,

footage-journal,

presenter-focus,

founder-editorial,

kinetic-impact

brandKitId

string

A brand (GET /v1/brands) whose kit (voice, look, words) the video uses. Omitted: the project brand, else the workspace brand.

Required string length: 1 - 200

styleReferenceUrl

string

A video to borrow the structure and feel of (hook, pacing, shots, captions, music): one TikTok, Instagram, YouTube or X post, or a link to a video file. It is broken down once (priced as a video analysis) and nothing of it is copied.

Required string length: 1 - 2048

attachments

object[]

Up to 100 files or pages to use. Attaching a file confirms you may use it in this video.

Maximum array length: 100

Show child attributes

remixOf

string

A past projectId to make another like: its frame, length, captions, template, visuals, voice and Brand carry over; its footage and words do not.

Required string length: 1 - 200

designMd

A DESIGN.md for this video only: its palette leads the render, its type, corners and motion rules steer the scenes, and its tone joins the voice. Markdown text, or { content, jsonContent, fileName, sourceUrl }. No Brand is changed.

Required string length: 1 - 40000

review

enum<string>

auto (default): plan, then render at the quoted price. plan: stop at awaiting_user_input with the plan; approve or revise it with video_followup.

Available options:

auto,

plan

{key}

any

Response

Success.

success

boolean

required

quote

object

required

Show child attributes

{key}

any

Meta

Projects

Sessions

Assets

Jobs

Text

Video

UGC

Editing

3D

Image

Audio

Publishing

Webhooks

Workflows

Agents

Research

Themes

Signals

Discovery

Watchlist

Performance

Autopilot

Campaigns

Brands

Products

Make a video

Authorizations

Headers

Body

Response