Propose translation

curl --request POST \
  --url https://api.sigmora.org/v1/projects/{projectId}/translations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "languages": [
    "es",
    "pt-BR"
  ],
  "output": "dub"
}
'

import requests

url = "https://api.sigmora.org/v1/projects/{projectId}/translations"

payload = {
    "languages": ["es", "pt-BR"],
    "output": "dub"
}
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({languages: ['es', 'pt-BR'], output: 'dub'})
};

fetch('https://api.sigmora.org/v1/projects/{projectId}/translations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "threadId": "<string>",
  "messageId": "<string>",
  "projectId": "<string>",
  "approval": {
    "tool": "<string>",
    "summary": "<string>",
    "url": "<string>",
    "credits": 0,
    "unavailable": "<string>",
    "approval": "<string>",
    "autoApproved": {
      "credits": 123,
      "result": {}
    }
  },
  "links": {
    "thread": "<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"
}

Propose translation

Propose translating a composition into languages. Sigma’s translate_composition: every language in one approval, each landing in this project as its own editable composition (dubbed, optionally lip-synced and in a chosen voice, or subtitled). Answers the quote, every language at its per-minute price, with a signed approval. Never starts on its own: send approval.approval to POST /v1/sigma/approvals, which charges it and refunds a language that fails; follow it with GET /v1/projects//translations.

POST

projects

{projectId}

translations

Propose translation

curl --request POST \
  --url https://api.sigmora.org/v1/projects/{projectId}/translations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "languages": [
    "es",
    "pt-BR"
  ],
  "output": "dub"
}
'

import requests

url = "https://api.sigmora.org/v1/projects/{projectId}/translations"

payload = {
    "languages": ["es", "pt-BR"],
    "output": "dub"
}
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({languages: ['es', 'pt-BR'], output: 'dub'})
};

fetch('https://api.sigmora.org/v1/projects/{projectId}/translations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "threadId": "<string>",
  "messageId": "<string>",
  "projectId": "<string>",
  "approval": {
    "tool": "<string>",
    "summary": "<string>",
    "url": "<string>",
    "credits": 0,
    "unavailable": "<string>",
    "approval": "<string>",
    "autoApproved": {
      "credits": 123,
      "result": {}
    }
  },
  "links": {
    "thread": "<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"
}

Authorizations

Authorization

string

header

required

A workspace API key.

Headers

idempotency-key

string

required

Required stable id for this request; reuse it after a timeout to receive the same answer.

Required string length: 1 - 255

Path Parameters

projectId

string

required

The project id.

Required string length: 1 - 200

Body

application/json

languages

enum<string>[]

required

Target languages by code (es, fr, pt-BR, ...); each becomes its own editable composition in the project.

Required array length: 1 - 10 elements

Available options:

af,

ak,

sq,

am,

ar,

ar-EG,

hy,

as,

az,

eu,

be,

bs,

bg,

my,

yue,

ca,

ceb,

zh,

zh-TW,

hr,

cs,

da,

dgo,

nl,

en,

en-AU,

en-CA,

en-GB,

en-US,

et,

fil,

fi,

fr,

fr-CA,

fr-FR,

gl,

ka,

de,

el,

gu,

ha,

he,

hi,

hu,

is,

id,

it,

ja,

jv,

kn,

kk,

ki,

rw,

rn,

ko,

ky,

lv,

lt,

lg,

mk,

ms,

ml,

cmn,

mr,

mn,

ne,

no,

fa,

pl,

pt,

pt-BR,

pt-PT,

pa,

ro,

ru,

nso,

st,

sd,

sk,

sl,

es,

es-AR,

es-CL,

es-ES,

es-MX,

su,

sw,

ss,

sv,

tg,

ta,

te,

th,

bo,

ts,

tn,

tr,

uk,

ur,

ug,

uz,

ve,

vi,

war,

cy,

wo,

yo,

zu

output

enum<string>

dub (default): a dubbed video. subtitles: translated captions over the original audio, the cheaper path.

Available options:

dub,

subtitles

timing

enum<string>

match (default): the dub keeps the original timing. direct: a literal translation spoken in a chosen voice (needs voiceIdentityId).

Available options:

match,

direct

lipSync

boolean

Dub only: re-sync the mouth to the new words (priced per minute on the quote).

voiceIdentityId

string

Dub only: speak it in this voice (a consented clone, a designed voice or a premade one). Omit to clone each speaker.

Required string length: 1 - 200

compositionId

string

The composition to translate; the project's first when omitted.

Required string length: 1 - 160

threadId

string

Continue this Sigma conversation instead of starting one.

Required string length: 1 - 200

Response

Success.

success

boolean

required

threadId

string

required

The Sigma conversation the proposal is recorded in.

messageId

string

required

projectId

string | null

required

Where it runs; null for a workspace conversation until it is approved.

approval

object

required

Show child attributes

links

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

Propose translation

Authorizations

Headers

Path Parameters

Body

Response