Flipsnack

Create a new Flipsnack flipbook collection. Use when the user wants to start a new publication, optionally importing a PDF from a URL. Returns the full collection detail including its hash, direct link, and (after processing) the contained flipbooks. This is a write operation that creates new content on the user's account.

collection_create

Move a flipbook collection to the Flipsnack trash. This is NOT a permanent delete — the collection can still be restored from the trash UI. Use only when the user explicitly asks to delete or remove a collection. Returns a confirmation with the hash that was trashed.

collection_delete

Fetch account-wide analytics aggregated across every collection owned by the authenticated user: total impressions, views, time spent, shares, downloads, and the remaining API upload quota for the current billing period. Read-only and takes no parameters. For per-collection breakdowns use collection_get_stats.

user_get_stats

Fetch the full detail of one specific Flipsnack collection by its hash. Use this after collection_get_list (or when the user already has a hash) to retrieve every field: title, description, status, cover image, direct link, contained flipbooks, settings, and publish date. Read-only.

collection_get_collection

Fetch reader analytics for a single flipbook collection: impressions, views, total time spent, downloads, and an optional per-page breakdown. Optionally restrict the report to a date range. Use when the user asks how a specific publication is performing. Read-only. For account-wide totals across every collection, use user_get_stats instead.

collection_get_stats

Generate the HTML iframe snippet used to embed a Flipsnack collection on a third-party website. Use this when the user wants to put a flipbook on their own page or blog. You can optionally specify pixel width/height or request a responsive iframe that scales to its container. Read-only — the call does not modify the collection.

collection_get_embed

List the authenticated user's flipbook collections, with optional filtering by status, folder, or free-text query, plus pagination. Use this when the user asks to browse, find, or search their existing collections. Returns an array of summary records (hash, title, status, cover image, direct link); use collection_get_collection to fetch full detail for one.

collection_get_list

Update the metadata of an existing flipbook collection: title, description, or visibility status. At least one updatable field MUST be provided in addition to the collectionHash; otherwise the tool returns an error. Returns the updated collection detail. Idempotent — repeating the same call yields the same result.

collection_update