Submit a YouTube video for transcription

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({videoId: '<string>', url: '<string>'})
};

fetch('https://api.arcmira.com/v1/transcriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.arcmira.com/v1/transcriptions"

payload = {
    "videoId": "<string>",
    "url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request POST \
  --url https://api.arcmira.com/v1/transcriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "videoId": "<string>",
  "url": "<string>"
}
'

{
  "request": {
    "id": "<string>",
    "videoId": "<string>",
    "quote": {
      "quarters": 123,
      "rows": 123
    },
    "createdAt": "<string>",
    "etaSeconds": 123,
    "nextPollSeconds": 123,
    "error": "<string>",
    "refunded": true,
    "completedAt": "<string>"
  },
  "existing": true,
  "overLimit": true
}

{
  "request": {
    "id": "<string>",
    "videoId": "<string>",
    "quote": {
      "quarters": 123,
      "rows": 123
    },
    "createdAt": "<string>",
    "etaSeconds": 123,
    "nextPollSeconds": 123,
    "error": "<string>",
    "refunded": true,
    "completedAt": "<string>"
  },
  "existing": true,
  "overLimit": true
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

Transcriptions

Submit a YouTube video for transcription

Paid tiers only. Rows are debited up front (75 rows per 15-minute block, minimum one) and the permanent per-video unlock is granted at submit time, so the transcript GET auto-unlocks when the pipeline finishes. If a PREMIUM transcript already exists the request short-circuits to complete; a video with only a preliminary analysis does NOT short-circuit — the premium generation actually runs. An unlock purchased earlier makes this request free (rows_charged 0). An in-flight request for the same video is returned as-is (existing: true). Supports the Idempotency-Key header. Responses include etaSeconds + nextPollSeconds and a Retry-After header while in flight — poll GET /v1/transcriptions/ on that cadence. User requests ride a reserved pipeline fast lane. Terminal pipeline failure auto-refunds the rows and revokes the unlock.

POST

transcriptions

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({videoId: '<string>', url: '<string>'})
};

fetch('https://api.arcmira.com/v1/transcriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.arcmira.com/v1/transcriptions"

payload = {
    "videoId": "<string>",
    "url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request POST \
  --url https://api.arcmira.com/v1/transcriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "videoId": "<string>",
  "url": "<string>"
}
'

{
  "request": {
    "id": "<string>",
    "videoId": "<string>",
    "quote": {
      "quarters": 123,
      "rows": 123
    },
    "createdAt": "<string>",
    "etaSeconds": 123,
    "nextPollSeconds": 123,
    "error": "<string>",
    "refunded": true,
    "completedAt": "<string>"
  },
  "existing": true,
  "overLimit": true
}

{
  "request": {
    "id": "<string>",
    "videoId": "<string>",
    "quote": {
      "quarters": 123,
      "rows": 123
    },
    "createdAt": "<string>",
    "etaSeconds": 123,
    "nextPollSeconds": 123,
    "error": "<string>",
    "refunded": true,
    "completedAt": "<string>"
  },
  "existing": true,
  "overLimit": true
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

videoId

string

YouTube video id (11 characters). Either videoId or url is required.

Pattern: ^[A-Za-z0-9_-]{11}$

url

string<uri>

A YouTube watch/short/live URL. Either videoId or url is required.

Response

An existing in-flight or already-satisfied request was returned (existing: true)

request

object

required

Show child attributes

existing

boolean

True when an in-flight (or already-satisfied) request for the same video was returned instead of creating a new one.

overLimit

boolean

Only present (true) when this purchase consumed the rest of the included row allocation.

Get a video transcript Poll transcription status