# detail

POST /v1/detail is the detail action: one post: text and numbers. It is offered on 18 platforms (TikTok, Instagram, X, Reddit, YouTube, Facebook and 12 more), and the platform is a parameter of the request. One call costs 1 to 12 credits, depending on the platform; a call that fails costs nothing.

- Page: https://socialtoai.com/docs/api/detail/
- Last updated: 2026-10-17

- POST: `https://api.socialtoai.com/v1/detail`

## Request

A JSON body. These are the same for every action; the rest depends on the platform, below.

| Name | Type | Where | Required | What it is |
| --- | --- | --- | --- | --- |
| `platform` | string | body | Yes | The platform to read. One of the platforms this action is offered on. |
| `max_cost_credits` | integer | body | No | The most this call may cost. Over it, the call is refused for free and the answer carries the quote. |
| `Idempotency-Key` | string | header | No | 1 to 255 visible ASCII characters. The same key with the same parameters returns the first result again and is not charged twice. |

## Platforms and credits

Each platform takes its own parameters. Its own page has the full parameter and field tables and a request you can change.

| Platform | Price key | Credits | Required | Optional | Per page |
| --- | --- | --- | --- | --- | --- |
| [TikTok](https://socialtoai.com/tiktok-detail-api.md) | `tiktok.detail` | 2 | one of `id`, `url` | – | – |
| [Instagram](https://socialtoai.com/instagram-detail-api.md) | `instagram.detail` | 2 | one of `id`, `url` | – | – |
| [X](https://socialtoai.com/x-detail-api.md) | `x.detail` | 1 | one of `id`, `url` | – | – |
| [Reddit](https://socialtoai.com/reddit-detail-api.md) | `reddit.detail` | 2 | one of `id`, `url` | – | – |
| [YouTube](https://socialtoai.com/youtube-detail-api.md) | `youtube.detail` | 2 | one of `id`, `url` | – | – |
| [Facebook](https://socialtoai.com/facebook-detail-api.md) | `facebook.detail` | 2 | `url` | – | – |
| [LinkedIn](https://socialtoai.com/linkedin-detail-api.md) | `linkedin.detail` | 2 | one of `id`, `url` | – | – |
| [Threads](https://socialtoai.com/threads-detail-api.md) | `threads.detail` | 2 | one of `id`, `url` | – | – |
| [Telegram](https://socialtoai.com/telegram-detail-api.md) | `telegram.detail` | 2 | one of `id`, `url` | – | – |
| [Pinterest](https://socialtoai.com/pinterest-detail-api.md) | `pinterest.detail` | 2 | one of `id`, `url` | – | – |
| [Xiaohongshu](https://socialtoai.com/xiaohongshu-detail-api.md) | `xiaohongshu.detail` | 12 | one of `id`, `url` | – | – |
| [Douyin](https://socialtoai.com/douyin-detail-api.md) | `douyin.detail` | 2 | one of `id`, `url` | – | – |
| [Weibo](https://socialtoai.com/weibo-detail-api.md) | `weibo.detail` | 2 | `id` | – | – |
| [WeChat Articles](https://socialtoai.com/wechat-detail-api.md) | `wechat.detail` | 12 | `url` | – | – |
| [Bilibili](https://socialtoai.com/bilibili-detail-api.md) | `bilibili.detail` | 2 | one of `id`, `url` | – | – |
| [Zhihu](https://socialtoai.com/zhihu-detail-api.md) | `zhihu.detail` | 2 | one of `id`, `url` | – | – |
| [Kuaishou](https://socialtoai.com/kuaishou-detail-api.md) | `kuaishou.detail` | 2 | one of `id`, `url` | – | – |
| [WeChat Channels](https://socialtoai.com/wechat-channels-detail-api.md) | `wechat_channels.detail` | 12 | `id` | – | – |

Some platforms have another form of this action, selected by a parameter and priced on its own:

| Platform | Price key | Credits | Selected by |
| --- | --- | --- | --- |
| TikTok | `tiktok.detail:transcript` | 2 | `include=transcript` |
| Instagram | `instagram.detail:transcript` | 2 | `include=transcript` |
| Reddit | `reddit.detail:transcript` | 2 | `include=transcript` |
| YouTube | `youtube.detail:transcript` | 2 | `include=transcript` |
| LinkedIn | `linkedin.detail:transcript` | 2 | `include=transcript` |
| Zhihu | `zhihu.detail:question` | 2 | `type=question` |
| Zhihu | `zhihu.detail:article` | 2 | `type=article` |
| Zhihu | `zhihu.detail:pin` | 2 | `type=pin` |

## Parameters

| Name | Type | What it is | Taken by |
| --- | --- | --- | --- |
| `id` | string | Video ID, a string of digits | TikTok, Instagram, X, Reddit, YouTube, LinkedIn, Threads, Telegram, Pinterest, Xiaohongshu, Douyin, Weibo, Bilibili, Zhihu, Kuaishou and WeChat Channels |
| `url` | string | Web link to the video | TikTok, Instagram, X, Reddit, YouTube, Facebook, LinkedIn, Threads, Telegram, Pinterest, Xiaohongshu, Douyin, WeChat Articles, Bilibili, Zhihu and Kuaishou |

## Example

TikTok: One video by ID or link: text, author, likes, comment count, views and publish time.

**cURL**

```
curl https://api.socialtoai.com/v1/detail \
  -H "Authorization: Bearer $SOCIALTOAI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "tiktok",
    "id": "7665840565958872333"
  }'
```

**Python**

```
import os
import requests

response = requests.post(
    "https://api.socialtoai.com/v1/detail",
    headers={"Authorization": f"Bearer {os.environ['SOCIALTOAI_KEY']}"},
    json={
        "platform": "tiktok",
        "id": "7665840565958872333",
    },
)
print(response.json())
```

**Response** (200 OK, 2 credits)

```
{
  "request_id": "req_00000000-0000-4000-8000-000000000001",
  "schema_version": "v1",
  "fetched_at": "2026-10-12T18:45:36.000Z",
  "action": "detail",
  "platform": "tiktok",
  "status": "ok",
  "items": [
    {
      "platform": "tiktok",
      "id": "…",
      "ref": "…",
      "approx": [],
      "type": "content",
      "url": "https://example.com/…",
      "format": "video",
      "title": null,
      "text": "…",
      "published_at": "2026-10-08T13:12:22.000Z",
      "author": {
        "id": "…",
        "username": "…",
        "name": "…",
        "verified": null,
        "followers": 2060936
      },
      "metrics": {
        "likes": 67877,
        "comments": 524,
        "shares": 2472,
        "collects": 5331,
        "views": 449259,
        "reposts": null
      },
      "images": null,
      "hashtags": [],
      "is_pinned": null
    }
  ],
  "unavailable": ["title", "author.verified", "metrics.reposts", "images", "is_pinned"],
  "warnings": [],
  "applied_params": {
    "id": "7665840565958872333"
  },
  "cost_credits": 2,
  "billing": {
    "cost_credits": 2,
    "balance_credits": 98,
    "today_spend_credits": 2,
    "daily_limit_credits": null,
    "daily_remaining_credits": null,
    "display": "This call: 2 credits. Balance: 98 credits."
  },
  "replayed": false
}
```

_Sample data: names, links and text are replaced by placeholders._

## What comes back

The [envelope](https://socialtoai.com/docs/api/response.md) with [`content`](https://socialtoai.com/docs/api/response.md) and [`entry:transcript`](https://socialtoai.com/docs/api/response.md) items. One call returns one item.

A failed call costs 0 credits and says why: see [Errors](https://socialtoai.com/docs/api/errors.md).