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 '
{
  "sourceUrl": "<string>",
  "referenceUrls": [
    "<string>"
  ],
  "angle": "<string>",
  "audience": "<string>",
  "niche": "<string>",
  "presenterName": "<string>",
  "channelName": "<string>",
  "language": "<string>",
  "targetDurationMinutes": 30.5,
  "titleOptions": 10,
  "brandContext": "<string>",
  "products": [
    {
      "name": "<string>",
      "description": "<string>",
      "url": "<string>",
      "type": "<string>"
    }
  ],
  "projectId": "<string>"
}
'

import requests

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

payload = {
    "sourceUrl": "<string>",
    "referenceUrls": ["<string>"],
    "angle": "<string>",
    "audience": "<string>",
    "niche": "<string>",
    "presenterName": "<string>",
    "channelName": "<string>",
    "language": "<string>",
    "targetDurationMinutes": 30.5,
    "titleOptions": 10,
    "brandContext": "<string>",
    "products": [
        {
            "name": "<string>",
            "description": "<string>",
            "url": "<string>",
            "type": "<string>"
        }
    ],
    "projectId": "<string>"
}
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({
    sourceUrl: '<string>',
    referenceUrls: ['<string>'],
    angle: '<string>',
    audience: '<string>',
    niche: '<string>',
    presenterName: '<string>',
    channelName: '<string>',
    language: '<string>',
    targetDurationMinutes: 30.5,
    titleOptions: 10,
    brandContext: '<string>',
    products: [{name: '<string>', description: '<string>', url: '<string>', type: '<string>'}],
    projectId: '<string>'
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sigmora.org/v1/text/script",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sourceUrl' => '<string>',
    'referenceUrls' => [
        '<string>'
    ],
    'angle' => '<string>',
    'audience' => '<string>',
    'niche' => '<string>',
    'presenterName' => '<string>',
    'channelName' => '<string>',
    'language' => '<string>',
    'targetDurationMinutes' => 30.5,
    'titleOptions' => 10,
    'brandContext' => '<string>',
    'products' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'url' => '<string>',
                'type' => '<string>'
        ]
    ],
    'projectId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"sourceUrl\": \"<string>\",\n  \"referenceUrls\": [\n    \"<string>\"\n  ],\n  \"angle\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"niche\": \"<string>\",\n  \"presenterName\": \"<string>\",\n  \"channelName\": \"<string>\",\n  \"language\": \"<string>\",\n  \"targetDurationMinutes\": 30.5,\n  \"titleOptions\": 10,\n  \"brandContext\": \"<string>\",\n  \"products\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"url\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"projectId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sigmora.org/v1/text/script")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sourceUrl\": \"<string>\",\n  \"referenceUrls\": [\n    \"<string>\"\n  ],\n  \"angle\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"niche\": \"<string>\",\n  \"presenterName\": \"<string>\",\n  \"channelName\": \"<string>\",\n  \"language\": \"<string>\",\n  \"targetDurationMinutes\": 30.5,\n  \"titleOptions\": 10,\n  \"brandContext\": \"<string>\",\n  \"products\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"url\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"projectId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sourceUrl\": \"<string>\",\n  \"referenceUrls\": [\n    \"<string>\"\n  ],\n  \"angle\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"niche\": \"<string>\",\n  \"presenterName\": \"<string>\",\n  \"channelName\": \"<string>\",\n  \"language\": \"<string>\",\n  \"targetDurationMinutes\": 30.5,\n  \"titleOptions\": 10,\n  \"brandContext\": \"<string>\",\n  \"products\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"url\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"projectId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "projectId": "<string>",
  "credits": 123,
  "script": "<unknown>",
  "groundingSources": [
    "<unknown>"
  ],
  "creditBalance": 123
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

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 '
{
  "sourceUrl": "<string>",
  "referenceUrls": [
    "<string>"
  ],
  "angle": "<string>",
  "audience": "<string>",
  "niche": "<string>",
  "presenterName": "<string>",
  "channelName": "<string>",
  "language": "<string>",
  "targetDurationMinutes": 30.5,
  "titleOptions": 10,
  "brandContext": "<string>",
  "products": [
    {
      "name": "<string>",
      "description": "<string>",
      "url": "<string>",
      "type": "<string>"
    }
  ],
  "projectId": "<string>"
}
'

import requests

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

payload = {
    "sourceUrl": "<string>",
    "referenceUrls": ["<string>"],
    "angle": "<string>",
    "audience": "<string>",
    "niche": "<string>",
    "presenterName": "<string>",
    "channelName": "<string>",
    "language": "<string>",
    "targetDurationMinutes": 30.5,
    "titleOptions": 10,
    "brandContext": "<string>",
    "products": [
        {
            "name": "<string>",
            "description": "<string>",
            "url": "<string>",
            "type": "<string>"
        }
    ],
    "projectId": "<string>"
}
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({
    sourceUrl: '<string>',
    referenceUrls: ['<string>'],
    angle: '<string>',
    audience: '<string>',
    niche: '<string>',
    presenterName: '<string>',
    channelName: '<string>',
    language: '<string>',
    targetDurationMinutes: 30.5,
    titleOptions: 10,
    brandContext: '<string>',
    products: [{name: '<string>', description: '<string>', url: '<string>', type: '<string>'}],
    projectId: '<string>'
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sigmora.org/v1/text/script",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sourceUrl' => '<string>',
    'referenceUrls' => [
        '<string>'
    ],
    'angle' => '<string>',
    'audience' => '<string>',
    'niche' => '<string>',
    'presenterName' => '<string>',
    'channelName' => '<string>',
    'language' => '<string>',
    'targetDurationMinutes' => 30.5,
    'titleOptions' => 10,
    'brandContext' => '<string>',
    'products' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'url' => '<string>',
                'type' => '<string>'
        ]
    ],
    'projectId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"sourceUrl\": \"<string>\",\n  \"referenceUrls\": [\n    \"<string>\"\n  ],\n  \"angle\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"niche\": \"<string>\",\n  \"presenterName\": \"<string>\",\n  \"channelName\": \"<string>\",\n  \"language\": \"<string>\",\n  \"targetDurationMinutes\": 30.5,\n  \"titleOptions\": 10,\n  \"brandContext\": \"<string>\",\n  \"products\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"url\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"projectId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sigmora.org/v1/text/script")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sourceUrl\": \"<string>\",\n  \"referenceUrls\": [\n    \"<string>\"\n  ],\n  \"angle\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"niche\": \"<string>\",\n  \"presenterName\": \"<string>\",\n  \"channelName\": \"<string>\",\n  \"language\": \"<string>\",\n  \"targetDurationMinutes\": 30.5,\n  \"titleOptions\": 10,\n  \"brandContext\": \"<string>\",\n  \"products\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"url\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"projectId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sourceUrl\": \"<string>\",\n  \"referenceUrls\": [\n    \"<string>\"\n  ],\n  \"angle\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"niche\": \"<string>\",\n  \"presenterName\": \"<string>\",\n  \"channelName\": \"<string>\",\n  \"language\": \"<string>\",\n  \"targetDurationMinutes\": 30.5,\n  \"titleOptions\": 10,\n  \"brandContext\": \"<string>\",\n  \"products\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"url\": \"<string>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"projectId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "projectId": "<string>",
  "credits": 123,
  "script": "<unknown>",
  "groundingSources": [
    "<unknown>"
  ],
  "creditBalance": 123
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "success": "<unknown>",
  "error": "<string>",
  "details": "<unknown>"
}

Authorizations

Authorization

string

header

required

A workspace API key.

Body

application/json

sourceUrl

string<uri>

required

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

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

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

projectId

string

The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

Response

Success.

success

boolean

required

projectId

string

required

The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back.

Example:

"prj_9x2a4c"

credits

number

required

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

Example:

300

script

any

required

The finished script, its title options and the claim ledger the fact-check produced.

groundingSources

any[]

required

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

creditBalance

number

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

Example:

3900

{key}

any

Read job Adapt a hook

Meta

Themes

Signals

Discovery

Autopilot

Campaigns

Channels

Products

Projects

Jobs

Text

Video

Image

Audio

3D

Script from a video

Authorizations

Body

Response