# YouTube Video Transcript (`youtube.video_transcript`)

Existing captions of a YouTube video or Short as plain text plus timed segments, by URL or ID (no speech-to-text; videos without captions are a free miss).

Docs: https://primaryapi.com/docs/api-reference/youtube/video_transcript

- Endpoint: `POST https://api.primaryapi.com/v1/run/youtube.video_transcript`
- Category: Video · Platform: `youtube` · Kind: transcript · Status: live
- Price: 2 credits per call; up to 8 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=youtube.video_transcript`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `url` | string | no |  | max 2048 chars | YouTube video URL: watch, youtu.be, Shorts, live and embed links all work. Give url or id. |
| `id` | string | no |  | pattern: ^[A-Za-z0-9_-]{11}$ | 11-character YouTube video ID (a Short uses the same ID format). Give url or id. |
| `language` | string | no |  | pattern: ^[A-Za-z]{2,3}([-_][A-Za-z0-9]{2,8})?$ | Preferred caption language code such as "en" or "es". Omit for the default track. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `videoId` | string | 11-character video ID |
| `transcript` | string | Full transcript text |
| `language` | string \| null | Language of the returned caption track: a code such as "en", or a name such as "English" from some sources |
| `durationSeconds` | number \| null | End of the last caption segment (or the video length when the source reports it) |
| `segments` | object[] | Timed caption segments |
| `segments[].text` | string |  |
| `segments[].startSeconds` | number \| null |  |
| `segments[].endSeconds` | number \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/youtube.video_transcript" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.youtube.com/watch?v=bjVIDXPP7Uk"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "videoId": "bjVIDXPP7Uk",
      "transcript": "welcome back to the hell farm and the backyard trails we built these jumps two years ago and last year we just kind of rebuilt them and this year......",
      "language": "English",
      "durationSeconds": 1.92,
      "segments": [
        {
          "text": "welcome back to the hell farm and the",
          "startSeconds": 0.16,
          "endSeconds": 1.92
        }
      ]
    }
  },
  "provider": "PrimaryAPI",
  "credits": 2,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 2 credits per call
- Price ceiling: up to 8 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=youtube.video_transcript`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

A video without captions returns found=false with reason no_transcript and is not billed.

