data_* tools in the social domain; the guide is Social data. These routes are the data routes’ social domain.
The social data tool object
What it returns. On describe, the long form.
The networks it reads:
x, instagram, tiktok, facebook, reddit, youtube, snapchat, linkedin, threads, telegram, douyin, kuaishou, xiaohongshu, weibo, bilibili, zhihu, wechat, lemon8, pipixia, toutiao, xigua.What a run costs you:
basis (per_call, per_result or varies), micro_usd (integer; for varies, the highest case) and text ("15 credits per call").Search tools
GET /v1/social_data/tools → 200 OK — scope agents:read. Free.
What you need, as a short noun phrase (1–200 characters):
tiktok video comments, instagram profile.{ data: social_data_tool[] }, best match first. There is no cursor: the ranking is the page.
Describe a tool
GET /v1/social_data/tools/{id} → 200 OK — scope agents:read. Free.
Answers the tool plus:
A JSON Schema per input location —
path, query, body — each present only when the tool takes it. A run sends parameters in the same three places.id that is not a social data tool is 404 not_found.
Run a tool
POST /v1/social_data/runs → 200 OK — scope sessions:write. Priced. Idempotency-Key optional: a retry under the same key replays the first answer and is billed once.
The request returns when the run ends — usually seconds, at most about two minutes.
Why it failed, in words that say what to change — often the parameter the network refused.
What this run debited, on the
search tier. Normally 0 for a failed run, and then no ledger entry is written; a stopped per-result run debits what it gathered.Response
Errors
Pricing
Search and describe are free. A run is the tool’sprice, booked once on the search component; a failed or stopped run is normally free (a stopped per-result run costs what it gathered). See Pricing.