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.
12 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-ready slideshow.
Read
Core concepts
The five building blocks of ViralSlides: organizations, apps, hooks, slideshows, and marketing assets.
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
Issue, format, and rotate API keys for ViralSlides.
Read
Apps
Create, list, update, and delete the mobile apps you market with ViralSlides.
Read
Hooks
List your hook library and trigger an on-demand refresh.
Read
Slideshows
Generate, list, fetch, and export TikTok slideshows.
Read
Errors
Status codes, error message codes, and how to recover from each.
Read
Webhooks & integrations
Outgoing webhooks, share & embed, Slack/Discord notifications, plus the Stripe billing events we consume.
FAQ
Billing, migration, and operational questions.