SocialToAIStart freeConsole

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.

POSThttps://socialtoai.app/v1/detail

Request

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

NameTypeWhereRequiredWhat it is
platformstringbodyYesThe platform to read. One of the platforms this action is offered on.
limitintegerbodyNoOf search, trending, comments and user_posts: how many items you want. Pages are fetched one after another in the one call until there are that many or no more, each page charged as a call; pages not needed cost 0.
max_cost_creditsintegerbodyNoThe most this call may cost. Over it, the call is refused for free and the answer carries the quote.
Idempotency-KeystringheaderNo1 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.

PlatformPrice keyCreditsRequiredOptionalPer page
TikToktiktok.detail2one of id, url––
Instagraminstagram.detail2one of id, url––
Xx.detail1one of id, url––
Redditreddit.detail2one of id, url––
YouTubeyoutube.detail2one of id, url––
Facebookfacebook.detail2url––
LinkedInlinkedin.detail2one of id, url––
Threadsthreads.detail2one of id, url––
Telegramtelegram.detail2one of id, url––
Pinterestpinterest.detail2one of id, url––
Xiaohongshuxiaohongshu.detail12one of id, url––
Douyindouyin.detail2one of id, url––
Weiboweibo.detail2one of id, url––
WeChat Articleswechat.detail12url––
Bilibilibilibili.detail2one of id, url––
Zhihuzhihu.detail2one of id, url––
Kuaishoukuaishou.detail2one of id, url––
WeChat Channelswechat_channels.detail12one of id, url, export_id––

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

PlatformPrice keyCreditsSelected by
TikToktiktok.detail:transcript2include=transcript
Instagraminstagram.detail:transcript2include=transcript
Xx.detail:transcript2include=transcript
Redditreddit.detail:transcript2include=transcript
YouTubeyoutube.detail:transcript2include=transcript
LinkedInlinkedin.detail:transcript2include=transcript
Zhihuzhihu.detail:question2type=question
Zhihuzhihu.detail:article2type=article
Zhihuzhihu.detail:pin2type=pin

Parameters

NameTypeWhat it isTaken by
idstringVideo ID, a string of digitsTikTok, Instagram, X, Reddit, YouTube, LinkedIn, Threads, Telegram, Pinterest, Xiaohongshu, Douyin, Weibo, Bilibili, Zhihu, Kuaishou and WeChat Channels
urlstringLink to the video, pasted as it is: the https://www.tiktok.com/@handle/video/… web link, the www.tiktok.com/t/… or vm.tiktok.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads toAll
langstringWhich language of captions to get, as a two-letter language code (en, es, ja, say); left out, the platform's default. A video without captions in that language is answered as one without captionsTikTok and YouTube
export_idstringThe id of a search (platform=wechat_channels) result, starting with export/. It expires: use it soon after the search. The id returned is the video's numeric IDWeChat Channels

Example

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

curl https://socialtoai.app/v1/detail \  -H "Authorization: Bearer $SOCIALTOAI_API_KEY" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{    "platform": "tiktok",    "id": "7665840565958872333"  }'
import osimport uuidimport requestsresponse = requests.post(    "https://socialtoai.app/v1/detail",    headers={        "Authorization": f"Bearer {os.environ['SOCIALTOAI_API_KEY']}",        # A new key for each request; the same one again retries it without paying twice.        "Idempotency-Key": str(uuid.uuid4()),    },    json={        "platform": "tiktok",        "id": "7665840565958872333",    },)print(response.json())
Response200 OK2 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": [],      "extra": {},      "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 (≈ $0.0067). Balance: 98 credits (≈ $0.33)."  },  "replayed": false}

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

What comes back

The envelope with content and entry:transcript items. One call returns one item.

A failed call costs 0 credits and says why: see Errors.

Last updated: