Poll a transcript job

Reads a job returned by GET /v1/transcript. Always 200 for your own job, including a failed one; check status.

GET /v1/transcript/{jobId}

Poll a transcript job

cURL

curl --request GET \
  --url https://app.bestvideotranscriptapi.com/v1/transcript/{jobId} \
  --header 'x-api-key: <api-key>'

200

{
  "status": "queued",
  "content": [
    {
      "text": "<string>",
      "offset": 123,
      "duration": 123,
      "lang": "<string>"
    }
  ],
  "lang": "<string>",
  "availableLangs": [
    "<string>"
  ],
  "platform": "<string>",
  "note": "<string>",
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "requestId": "<string>",
    "availableLangs": [
      "<string>"
    ],
    "durationSeconds": 123,
    "maxDurationSeconds": 123,
    "sizeBytes": 123,
    "maxSizeBytes": 123,
    "aiMinutesNeeded": 123,
    "aiMinutesRemaining": 123,
    "refillsAt": "2023-11-07T05:31:56Z",
    "billingUrl": "<string>"
  }
}

Authorizations

apiKeybearer

x-api-key · string · header · required

Path Parameters

jobId · string · required

Pattern: ^run_[a-z0-9]+$

Query Parameters

text · enum<string> · default: false

true returns content as one string instead of timed segments.

Available options: true, false

Response

200

application/json

The job. queued or active have only status; completed adds the transcript; failed adds error.

status · enum<string> · required

Available options: queued, active, completed, failed

content · object[] string

When completed. Same as Transcript.content.

Show child attributes

lang · string

availableLangs · string[]

platform · string

note · string

error · object

Show child attributes