Heyzine API

Name: Heyzine API
Brand: Heyzine API
Availability: InStock

✓ Official Vendor SpecMediaContent DeliveryapiKey4 EndpointsREST

For Agents

Convert PDFs into shareable interactive flipbooks by creating Heyzine flipbook records, then retrieving the embed URL or deleting the flipbook when no longer needed.

Install Jentic One Beta

Connect the Heyzine API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Heyzine API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fheyzine.com%2Fheyzine" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fheyzine.com%2Fheyzine" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Heyzine API.

Convert a PDF into an interactive flipbook with shareable URL via POST /flipbooks

List all existing flipbooks for the authenticated account through GET /flipbooks

Retrieve a specific flipbook's metadata and embed URL via GET /flipbooks/{flipbookId}

GET STARTED

Start building with Heyzine API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Heyzine API for, with concrete tasks.

★ Marketing Asset Distribution

Marketing teams convert quarterly PDF reports and brochures into interactive flipbooks by sending the PDF URL to POST /flipbooks. The response includes a shareable URL and embed code that can be dropped into landing pages, emails, and partner portals - replacing static PDF downloads with a tracked, page-flip experience.

Call POST /flipbooks with pdf_url=https://cdn.example.com/q2-report.pdf, then capture the returned flipbook_id and share URL.

Catalogue Lifecycle Management

Retail catalogue owners maintain a flipbook per product season and roll old issues off the public site by calling DELETE /flipbooks/{flipbookId} once a new catalogue ships. GET /flipbooks lists active titles, making it easy to script retention rules (e.g., keep only the four most recent catalogues live).

Call GET /flipbooks, sort by created_at descending, and call DELETE /flipbooks/{flipbookId} for any flipbook beyond the fourth most recent.

Editorial Publishing Pipeline

Editorial teams render their CMS output to PDF, then post the PDF to POST /flipbooks during the publish step. The returned share URL is written back to the CMS as the canonical reader-facing link, letting writers focus on content while distribution happens automatically.

Listen for new published articles, render to PDF, call POST /flipbooks with the PDF URL, and write the returned share URL back to the article record.

AI Agent Document Conversion

Through Jentic, an AI agent can be asked to 'turn this PDF into a flipbook' and execute POST /flipbooks via Heyzine without storing the API key. Jentic's vault holds the X-API-Key, so the agent simply passes the PDF URL and returns the share link to the user.

Search Jentic for 'create a flipbook from a pdf', load the schema for POST /flipbooks, and execute with the user-provided PDF URL.

Key Endpoints

4 endpoints — the heyzine api converts pdf documents into interactive online flipbooks.

METHOD

PATH

DESCRIPTION

POST

/flipbooks

Create a flipbook from a PDF source

GET

/flipbooks

List all flipbooks for the account

GET

/flipbooks/{flipbookId}

Retrieve a specific flipbook

DELETE

/flipbooks/{flipbookId}

Delete a flipbook

POST

/flipbooks

Create a flipbook from a PDF source

GET

/flipbooks

List all flipbooks for the account

GET

/flipbooks/{flipbookId}

Retrieve a specific flipbook

DELETE

/flipbooks/{flipbookId}

Delete a flipbook

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the Heyzine API by hand means learning its X-API-Key header auth and writing your own retry logic around the flipbook create, list, read, and delete endpoints. Through Jentic you install once, import the Heyzine API from the API Directory, store the key once, and your agent calls it.

Permission scoping

Heyzine puts the flipbook id in the URL path (/flipbooks/{flipbookId}), so a rule can pin your agent to acting on specific flipbooks. You choose the operations it may call, so deleting a flipbook with DELETE is only included if you add it, while creating, listing, and reading flipbooks stays separate.

Credential isolation

Your Heyzine API key is stored once, encrypted, by your own Jentic One instance and injected as the X-API-Key header at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create a flipbook from a PDF' or 'list existing flipbooks', and Jentic returns the matching Heyzine operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Heyzine API through Jentic.

What authentication does the Heyzine API use?

Heyzine uses an API key passed in the X-API-Key header. The key is provisioned by contacting Heyzine support - there is no self-service generation in the dashboard. Through Jentic, the key is stored encrypted in the vault and injected at execution time.

Can I create a flipbook from a hosted PDF with the Heyzine API?

Yes. POST /flipbooks accepts a PDF URL (and any flipbook configuration the spec exposes) and returns a flipbook_id along with the public share URL once the conversion completes.

How do I create a flipbook through Jentic?

Run pip install jentic, search for 'create a flipbook from a pdf', and execute against POST /flipbooks. Jentic resolves the X-API-Key from the vault and returns the JSON response with the share URL.

Can I delete an old flipbook?

Yes. DELETE /flipbooks/{flipbookId} removes the flipbook and invalidates its public share URL. Use it to retire obsolete catalogues or campaign assets.

What rate limits apply to the Heyzine API?

Heyzine has not published explicit rate limits in the spec. Implement exponential backoff on HTTP 429 responses and prefer batching by triggering POST /flipbooks during off-peak hours when bulk converting an archive.

Can I limit what my agent is allowed to do with the Heyzine API?

Yes. Because you run Jentic One yourself, your own rules decide which Heyzine operations the agent may call, so you can grant reading and listing flipbooks (GET /flipbooks and GET /flipbooks/{flipbookId}) while withholding creation via POST /flipbooks or deletion via DELETE /flipbooks/{flipbookId}. Since the flipbook id lives in the URL path, a rule can also pin the agent to acting on specific flipbooks rather than the whole account. The stored X-API-Key stays under your control and is injected only for the operations you have allowed.

Heyzine API

Connect the Heyzine API to your agent

Capabilities

Start building with Heyzine API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs