Heyzine

Convert a document at a public URL into a hosted flipbook through Heyzine's link endpoint and return the flipbook URL it resolves to. Conversion starts on the first access, so the first call on a new document can be slow. Prefer the async REST conversion for a URL: it answers immediately and can be polled. ON THE FREE PLAN THE ACCOUNT KEEPS ONLY FIVE FLIPBOOKS AND CONVERTING A SIXTH REMOVES THE OLDEST ONE, so a conversion can destroy an earlier publication without naming it. Heyzine authenticates this endpoint with the account's Client ID in the query string rather than with the API key, and Agentic Fabriq supplies it from the connection via GET /api1

List the flipbooks placed on one bookshelf, ordered by their position on the shelf. PLAN-GATED with the other bookshelf tools. Heyzine documents this GET as carrying a JSON body ({"id": "..."}), which is what the connector sends; the Agentic Fabriq route takes it as an ordinary query argument via GET /api1/bookshelf-flipbooks

List every bookshelf in the connected account with its title, flipbook count and public links. PLAN-GATED: bookshelves need a plan that includes them, so a refusal here can be the account's plan rather than the credential via GET /api1/bookshelf-list

Read everything Heyzine holds about one flipbook: title, subtitle, description, the internal private note, page count, tags, its base, custom, thumbnail and source-PDF links, and its oEmbed object. Heyzine documents this GET as carrying a JSON body ({"id": "..."}), which is what the connector sends; the Agentic Fabriq route takes it as an ordinary query argument via GET /api1/flipbook-details

List every flipbook in the connected account with its title, subtitle, description, private note, page count, stored size and links. THE DISCOVERY CALL: the `id` every other flipbook tool takes comes from here. Takes no arguments and is not paginated via GET /api1/flipbook-list

Get the standard oEmbed 1.0 record for a public flipbook URL, including the ready-to-paste iframe embed code and the cover thumbnail. Describes a PUBLIC flipbook by its URL rather than a flipbook of the connected account by id, so it works for any Heyzine publication via GET /api1/oembed

Change the look, the publication settings and the text of an existing flipbook. `template` copies another flipbook's styles and any field sent beside it overwrites the copied value. `url_path` and `url_domain` need a plan with custom URL support. Not destructive: nothing is deleted, but the live flipbook changes immediately via PATCH /api1/flipbook-design

Add a reader, or a shared password, to the access list that protects a flipbook or bookshelf. GRANTS ACCESS to a protected publication. Four of the access types (email_link, send_code, email_code, webhook_code) are Premium-plan only via POST /api1/access-add

DESTRUCTIVE. Remove a reader, or a password, from the access list that protects a flipbook or bookshelf. The entry is gone and that person can no longer open the publication; Heyzine publishes no undo and the entry has to be added again to restore it via POST /api1/access-remove

Turn password protection on or off for a flipbook or bookshelf and set the wording of its login screen. `mode: "disabled"` MAKES A PROTECTED PUBLICATION PUBLIC, so it widens access rather than narrowing it; the access list itself is not deleted via POST /api1/access-setup

Start converting a document at a public URL into a flipbook and return immediately with its state (started, processed or failed). THIS IS ALSO THE POLL: calling it again with the same `pdf` URL returns the current state rather than converting a second time. Flipbook links show a not-found page until the state is `processed`. ON THE FREE PLAN THE ACCOUNT KEEPS ONLY FIVE FLIPBOOKS AND CONVERTING A SIXTH REMOVES THE OLDEST ONE, so a conversion can destroy an earlier publication without naming it. via POST /api1/async

Place an existing flipbook on a bookshelf, optionally at a chosen position. The flipbook itself is untouched; only its membership of the shelf changes. PLAN-GATED with the other bookshelf tools via POST /api1/bookshelf-add

Take a flipbook off a bookshelf. NOT DESTRUCTIVE and deliberately not flagged as such: the flipbook itself is kept and only its place on the shelf is removed -- deleting a flipbook is a different tool. PLAN-GATED with the other bookshelf tools via POST /api1/bookshelf-remove

Set the title, description and thumbnail a bookshelf shows when its link is shared. Targets a bookshelf, so an account without the bookshelf feature can be refused here for the same plan reason as the bookshelf tools via POST /api1/bookshelf-social

DESTRUCTIVE AND PERMANENT. Delete one flipbook from the account. Heyzine publishes no trash, no restore endpoint and no undo, and the public links stop working at once. If the intent is only to take it out of circulation, the reversible alternative is the access list: set the password protection mode instead via POST /api1/flipbook-delete

Set the title, description and thumbnail a flipbook shows when its link is posted on a social network or in a chat. Distinct from the flipbook's own title and description, which the design tool sets via POST /api1/flipbook-social

Convert a document at a public URL into a flipbook SYNCHRONOUSLY and return its links, page count and aspect ratio. The response comes only when the conversion ends, so a large document can exceed the client timeout -- use the async conversion and poll it instead when the document is big or the size is unknown. ON THE FREE PLAN THE ACCOUNT KEEPS ONLY FIVE FLIPBOOKS AND CONVERTING A SIXTH REMOVES THE OLDEST ONE, so a conversion can destroy an earlier publication without naming it. via POST /api1/rest