← Home

Developer documentation

Automate flipbook creation with API keys. All endpoints share the same base URL.

Base URL
http://localhost:24001

Authentication

Send the API key via header:

Authorization: Bearer fk_xxxxxxxxxxxxxxxxxxxx

Get your key at /dashboard/api-keys

Main endpoints

MethodPathDescription
POST/api/v1/flipbooksCreate a new book
POST/api/v1/flipbooks/:id/upload-initGet a PDF upload URL
POST/api/v1/flipbooks/:id/upload-finishMark upload done, start rendering
GET/api/v1/flipbooks/:id/jobsTrack render progress
PATCH/api/v1/flipbooks/:id/style/effectChange the flip effect
GET/api/v1/flipbooks/:id/shareGet share link + QR
GET/api/v1/flipbooks/:id/statsGet analytics
GET/api/v1/public/flipbook/:codeGet the public manifest (no auth)

Webhooks

Subscribe to webhooks to receive events:

  • flipbook.ready — when rendering is done
  • flipbook.failed — when rendering fails
  • lead.captured — when a new lead arrives
  • view.threshold — view count threshold reached