Read as Markdown · Use with an AI agent
Endpoint
GET/v1/tiktok/postlive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
url | yes | Full TikTok video URL. | https://www.tiktok.com/@nasa/video/7665075736742530317 |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
judgments | no | Add bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. | on |
label | no | Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. | none |
label_evidence | no | Include exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. | 1 |
exclude | no | Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. | engagement_bait |
fit | no | Use goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. | goal |
goal | no | Required with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts. | Find concrete product complaints |
tokens | no | Optional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it. | 4000 |
Examples
Make the request
curl
curl "https://www.monocrawl.com/v1/tiktok/post?url=https%3A%2F%2Fwww.tiktok.com%2F%40nasa%2Fvideo%2F7665075736742530317" \ -H "x-api-key: mn_your_key_here"
TypeScript
typescript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/tiktok/post?url=https%3A%2F%2Fwww.tiktok.com%2F%40nasa%2Fvideo%2F7665075736742530317",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/tiktok/post?url=https%3A%2F%2Fwww.tiktok.com%2F%40nasa%2Fvideo%2F7665075736742530317",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
200 · application/json
{
"success": true,
"platform": "tiktok",
"endpoint": "/v1/tiktok/post",
"data": {
"id": "7350000000000000002",
"url": "https://www.tiktok.com/@example_creator/video/7350000000000000002",
"caption": "A desk setup",
"created_at": "2026-09-01T12:00:00.000Z",
"duration_s": 15,
"stats": {
"plays": 1200,
"likes": 100,
"comments": 12,
"shares": null,
"saves": 8
}
},
"credits_used": 1,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example uses fictional values and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
url | string | null | Original source URL when supplied. |
caption | string | null | Video caption; spoken words require a transcript request. |
created_at | string | null | Source publication time, normalized to an ISO date-time when available. |
duration_s | number | null | Video duration in seconds. |
region | string | null | Source-reported content region, not audience geography or proof of residence. |
author | object | Nested response fields; optional unless explicitly documented. |
author.id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
author.handle | string | null | Public account username. |
author.name | string | null | Display name. |
author.url | string | null | Original source URL when supplied. |
author.followers | number | null | Follower count supplied with this video; null when absent. No profile-enrichment call is made. |
author.region | string | null | Source-reported account region, not audience geography or proof of residence. |
stats | object | Nested response fields; optional unless explicitly documented. |
stats.plays | number | null | plays reported by the source; null or absent is unknown, not zero. |
stats.likes | number | null | likes reported by the source; null or absent is unknown, not zero. |
stats.comments | number | null | comments reported by the source; null or absent is unknown, not zero. |
stats.shares | number | null | shares reported by the source; null or absent is unknown, not zero. |
stats.saves | number | null | saves reported by the source; null or absent is unknown, not zero. |
_warnings | array | Collection limitations or component warnings. Read before interpreting coverage. |
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference