Script from a video

curl --request POST \
  --url https://api.sigmora.org/v1/text/script \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "prj_9x2a4c",
  "sourceUrl": "https://storage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
  "angle": "for someone who has never edited a video before",
  "audience": "first-time creators",
  "niche": "video editing",
  "targetDurationMinutes": 6,
  "titleOptions": 3
}
'

import requests

url = "https://api.sigmora.org/v1/text/script"

payload = {
    "projectId": "prj_9x2a4c",
    "sourceUrl": "https://storage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
    "angle": "for someone who has never edited a video before",
    "audience": "first-time creators",
    "niche": "video editing",
    "targetDurationMinutes": 6,
    "titleOptions": 3
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: 'prj_9x2a4c',
    sourceUrl: 'https://storage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4',
    angle: 'for someone who has never edited a video before',
    audience: 'first-time creators',
    niche: 'video editing',
    targetDurationMinutes: 6,
    titleOptions: 3
  })
};

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

{
  "success": true,
  "credits": 300,
  "script": {},
  "groundingSources": [
    {}
  ],
  "projectId": "prj_9x2a4c",
  "creditBalance": 3900
}

{
  "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"
}

POST

text

script

Script from a video

curl --request POST \
  --url https://api.sigmora.org/v1/text/script \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "prj_9x2a4c",
  "sourceUrl": "https://storage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
  "angle": "for someone who has never edited a video before",
  "audience": "first-time creators",
  "niche": "video editing",
  "targetDurationMinutes": 6,
  "titleOptions": 3
}
'

import requests

url = "https://api.sigmora.org/v1/text/script"

payload = {
    "projectId": "prj_9x2a4c",
    "sourceUrl": "https://storage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4",
    "angle": "for someone who has never edited a video before",
    "audience": "first-time creators",
    "niche": "video editing",
    "targetDurationMinutes": 6,
    "titleOptions": 3
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: 'prj_9x2a4c',
    sourceUrl: 'https://storage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4',
    angle: 'for someone who has never edited a video before',
    audience: 'first-time creators',
    niche: 'video editing',
    targetDurationMinutes: 6,
    titleOptions: 3
  })
};

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

{
  "success": true,
  "credits": 300,
  "script": {},
  "groundingSources": [
    {}
  ],
  "projectId": "prj_9x2a4c",
  "creditBalance": 3900
}

{
  "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

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255

x-sigmora-quote-only

string

Send 1 to get the price, balance and budget verdict 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

sourceUrl

string<uri>

required

The video to watch and build on. Required — this capability starts from footage.

projectId

string

required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

referenceUrls

string<uri>[]

Up to twenty further sources to read while writing. Consulted, not summarised.

Maximum array length: 20

angle

string

The take to write toward, e.g. "for someone who has never invested".

Maximum string length: 500

audience

string

Who is watching. Sets vocabulary and pace.

Maximum string length: 200

niche

string

The subject area, for terminology and framing.

Maximum string length: 200

presenterName

string

Who the script is written for to say.

Maximum string length: 120

channelName

string

The channel it is for, used in the intro.

Maximum string length: 120

language

string

Output language. Defaults to English.

Maximum string length: 60

targetDurationMinutes

number

How long the finished video should run. The script is written to that length.

Required range: 1 <= x <= 60

titleOptions

integer

How many title candidates to return alongside the script.

Required range: 1 <= x <= 20

format

enum<string>

default:full

plaintext answers with only the teleprompter-ready script — { working_title, full_script } — and skips the research ledger and the SEO packaging. For when the script is CONTEXT something reads to decide what to do next, rather than a deliverable to store: same work, same price, a fraction of the tokens.

Available options:

full,

plaintext

brandContext

string

Anything the writer should know about your brand: voice, claims, things to avoid.

Maximum string length: 4000

products

object[]

Maximum array length: 5

Show child attributes

Response

Success.

Option 1
Option 2

success

boolean

required

credits

number

required

What this call actually cost, which is not always what was quoted.

Example:

300

script

object

required

The finished script, its title options and the claim ledger the fact-check produced. With format: "plaintext" this carries only { working_title, full_script }.

Show child attributes

groundingSources

object[]

required

What was consulted while writing. Empty when nothing was searched.

Show child attributes

projectId

string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance

number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{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

Script from a video

Authorizations

Headers

Body

Response