Poll transcription status

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "id": "<string>",
  "videoId": "<string>",
  "quote": {
    "quarters": 123,
    "rows": 123
  },
  "createdAt": "<string>",
  "etaSeconds": 123,
  "nextPollSeconds": 123,
  "error": "<string>",
  "refunded": true,
  "completedAt": "<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

Poll transcription status

Agent-friendly polling contract: while the request is in flight the response carries a Retry-After header (seconds) and body fields etaSeconds + nextPollSeconds — sleep on Retry-After and re-poll. status walks queued → downloading → transcribing → analyzing → complete (user-facing stage folds downloading into transcribing). Terminal statuses (complete, failed, refunded) drop Retry-After. On complete, fetch the transcript via GET /v1/transcripts/ — the unlock was granted at submission. refunded means the pipeline failed and the rows were returned.

GET

transcriptions

{id}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "id": "<string>",
  "videoId": "<string>",
  "quote": {
    "quarters": 123,
    "rows": 123
  },
  "createdAt": "<string>",
  "etaSeconds": 123,
  "nextPollSeconds": 123,
  "error": "<string>",
  "refunded": true,
  "completedAt": "<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.

Response

Success

string | null

required

Transcription request id (UUID). Null only in the degenerate submit response for a video you already own that has no request history.

videoId

string

required

YouTube video id (11 characters).

status

enum<string>

required

Request status. Values: queued (accepted; audio download not started), downloading (fetching the video audio), transcribing (premium speech-to-text is running), analyzing (entity/commercial analysis is running), complete (premium transcript is servable via GET /v1/transcripts/{video_id}), failed (reserved terminal failure value; failures currently surface as refunded), refunded (terminal failure; the charged rows were returned and the unlock this submission bought was revoked).

Available options:

queued,

downloading,

transcribing,

analyzing,

complete,

failed,

refunded

stage

enum<string> | null

required

User-facing stage: downloading folds into transcribing. Values: queued (waiting to start), transcribing (downloading or transcribing), analyzing (analysis running). Null for terminal statuses.

Available options:

queued,

transcribing,

analyzing,

null

quote

object | null

required

What this request charged: rows and 15-minute blocks. rows is 0 when a prior unlock made the submission free.

Show child attributes

createdAt

string

required

When the request was submitted.

etaSeconds

integer

Estimated SECONDS until completion, re-derived from live pipeline telemetry on every poll. Only present while the request is in flight.

nextPollSeconds

integer

Recommended SECONDS to sleep before the next poll (also sent as the Retry-After header). Only present while the request is in flight.

error

string

Failure reason. Only present when status is failed or refunded.

refunded

boolean

True when the charged rows were returned. Only present when status is failed or refunded.

completedAt

string

When the request reached a terminal status. Absent while in flight.

Submit a YouTube video for transcription List your transcription requests