# TikTok Playlist Videos (`tiktok.playlist_videos`)

Videos inside one public TikTok playlist (collection), in playlist order, with view, like and comment counts.

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

- Endpoint: `POST https://api.primaryapi.com/v1/run/tiktok.playlist_videos`
- Category: Social · Platform: `tiktok` · Kind: list · 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.playlist_videos`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `url` | string | no |  | max 2048 chars; format: uri | Public TikTok playlist (collection) URL, e.g. https://www.tiktok.com/@kibblemaster808/collection/Want-to-go-7665668414573546258. Pass url, id, or both. |
| `id` | string | no |  | pattern: ^\d{8,25}$ | Numeric playlist id (the digits at the end of the playlist URL). Pass url, id, or both. |
| `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 |
|---|---|---|
| `videos` | object[] |  |
| `videos[].id` | string | TikTok post id (aweme_id). |
| `videos[].url` | string \| null | Canonical web URL of the post. |
| `videos[].caption` | string \| null |  |
| `videos[].createdUtc` | string \| null | Creation time, ISO-8601 UTC. |
| `videos[].durationSeconds` | number \| null |  |
| `videos[].hashtags` | string[] | Hashtags without the leading #. |
| `videos[].mentions` | string[] | Handles @-mentioned in the caption, without @, when the source provides them. |
| `videos[].image` | string \| null | Cover image URL (signed CDN link, expires). |
| `videos[].likes` | integer \| null |  |
| `videos[].comments` | integer \| null |  |
| `videos[].shares` | integer \| null |  |
| `videos[].saves` | integer \| null |  |
| `videos[].views` | integer \| null |  |
| `videos[].author` | string \| null | Creator handle (same value as authorHandle). |
| `videos[].authorHandle` | string \| null |  |
| `videos[].authorName` | string \| null |  |
| `videos[].authorUserId` | string \| null |  |
| `videos[].authorSecUid` | string \| null |  |
| `videos[].authorImage` | string \| null |  |
| `videos[].authorVerified` | boolean \| null |  |
| `videos[].authorFollowers` | integer \| null | Creator follower count when the source provides it. |
| `videos[].soundTitle` | string \| null |  |
| `videos[].soundAuthor` | string \| null |  |
| `videos[].soundClipId` | string \| null |  |
| `videos[].videoUrl` | string \| null | Playable MP4 URL (signed CDN link, expires). |
| `videos[].region` | string \| null |  |
| `videos[].locationName` | string \| null |  |
| `videos[].isPinned` | boolean \| null |  |
| `videos[].paidPartnership` | boolean \| null |  |
| `hasMore` | boolean \| null | True when nextCursor can fetch another page; null when the serving source cannot tell. |
| `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.playlist_videos" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.tiktok.com/@kibblemaster808/collection/Want-to-go-7665668414573546258"}'
```

## 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": {
      "videos": [
        {
          "id": "string",
          "url": "https://www.tiktok.com/@kibblemaster808/collection/Want-to-go-7665668414573546258",
          "caption": "string",
          "createdUtc": "string",
          "durationSeconds": 0,
          "hashtags": [
            "string"
          ],
          "mentions": [
            "string"
          ],
          "image": "string",
          "likes": 0,
          "comments": 0,
          "shares": 0,
          "saves": 0,
          "views": 0,
          "author": "string",
          "authorHandle": "string",
          "authorName": "string",
          "authorUserId": "string",
          "authorSecUid": "string",
          "authorImage": "string",
          "authorVerified": true,
          "authorFollowers": 0,
          "soundTitle": "string",
          "soundAuthor": "string",
          "soundClipId": "string",
          "videoUrl": "https://example.com",
          "region": "string",
          "locationName": "string",
          "isPinned": true,
          "paidPartnership": true
        }
      ],
      "hasMore": true,
      "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 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.playlist_videos`

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

Flat price per page. Unknown or private playlists return found=false.

