Read a research
get_researchUse when you have a research or breakdown run id and want its digest, videos, creators, hashtags or sounds, filtered or sorted (e.g. TikTok only, over 100k views, best outlier first). Not for collecting new data: use research or breakdown (charged, takes minutes). For a Run still running, use get_run. Price: Free. aspect picks the read (default videos). Each filter names the aspects that take it; others are refused. Numbers are as the research saw them; as_of=latest for the newest.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"run_id": "<run_id>"
},
"name": "get_research"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | asc or desc (default). Aspects: all but digest | |
| as_of | No | run (default) is what the research saw, frozen; latest is the newest this API holds, and is uneven until you refresh the research | |
| limit | No | Page size. Aspects: all but digest | |
| sound | No | Sound id. Aspects: videos | |
| aspect | No | What to read: digest (the synthesis), videos (the shortlist), creators, hashtags or sounds. Defaults to videos. | |
| offset | No | Rows to skip. Aspects: all but digest | |
| run_id | Yes | The run id a previous research or breakdown call returned | |
| creator | No | Creator id or handle. Aspects: videos | |
| hashtag | No | Keeps videos carrying this hashtag. Aspects: videos | |
| end_date | No | ISO date; keeps videos posted at or before it. Aspects: videos | |
| order_by | No | videos: rank (default), outlier, views, posted_at. creators: outlier (default), median_views, followers, video_count, views. hashtags and sounds: video_count (default) or views. Not for digest. | |
| max_views | No | Keeps videos with at most this many views. Aspects: videos | |
| min_views | No | Keeps videos with at least this many views. Aspects: videos | |
| platforms | No | Keeps rows from these platforms. Aspects: all but digest | |
| start_date | No | ISO date; keeps videos posted at or after it. Aspects: videos | |
| max_followers | No | Keeps creators with at most this many followers. Aspects: creators | |
| min_followers | No | Keeps creators with at least this many followers. Aspects: creators |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run | No | ||
| mode | No | ||
| as_of | No | Which snapshots the numbers come from. | |
| items | No | ||
| limit | No | ||
| total | No | Rows matching the filters, before `limit` and `offset`. | |
| digest | No | ||
| intent | No | ||
| offset | No | ||
| result | No | What a research recorded about itself. | |
| coverage | No | ||
| keywords | No | ||
| poll_url | No | ||
| lift_tables | No | Lift tables computed in code over the analysed videos. | |
| digest_version | No | ||
| keyword_rationale | No |