llms.txt Content
# Virlo API
> Social media intelligence API for TikTok, YouTube Shorts, and Instagram Reels. Track viral content, hashtags, trends, and creators with real-time analytics across 21K+ creators daily.
Virlo provides programmatic access to social media analytics through a REST API. The core research surface is Content Research Agents (POST /v1/agents) for one-shot and recurring niche research. Also: Satellite (creator/video/sound intel), Tracking (long-term monitoring), Sounds, Trends, Hashtags, and video digests across TikTok, YouTube Shorts, and Instagram Reels. Orbit (/v1/orbit) and Comet (/v1/comet) are DEPRECATED shims for Agents — removed August 3, 2026.
Base URL: https://api.virlo.ai/v1
Authentication: Bearer token in Authorization header (format: virlo_tkn_<your_key>)
Get your API key: https://dev.virlo.ai/dashboard
All parameter names and response fields use snake_case.
All responses are wrapped in a { "data": { ... } } envelope.
## Billing
Pay-as-you-go prepaid balance. Add funds in Billing (minimum shown there; A/B tested via api-min-topup-amount), use the API, auto top-up keeps you running. No subscriptions. Balance never expires.
Response headers: X-Cost and X-Credits-Used appear on every response ("0.00"/"0" for free reads); X-Credits-Remaining and X-Balance-Remaining appear only on charged responses (cost > 0).
- $0.05: Hashtag endpoints (list, performance, platform-specific), Sound detail, Sound usage history
- $0.10: Sound search
- $0.25: Video digest endpoints, Trends endpoints, tracking creator/video (charged at the POST — covers the initial cycle; auto-refunded if that first cycle can't resolve the creator/video; each subsequent recurring cycle is another $0.25), Trending sounds, Breakout sounds, Sound videos, Creator sounds
- $0.50: POST /v1/agents (one-shot, is_recurring=false) — recurring agents (is_recurring=true) are free to create and bill $0.50 per scheduled run; Orbit queue (DEPRECATED), Comet creation (DEPRECATED), Satellite creat
OpenAPI Spec (preview)
{"openapi":"3.0.0","paths":{"/":{"get":{"description":"Returns a simple message to verify the API is running. No authentication required.","operationId":"AppController_getHello","parameters":[],"responses":{"200":{"description":"API is running","content":{"application/json":{"schema":{"example":"Hello World!"}}}}},"summary":"Health check","tags":["Health"]}},"/v1/hashtags":{"get":{"description":"Returns hashtag statistics within a specified date range (maximum 3 months).","operationId":"V1Hashta