# TikTok Video Transcript (`tiktok.video_transcript`)

The caption track TikTok already has for a public video, flattened to plain text with timed segments when available.

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

- Endpoint: `POST https://api.primaryapi.com/v1/run/tiktok.video_transcript`
- Category: Social · Platform: `tiktok` · Kind: transcript · Status: live
- Price: 2 credits per call; up to 3 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=tiktok.video_transcript`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `url` | string | yes |  | max 2048 chars; format: uri | TikTok post URL on tiktok.com: a video or photo post (https://www.tiktok.com/@<user>/video/<id> or /photo/<id>) or a vm.tiktok.com / vt.tiktok.com share link. |
| `language` | string | no |  | pattern: ^[a-zA-Z]{2}$ | Two-letter language code of the caption track to fetch, e.g. "en". 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 |
|---|---|---|
| `id` | string \| null | TikTok video id |
| `url` | string | Video URL |
| `language` | string \| null | Caption language when known |
| `transcript` | string | Plain-text transcript (WEBVTT/SRT cues flattened) |
| `segments` | object[] \| null | Timed caption segments when the source provides timings |
| `segments[].startSeconds` | number \| null | Segment start, seconds from the beginning of the video |
| `segments[].endSeconds` | number \| null | Segment end, seconds from the beginning of the video |
| `segments[].text` | string |  |

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/tiktok.video_transcript" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.tiktok.com/@foxfamilyguy/video/7587841579029679392"}'
```

## 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": {
      "id": "string",
      "url": "https://www.tiktok.com/@foxfamilyguy/video/7587841579029679392",
      "language": "string",
      "transcript": "string",
      "segments": [
        {
          "startSeconds": 0,
          "endSeconds": 0,
          "text": "string"
        }
      ]
    }
  },
  "provider": "PrimaryAPI",
  "credits": 2,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 2 credits per call
- Price ceiling: up to 3 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=tiktok.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

Captions only, as TikTok wrote them (it mishears names; many videos have none → reason no_captions, not charged). For speech-to-text use tiktok.video_transcript_full.

