How to Use the Heyzine MCP in Pydantic AI

Q: How do I add Heyzine tools to my Pydantic AI agent?

You'll import and instantiate the MCPToolset, giving it the server URL provided by Vinkius. Then, you pass a list containing that toolset to your Agent's toolsets parameter. Pydantic AI handles the rest.

Q: How does error handling work for Heyzine tools with Pydantic AI?

If a tool like deleteflipbook fails on the API side, the server will return a standard error. If the tool succeeds but returns malformed data, your Pydantic AI agent will raise a validation error locally, which you can catch and handle in your Python code.

Build reliable publishing agents with Pydantic AI. Get type-safe, validated outputs from every Heyzine API call.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Heyzine MCP to Pydantic AI

Create your Vinkius account to connect Heyzine to Pydantic AI and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup Heyzine with Pydantic AI

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Convert PDFs with Confidence

Run `convert_pdf_to_flipbook` and know exactly what you're getting back. Pydantic AI automatically validates the response, ensuring you always receive a properly formatted object with a string URL and integer ID. No more defensive coding or checking for missing keys. If the Heyzine API ever returns something unexpected, your code will raise a `ValidationError` immediately. This means you find out about problems during development, not when a user reports a broken link. It’s about building a system you can trust.

Safely Manage Flipbook Designs

When you call `update_flipbook_design`, you're sending structured data. Pydantic AI helps ensure the data you send matches what the tool expects. More importantly, when you fetch data using `get_flipbook_details`, the entire response is parsed into a Pydantic model. This guarantees that fields like titles, creation dates, and view counts are the correct type. Your agent won't crash because it was expecting a number and got a string. This type-safety is critical for building robust agents that don't break on minor API changes.

Build Reliable Automations with Pydantic AI

This is about building an automation pipeline that doesn't silently fail. You can create an agent that calls `list_all_flipbooks`, iterates through the validated list, and then organizes them with `add_flipbook_to_bookshelf`. Every step of the way, the data is checked. Because Pydantic AI is model-agnostic, you can use this same type-safe approach with any LLM—OpenAI, local models, you name it. The Heyzine MCP server provides the tools, and Pydantic AI provides the guarantee that your agent is working with clean data.

Setup guide

Set up Heyzine MCP in Pydantic AI

Prerequisites

Python 3.10+ installed
pydantic-ai-slim[fastmcp] package
Active Vinkius subscription with a valid endpoint token

1

Install Pydantic AI with FastMCP
Run pip install "pydantic-ai-slim[fastmcp]". The FastMCP toolset replaces the deprecated MCPServerHTTP class with full protocol support.
2

Configure the FastMCPToolset
Pass a JSON-style config dict to FastMCPToolset with your Vinkius URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. Supports Streamable HTTP, SSE, and Stdio transports.
3

Create and run your agent
Pass the toolset to Agent(toolsets=[toolset]) and call agent.run(). Swap openai:gpt-4o for any supported model — Anthropic, Google, Mistral, or Groq.

agent.py

from pydantic_ai import Agent
from pydantic_ai.toolsets.fastmcp import FastMCPToolset

toolset = FastMCPToolset({
    "mcpServers": {
        "heyzine-mcp": {
            "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
        }
    }
})

agent = Agent(
    "openai:gpt-4o",
    toolsets=[toolset],
    system_prompt="You have access to Heyzine tools.",
)

result = await agent.run("List recent Heyzine transactions")
print(result.output)

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by Heyzine. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect Heyzine now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about Heyzine MCP in Pydantic AI

You'll import and instantiate the `MCPToolset`, giving it the server URL provided by Vinkius. Then, you pass a list containing that toolset to your `Agent`'s `toolsets` parameter. Pydantic AI handles the rest.

By default, Pydantic will ignore extra fields, so your agent won't break. If a required field is missing or has the wrong type, however, Pydantic AI will raise a `ValidationError`, stopping your agent from processing corrupt data.

Yes. Pydantic AI is model-agnostic. You can connect the Heyzine MCP server and use it with Llama, Mixtral, or any other model supported by the framework, giving you type-safe outputs regardless of the backend.

If a tool like `delete_flipbook` fails on the API side, the server will return a standard error. If the tool succeeds but returns malformed data, your Pydantic AI agent will raise a validation error locally, which you can catch and handle in your Python code.

The server only processes the PDF content and flipbook metadata needed to execute a tool. Pydantic AI adds a layer of security by validating the structure of the data returned by the API at runtime. This prevents malformed or unexpected data from the server from propagating into your application's logic.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript