# Heyzine — how to use (mcp.ai)

Connect your Heyzine account and use 14 tools for documents straight from your AI agent. Connect with your own API key. Heyzine is a flipbook maker that converts PDFs into interactive, customizable digital publications with various page flip effects.

## Option A — via MCP (recommended)
Remote MCP endpoint (HTTP, streamable): `https://api.mcp.ai/p_heyzine?ms=1787296080000`
Add it as a custom/remote MCP connector in your client (Claude, Cursor, VS Code…), then authenticate when prompted. Once connected, ask the agent to use the server's tools (e.g. `heyzine_create_flipbook_link`).

## Option B — via direct REST API
Base URL: `https://api.mcp.ai/api/heyzine`
Auth: `Authorization: Bearer sk_live_…` — create a workspace API key at https://mcp.ai/settings/api-keys
Discover endpoints: `GET https://api.mcp.ai/api/heyzine/_endpoints`

### Endpoints
- `POST https://api.mcp.ai/api/heyzine/create/flipbook/link` — Tool to create a direct flipbook link. Use when you have a document URL and want to convert it to a flipbook.
  - body: { d?: string, k: string, s?: string, t?: string, bg?: string, ds?: string, fs?: string, lg?: string, pn?: string, sh?: string, st?: string, pdf: string, tpl?: string }
- `POST https://api.mcp.ai/api/heyzine/create/flipbook/rest/async` — Tool to create a flipbook asynchronously. Use when converting large documents off-thread; poll for updates on conversion state.
  - body: { pdf: string, logo?: string, tags?: string, share?: boolean, title?: string, download?: boolean, subtitle?: string, template?: string, client_id: string, prev_next?: boolean, show_info?: boolean, description?: string, full_screen?: boolean, private_note?: string, background_color?: string }
- `POST https://api.mcp.ai/api/heyzine/create/flipbook/rest/sync` — Tool to convert a PDF, DOCX, or PPTX into a flipbook synchronously via REST API. Use when you need immediate flipbook URLs from a direct file link.
  - body: { pdf: string, logo?: string, tags?: string, share?: boolean, title?: string, download?: boolean, subtitle?: string, template?: string, client_id: string, prev_next?: boolean, show_info?: boolean, description?: string, full_screen?: boolean, private_note?: string, background_color?: string }
- `POST https://api.mcp.ai/api/heyzine/delete/flipbook` — Tool to delete a flipbook. Use when you need to permanently remove an unwanted flipbook.
  - body: { id: string }
- `POST https://api.mcp.ai/api/heyzine/get/api/limits` — Tool to retrieve API rate limits. Use when you need to check your current API usage and limits.
- `POST https://api.mcp.ai/api/heyzine/get/flipbook/id/tool` — Tool to retrieve HTML for Flipbook ID tool. Use when you need to fetch the ID input tool page HTML for a specific flipbook.
  - body: { flipbook_id: string }
- `POST https://api.mcp.ai/api/heyzine/get/flipbook/list` — Tool to retrieve all flipbooks. Use when you need to list every flipbook for the authenticated account.
  - body: { tag?: string, page?: integer, limit?: integer, search?: string }
- `POST https://api.mcp.ai/api/heyzine/get/flipbook/social/metadata` — Tool to retrieve social metadata for a specific flipbook. Use after configuring social sharing to fetch title, description, and thumbnail.
  - body: { flipbook_id: string }
- `POST https://api.mcp.ai/api/heyzine/get/j/query/plugin` — Tool to retrieve the Heyzine jQuery plugin script URL and usage snippet. Use when you need to integrate Heyzine flipbooks via jQuery on your website.
- `POST https://api.mcp.ai/api/heyzine/setup/webhooks` — Helper tool to validate prerequisites for Heyzine webhooks. Heyzine does not expose an API to programmatically configure webhooks; this action verifies API connectivity and returns clear guidance to c
  - body: { event: string, frequency: integer, endpoint_url: string }
- `POST https://api.mcp.ai/api/heyzine/update/flipbook/access/list` — Tool to update the access list of a flipbook. Use when replacing all user access permissions in bulk.
  - body: { access_list: object[], flipbook_id: string }
- `POST https://api.mcp.ai/api/heyzine/update/flipbook/password/protection` — Tool to update flipbook password protection settings. Use when you need to change or disable password protection for a flipbook.
  - body: { mode: string, name: string, password?: string, text_user?: string, text_password?: string }
- `POST https://api.mcp.ai/api/heyzine/update/flipbook/social/metadata` — Tool to update a flipbook's social metadata. Use when you need to change title, description, or thumbnail for social sharing.
  - body: { title?: string, thumbnail?: string, description?: string, flipbook_id: string }
- `POST https://api.mcp.ai/api/heyzine/webhooks/leads` — Tool to receive webhook events when new leads are collected on a flipbook form. Use after configuring your Heyzine account Webhooks > Leads URL.
  - body: { data: object }

## Example prompts
- "What can I do in Heyzine?"
- "Show me a summary of my Heyzine account"

## More
- Page: https://mcp.ai/heyzine
- Agent spec (llms.txt): https://mcp.ai/heyzine/llms.txt
- Postman collection: https://mcp.ai/heyzine/postman.json