# TikTok Video Comments (`tiktok.video_comments`)

Top-level comments on a public TikTok video or photo post, with author, likes and reply counts, page by page.

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

- Endpoint: `POST https://api.primaryapi.com/v1/run/tiktok.video_comments`
- Category: Social · Platform: `tiktok` · Kind: list · 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=tiktok.video_comments`
- 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. |
| `limit` | integer | no | 20 | 1–30 | Maximum number of results to return (1-30, default 20). |
| `cursor` | string | no |  |  | Opaque pagination cursor: pass the previous response's nextCursor. |

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 |
|---|---|---|
| `comments` | object[] |  |
| `comments[].id` | string \| null | Comment id (cid) |
| `comments[].text` | string \| null |  |
| `comments[].createdUtc` | string \| null | ISO-8601 UTC |
| `comments[].likes` | integer \| null |  |
| `comments[].replies` | integer \| null | Reply count |
| `comments[].language` | string \| null | Detected comment language |
| `comments[].author` | string \| null | Commenter @handle |
| `comments[].authorName` | string \| null |  |
| `comments[].authorUserId` | string \| null |  |
| `comments[].authorImage` | string \| null |  |
| `comments[].videoId` | string \| null | Parent video id |
| `total` | integer \| null | Total comment count when the source reports it |
| `nextCursor` | string \| 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.

Pagination: pass the previous response’s `nextCursor` as `cursor` to get the next page; `nextCursor: null` means there are no more results.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/tiktok.video_comments" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.tiktok.com/@scout2015/video/6718335390845095173"}'
```

## 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": {
      "comments": [
        {
          "id": "string",
          "text": "string",
          "createdUtc": "string",
          "likes": 0,
          "replies": 0,
          "language": "string",
          "author": "string",
          "authorName": "string",
          "authorUserId": "string",
          "authorImage": "string",
          "videoId": "string"
        }
      ],
      "total": 0,
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 2,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## 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=tiktok.video_comments`

## 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

One flat price per page. Pages hold up to `limit` comments. Replies are counted, not expanded (use tiktok.comment_replies). Comments are personal data: customers carry the lawful-use duty. Very deep pages may come back empty (TikTok caps offsets).

