API Documentation
See what's working on TikTok, YouTube Shorts, and Instagram Reels from your software or AI assistant. New to APIs? Read the Glossary.
With the Virlo API you can research a niche, look up any creator, sound, or hashtag, and see what's trending. You send each request with your API key (it works like a password), and you get back data as JSON, not a finished report, ready for your code or AI assistant to use.
There's no subscription. You add funds to a prepaid balance, and most requests cost $0.50 or less. Errors are free, and failed creator, sound, and hashtag lookups are refunded. A one-time agent whose run fails is still charged, as Billing and pricing explains.
Most requests answer in seconds, and lookups take up to a few minutes. Agents take longer: 9 in 10 finish collecting in under 20 minutes, and the AI report follows a few minutes after that.
Before you start
- Sign up and add funds. Keys need funds.
- Generate an API key and copy it: it's shown once.
- Follow the Quickstart.
Find what you need
| You want to | Go to |
|---|---|
| Analyze a niche's videos, once or on a schedule | Content Research Agents |
| Profile a creator and their go-to formats | Creator lookup, add-ons |
| Check if a video beat its creator's usual views | Video outlier check |
| Follow creators or videos over time | Tracking |
| See today's trends | Trends |
| Find trending sounds, or dig into one | Sounds, Sound lookup |
| Rank hashtags, or dig into one | Hashtags, Hashtag lookup |
| Find opening lines (hooks) that work | Hooks |
| Get the last 48 hours' top videos | Videos, YouTube, TikTok, Instagram |
| Get alerts when runs, lookups, or trends are ready, or tracked items change | Webhooks |
| Use Virlo from Claude, Cursor, or another AI assistant | MCP server |
Good to know
- Requests go to
https://api.virlo.ai/v1with your key in theAuthorizationheader. - Slow jobs return a job ID to check every 15 seconds, or whatever
retry_after_secondssays. - The
X-Costheader shows each call's price in dollars. Some fields count credits: 1 credit = $0.01.
Details for developers
Results sit in data, except on /v1/webhooks. Fields are snake_case, except statusCode in errors.
JavaScript examples use top-level await, so save them as .mjs files.
Still on /v1/orbit or /v1/comet? They are deprecated. Switch to agents.
