Documentation
Learn ViralSlides in 5 minutes.
Getting-started guides, a complete REST API reference, and notes on how billing webhooks shape your organization's state. Search the index below, or jump straight to the API overview.
14 pages across 4 sections
Getting started
Sign up, create your first app, and ship a slideshow in 60 seconds.
Welcome to ViralSlides
What ViralSlides is, who it's for, and a 3-step quickstart for shipping your first slideshow.
Read
Your first slideshow
Step-by-step: sign up, create an app, and generate your first TikTok- and Instagram-ready slideshow.
Read
Core concepts
The five building blocks of ViralSlides: organizations, apps, hooks, slideshows, and marketing assets, and how they fit together.
Read
API reference
Authenticated REST endpoints for apps, hooks, and slideshows.
API overview
Base URL, versioning, authentication options, JSON conventions, and rate limits for the ViralSlides REST API.
Read
Authentication
How to create, format and rotate ViralSlides API keys, send them with each request, and which plans include API access.
Read
Apps
Create, list, update, and delete the mobile apps you market with ViralSlides.
Read
Hooks
List your ViralSlides hook library by niche, language and category, and trigger an on-demand refresh through the REST API.
Read
Slideshows
Generate, list, fetch and export TikTok and Instagram slideshows through the ViralSlides REST API, with request and response examples.
Read
Errors
ViralSlides API errors: the shared JSON error shape, HTTP status codes, stable message codes, and how to recover from each one.
Read
Webhooks & integrations
Outgoing webhooks, share & embed, Slack/Discord notifications, the MCP server, plus the Stripe billing events we consume.
Webhooks overview
Get a signed HTTPS callback when a slideshow finishes, fails or hits a quota, with slide image URLs in the payload. Events, payload, signatures, retries.
Read
MCP server
Drive ViralSlides from any MCP client, such as Claude Code or Cursor: list apps, generate slideshows, hooks and videos, and publish over MCP.
Read
Autopilot (real-device posting)
Warm accounts and post from real iPhones plugged into your own Mac, instead of through the platform API.
Read
FAQ
Billing, migration, and operational questions.