Transcribe asset

curl --request POST \
  --url https://api.sigmora.org/v1/assets/{assetId}/transcript \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "projectId": "prj_9x2a4c",
  "formats": [
    "text",
    "srt"
  ],
  "instruction": "Redact phone numbers and email addresses."
}
'

import requests

url = "https://api.sigmora.org/v1/assets/{assetId}/transcript"

payload = {
    "projectId": "prj_9x2a4c",
    "formats": ["text", "srt"],
    "instruction": "Redact phone numbers and email addresses."
}
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({
    projectId: 'prj_9x2a4c',
    formats: ['text', 'srt'],
    instruction: 'Redact phone numbers and email addresses.'
  })
};

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

{
  "success": true,
  "projectId": "<string>",
  "assetId": "<string>",
  "result": {
    "transcript": "<string>",
    "durationSec": 123,
    "hasSpeech": true,
    "products": [
      {
        "format": "<string>",
        "content": "<string>",
        "mimeType": "<string>",
        "extension": "<string>"
      }
    ],
    "editedTranscript": {
      "kind": "transcript",
      "text": "<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"
}

Transcribe asset

Transcribe a workspace asset into timed products; optionally rewrite the transcript with a plain-language instruction. Holds the quote for the measured length of the asset before recognition and charges only what recognition measured; a ready asset without instruction is formatted from its stored transcript at no charge. instruction is an ElevenLabs Scribe transcript edit (+30%) returned as result.editedTranscript. Quote first with X-Sigmora-Quote-Only, then cap the real call with X-Sigmora-Max-Credits; the same Idempotency-Key returns the same answer.

POST

assets

{assetId}

transcript

Transcribe asset

curl --request POST \
  --url https://api.sigmora.org/v1/assets/{assetId}/transcript \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "projectId": "prj_9x2a4c",
  "formats": [
    "text",
    "srt"
  ],
  "instruction": "Redact phone numbers and email addresses."
}
'

import requests

url = "https://api.sigmora.org/v1/assets/{assetId}/transcript"

payload = {
    "projectId": "prj_9x2a4c",
    "formats": ["text", "srt"],
    "instruction": "Redact phone numbers and email addresses."
}
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({
    projectId: 'prj_9x2a4c',
    formats: ['text', 'srt'],
    instruction: 'Redact phone numbers and email addresses.'
  })
};

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

{
  "success": true,
  "projectId": "<string>",
  "assetId": "<string>",
  "result": {
    "transcript": "<string>",
    "durationSec": 123,
    "hasSpeech": true,
    "products": [
      {
        "format": "<string>",
        "content": "<string>",
        "mimeType": "<string>",
        "extension": "<string>"
      }
    ],
    "editedTranscript": {
      "kind": "transcript",
      "text": "<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+$

Path Parameters

assetId

string

required

Stable project asset id returned by GET /v1/assets.

Required string length: 1 - 200

Body

application/json

projectId

string

required

Project that holds the asset (GET /v1/assets lists them). An asset outside it answers not_found.

Required string length: 1 - 200

formats

enum<string>[]

Products to return, rendered from one recognition. Defaults to ["text"].

Required array length: 1 - 8 elements

Available options:

readable,

verbatim,

markdown,

srt,

vtt,

text,

json,

chapters

sourceLanguage

string

Spoken language. Omit to use the workspace default, or detection.

Required string length: 2 - 40

Pattern: ^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$

diarize

boolean

Label speakers. Omit to use the workspace default.

translateTo

string

Translate the timed products into this language. editedTranscript stays in the source language.

Required string length: 2 - 24

instruction

string

A plain-language rewrite applied to the finished transcript ("redact phone numbers", "as bullet notes"), returned as result.editedTranscript. Always a fresh ElevenLabs Scribe pass at +30%; refused with invalid_request where Scribe is not configured.

Required string length: 1 - 2000

Response

Success.

Option 1
Option 2

success

boolean

required

projectId

string

required

Required string length: 1 - 200

assetId

string

required

Required string length: 1 - 200

result

object

required

The transcript and the requested products.

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

Transcribe asset

Authorizations

Headers

Path Parameters

Body

Response