heyzine_access_add
ChatGPTAdd or update a user or password on the access list of a flipbook or bookshelf. The send_code access type immediately emails a generated access code to the supplied user address.
Creativity
Overview
Heyzine Flipbooks helps users convert documents into interactive online flipbooks, manage publications and bookshelves, search page text, configure access, and generate embed code through ChatGPT.
Tools
heyzine_access_remove
ChatGPTRemove a user or password from the access list of a flipbook or bookshelf.
heyzine_access_setup
ChatGPTOverwrite the password protection mode of a flipbook or bookshelf. Disabled mode removes the access gate and makes the publication public.
heyzine_add_to_bookshelf
ChatGPTPlace an existing flipbook on a publicly visible bookshelf.
heyzine_convert_attached_pdf
ChatGPTCreate, publish and return a finished flipbook from a document the user attached or selected in this conversation. Use this whenever the document is a file at hand rather than a public link. Accepts PDF, Word (doc, docx), PowerPoint (ppt, pptx), OpenDocument (odt, odp) and RTF. The attachment is downloaded and converted during this call; do not call the tool again to poll.
heyzine_convert_pdf
ChatGPTConvert and publish a document that is already online as a flipbook, waiting for the conversion to finish before returning. The pdf parameter must be a public URL, not an attachment. Accepts PDF, Word (doc, docx), PowerPoint (ppt, pptx), OpenDocument (odt, odp) and RTF. Setting replace to true reconverts and overwrites the existing flipbook for the same URL. Blocks for as long as the conversion takes, so large documents may exceed the client timeout; prefer heyzine_convert_pdf_async unless you need the finished result in one call.
heyzine_convert_pdf_async
ChatGPTStart converting and publishing a document that is already online as a flipbook, and return immediately with the flipbook id, URL and a "state" field. The pdf parameter must be a public URL, not an attachment: for a file attached in the conversation use heyzine_convert_attached_pdf. Accepts PDF, Word (doc, docx), PowerPoint (ppt, pptx), OpenDocument (odt, odp) and RTF; anything that is not already a PDF is converted first. Setting replace to true reconverts and overwrites the existing flipbook for the same URL. Poll this same tool with the same URL until state is "processed". This is the preferred way to convert a URL.
heyzine_delete_flipbook
ChatGPTPermanently delete a flipbook. This cannot be undone from the API.
heyzine_flipbook_details
ChatGPTReturn the full details of one flipbook: URLs, page count, design settings and publication data.
heyzine_list_bookshelf_flipbooks
ChatGPTList the flipbooks placed on one bookshelf, in display order.
heyzine_list_bookshelves
ChatGPTList the bookshelves in the account. Requires a plan that includes bookshelves.
heyzine_list_flipbooks
ChatGPTList the flipbooks in the account, most recent first.
heyzine_oembed
ChatGPTReturn the oEmbed representation, including the embed HTML, for a public Heyzine flipbook URL.
heyzine_page_text
ChatGPTReturn the extracted plain text of a single page of a flipbook.
heyzine_remove_from_bookshelf
ChatGPTRemove a flipbook from a bookshelf. The flipbook itself is not deleted.
heyzine_replace_flipbook_pdf
ChatGPTReplace the source document of an existing flipbook, keeping its id, URL, design and statistics. Restricted endpoint: requires a paid plan and an account explicitly allowed by Heyzine support.
heyzine_search_text
ChatGPTFull text search across every flipbook in the account. Returns the flipbook id, page number and a surrounding text snippet for each match.
heyzine_set_bookshelf_social
ChatGPTOverwrite the supplied Open Graph title, description and thumbnail shown publicly when a bookshelf is shared on social networks.
heyzine_set_flipbook_social
ChatGPTOverwrite the supplied Open Graph title, description and thumbnail shown publicly when a flipbook is shared on social networks.
heyzine_update_flipbook_design
ChatGPTOverwrite the supplied design and publication settings of an existing public flipbook. Changing url_path or url_domain changes its public URL and can break existing links.
Capabilities
Writes
Example Prompts
Click any prompt to copy it.
