> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). The sections below mirror the orientation block in [`/llms.txt`](https://www.socialfetch.dev/llms.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need a structured operation inventory. The catalog covers documented operations with on-site reference pages.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/tiktok/videos/get](https://www.socialfetch.dev/docs/api/v1/tiktok/videos/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/tiktok/videos/get.mdx](https://www.socialfetch.dev/docs/api/v1/tiktok/videos/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users.
- [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).

---
# Get TikTok video (https://www.socialfetch.dev/docs/api/v1/tiktok/videos/get)

## Summary

Returns public metadata for a single TikTok video or photo post.

**Tags:** `TikTok`

## HTTP

- **Method:** GET
- **Path:** `/v1/tiktok/videos`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.tiktok.getVideo({ url, region?, trim?, downloadMedia? })`
- **Accepted identifiers:** `url` (query)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`
- **Media download:** supported via `downloadMedia=true`
- **Trimmed response mode:** supported via `trim=true`

## Credits

- **Base:** 1 credit per successful lookup.
- **Add-on (`downloadMedia=true`):** +10 credits. _Hosted media download_
- **Maximum on success (200):** 11 credits.
- **Normalization failure (502):** 1 credit charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `url` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 4096
- **Description:** Link to the video or photo post.

### `region` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1
- **Description:** Optional two-letter region (country code) used to route the request when needed.

### `trim` (query)

- **Required:** no
- **Constraints:** type `boolean`
- **Description:** When true, returns a smaller response with fewer fields.

### `downloadMedia` (query)

- **Required:** no
- **Constraints:** type `boolean`
- **Description:** When true, includes hosted CDN URLs in `downloads` when available. Adds 10 credits (11 total with the base lookup) on successful lookups, even if `downloads` is empty.

### `getTranscript` (query)

- **Required:** no
- **Constraints:** type `boolean`
- **Description:** When true, includes the video transcript (WEBVTT) in `transcript` when one is available.

## Behavior notes

- **`trim`**: When true, returns a smaller response with fewer fields.
- **`region`**: Optional two-letter region (country code) used to route the request when needed.
- **`downloadMedia`**: When true, includes hosted CDN URLs in `downloads` when available. Adds 10 credits (11 total with the base lookup) on successful lookups, even if `downloads` is empty.

## Responses (status codes)

- **200**: Video metadata (found or not found in body).
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data).
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Video metadata (found or not found in body).

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the video was resolved.
  - **video** (required) — type `object`; nullable. Video details when found.
    - **id** (required) — type `string`; minLength: 1. TikTok video id.
    - **url** (required) — type `string`; minLength: 1. Canonical public TikTok URL for this video.
    - **caption** (required) — type `string`; nullable. Caption text.
    - **createdAt** (required) — type `string`; nullable. ISO-8601 timestamp when the video was posted.
    - **region** (optional) — type `string`; nullable. Video region (two-letter country code).
    - **durationMs** (required) — type `integer`; minimum: 0; nullable. Video duration in milliseconds.
    - **mediaType** (required) — type `string`; enum: video, slideshow. Whether the post is a video or a photo slideshow.
    - **isAd** (required) — type `boolean`. Whether TikTok marks the post as an ad.
  - **author** (required) — type `object`; nullable. Author when found.
    - **platformUserId** (optional) — type `string`. Numeric user id.
    - **secUid** (optional) — type `string`. Stable opaque user id.
    - **handle** (required) — type `string`; minLength: 1. Public username without a leading @.
    - **nickname** (optional) — type `string`; nullable. Display name.
    - **verified** (required) — type `boolean`. Whether the account is verified.
    - **avatarUrl** (optional) — type `string`; nullable. Profile picture URL.
    - **signature** (optional) — type `string`; nullable. Profile bio text.
    - **region** (optional) — type `string`; nullable. Two-letter country code when available.
    - **privateAccount** (optional) — type `boolean`. Whether the account is private.
  - **music** (required) — type `object`; nullable. Music or sound when found.
    - **id** (optional) — type `string`; nullable. Music or sound id.
    - **title** (optional) — type `string`; nullable. Music title.
    - **author** (optional) — type `string`; nullable. Music author.
    - **playUrl** (optional) — type `string`; nullable. Music playable URL.
    - **coverUrl** (optional) — type `string`; nullable. Music cover image URL.
    - **durationSec** (optional) — type `number`; minimum: 0; nullable. Music duration in seconds.
    - **isOriginal** (optional) — type `boolean`. Whether the sound is marked as original.
  - **metrics** (required) — type `object`; nullable. Engagement metrics for the video.
    - **views** (optional) — type `integer`; minimum: 0; nullable. Play count.
    - **likes** (optional) — type `integer`; minimum: 0; nullable. Like count.
    - **comments** (optional) — type `integer`; minimum: 0; nullable. Comment count.
    - **shares** (optional) — type `integer`; minimum: 0; nullable. Share count.
    - **saves** (optional) — type `integer`; minimum: 0; nullable. Save or collection count.
  - **media** (required) — type `object`; nullable. Primary playable media payload for the video.
    - **downloadUrl** (required) — type `string`; nullable. Best available video URL (typically watermarked).
    - **downloadWithoutWatermarkUrl** (required) — type `string`; nullable. Best available video URL without watermark.
    - **thumbnailUrl** (required) — type `string`; nullable. Thumbnail or cover image URL.
    - **dimensions** (optional) — type `object`. Pixel dimensions.
      - **width** (required) — type `integer`; minimum: 0
      - **height** (required) — type `integer`; minimum: 0
    - **slideshowImages** (optional) — type `array`. Ordered image URLs when the post is a photo slideshow.
      - _items:_
        - type `string`
  - **transcript** (required) — type `object`; nullable. Populated only when `getTranscript=true` was passed and a transcript was available.
    - **format** (required) — type `string`; enum: webvtt. Transcript format.
    - **content** (required) — type `string`. Raw transcript text.
  - **downloads** (required) — type `array`. Populated only when `downloadMedia=true` was passed and media was available.
    - _items:_
      - **postId** (optional) — type `string`. Video id from the post.
      - **originalUrl** (required) — type `string`. Source media URL.
      - **cdnUrl** (required) — type `string`. Permanent hosted URL.
      - **type** (required) — type `string`; enum: video, image. Asset type.
  - **details** (optional) — type `object`. Additional TikTok-native fields from the post (author, music, video, etc.), minus keys already promoted above.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "video": {
      "id": "7587811642650545421",
      "url": "https://www.tiktok.com/@nike/video/7587811642650545421",
      "caption": "Example caption.",
      "createdAt": "2025-12-25T12:00:00.000Z",
      "region": "US",
      "durationMs": 46315,
      "mediaType": "video",
      "isAd": false
    },
    "author": {
      "handle": "nike",
      "nickname": "Nike",
      "verified": true,
      "avatarUrl": "https://example.com/avatar.jpg",
      "privateAccount": false
    },
    "music": {
      "title": "original sound",
      "author": "Nike"
    },
    "metrics": {
      "views": 1566081,
      "likes": 21907,
      "comments": 273,
      "shares": 947,
      "saves": 1171
    },
    "media": {
      "downloadUrl": "https://example.com/watermarked.mp4",
      "downloadWithoutWatermarkUrl": "https://example.com/clean.mp4",
      "thumbnailUrl": "https://example.com/thumb.jpg"
    },
    "transcript": null,
    "downloads": []
  },
  "meta": {
    "requestId": "req_01example",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (not_found)

```json
{
  "data": {
    "lookupStatus": "not_found",
    "video": null,
    "author": null,
    "music": null,
    "metrics": null,
    "media": null,
    "transcript": null,
    "downloads": []
  },
  "meta": {
    "requestId": "req_01example",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (download_media)

```json
{
  "data": {
    "lookupStatus": "found",
    "video": {
      "id": "7587811642650545421",
      "url": "https://www.tiktok.com/@nike/video/7587811642650545421",
      "caption": "Example caption.",
      "createdAt": "2025-12-25T12:00:00.000Z",
      "region": "US",
      "durationMs": 46315,
      "mediaType": "video",
      "isAd": false
    },
    "author": {
      "handle": "nike",
      "verified": true
    },
    "music": null,
    "metrics": {
      "views": 100,
      "likes": 10,
      "comments": 1,
      "shares": 0,
      "saves": 0
    },
    "media": {
      "downloadUrl": "https://example.com/w.mp4",
      "downloadWithoutWatermarkUrl": "https://example.com/nw.mp4",
      "thumbnailUrl": "https://example.com/t.jpg"
    },
    "transcript": null,
    "downloads": [
      {
        "postId": "7587811642650545421",
        "originalUrl": "https://cdn.example.com/orig.mp4",
        "cdnUrl": "https://cdn.example.com/hosted.mp4",
        "type": "video"
      }
    ]
  },
  "meta": {
    "requestId": "req_01example_dl",
    "creditsCharged": 11,
    "version": "v1"
  }
}
```

### Example JSON (slideshow)

```json
{
  "data": {
    "lookupStatus": "found",
    "video": {
      "id": "7628328815495744790",
      "url": "https://www.tiktok.com/@user/photo/7628328815495744790",
      "caption": null,
      "createdAt": "2026-04-16T12:00:00.000Z",
      "region": "GB",
      "durationMs": null,
      "mediaType": "slideshow",
      "isAd": false
    },
    "author": {
      "handle": "kelseycarlin1",
      "verified": false
    },
    "music": null,
    "metrics": null,
    "media": {
      "downloadUrl": null,
      "downloadWithoutWatermarkUrl": null,
      "thumbnailUrl": "https://example.com/cover.jpg",
      "slideshowImages": [
        "https://example.com/slide1.jpg",
        "https://example.com/slide2.jpg"
      ]
    },
    "transcript": null,
    "downloads": []
  },
  "meta": {
    "requestId": "req_01example_ss",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (transcript)

```json
{
  "data": {
    "lookupStatus": "found",
    "video": {
      "id": "7587811642650545421",
      "url": "https://www.tiktok.com/@nike/video/7587811642650545421",
      "caption": "Example.",
      "createdAt": "2025-12-25T12:00:00.000Z",
      "region": "US",
      "durationMs": 46315,
      "mediaType": "video",
      "isAd": false
    },
    "author": {
      "handle": "nike",
      "verified": true
    },
    "music": null,
    "metrics": null,
    "media": {
      "downloadUrl": null,
      "downloadWithoutWatermarkUrl": null,
      "thumbnailUrl": null
    },
    "transcript": {
      "format": "webvtt",
      "content": "WEBVTT\n\n00:00:00.140 --> 00:00:04.020\nAll right. Pizza review time"
    },
    "downloads": []
  },
  "meta": {
    "requestId": "req_01example_tr",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.tiktok.getVideo({
  url: "https://www.tiktok.com/@mrbeast/video/7596844935442189598",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/tiktok/videos?url=https://www.tiktok.com/@mrbeast/video/7596844935442189598",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/tiktok/videos?url=https://www.tiktok.com/@mrbeast/video/7596844935442189598" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/tiktok/videos?url=https://www.tiktok.com/@mrbeast/video/7596844935442189598",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```

### Example: optional query parameters

First request illustrating common optional query flags (adjust values to your integration):

```javascript
const url = "https://api.socialfetch.dev/v1/tiktok/videos?trim=true";
const response = await fetch(url, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const data = await response.json();
```