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.

13 pages across 4 sections

Getting started

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.

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 & Instagram slideshows.

Read

Errors

Status codes, error message codes, and how to recover from each.

Read

Webhooks & integrations

Outgoing webhooks, share & embed, Slack/Discord notifications, the MCP server, plus the Stripe billing events we consume.

Webhooks overview

Outgoing webhooks for slideshow events, plus the Stripe billing events we consume.

Read

MCP server

Drive ViralSlides from any MCP client (Claude Code, Claude Desktop, Cursor) — list apps, generate slideshows and hooks, and publish, all over the Model Context Protocol.

Read

FAQ

Billing, migration, and operational questions.

Billing FAQ

Plans, prorations, invoices, and refunds.

Read

Migration: internal admin → SaaS

If you used the internal admin build of ViralSlides, here's how the SaaS surface maps.

Read