# How to integrate Convertapi MCP with Pydantic AI ```json { "title": "How to integrate Convertapi MCP with Pydantic AI", "toolkit": "Convertapi", "toolkit_slug": "convertapi", "framework": "Pydantic AI", "framework_slug": "pydantic-ai", "url": "https://composio.dev/toolkits/convertapi/framework/pydantic-ai", "markdown_url": "https://composio.dev/toolkits/convertapi/framework/pydantic-ai.md", "updated_at": "2026-05-12T10:07:32.181Z" } ``` ## Introduction This guide walks you through connecting Convertapi to Pydantic AI using the Composio tool router. By the end, you'll have a working Convertapi agent that can convert pdf invoice to editable docx, turn pdf presentation into jpg images, list all formats convertible to xlsx through natural language commands. This guide will help you understand how to give your Pydantic AI agent real control over a Convertapi account through Composio's Convertapi MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Convertapi with - [OpenAI Agents SDK](https://composio.dev/toolkits/convertapi/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/convertapi/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/convertapi/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/convertapi/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/convertapi/framework/codex) - [OpenClaw](https://composio.dev/toolkits/convertapi/framework/openclaw) - [Hermes](https://composio.dev/toolkits/convertapi/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/convertapi/framework/cli) - [Google ADK](https://composio.dev/toolkits/convertapi/framework/google-adk) - [LangChain](https://composio.dev/toolkits/convertapi/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/convertapi/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/convertapi/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/convertapi/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/convertapi/framework/crew-ai) ## TL;DR Here's what you'll learn: - How to set up your Composio API key and User ID - How to create a Composio Tool Router session for Convertapi - How to attach an MCP Server to a Pydantic AI agent - How to stream responses and maintain chat history - How to build a simple REPL-style chat interface to test your Convertapi workflows ## What is Pydantic AI? Pydantic AI is a Python framework for building AI agents with strong typing and validation. It leverages Pydantic's data validation capabilities to create robust, type-safe AI applications. Key features include: - Type Safety: Built on Pydantic for automatic data validation - MCP Support: Native support for Model Context Protocol servers - Streaming: Built-in support for streaming responses - Async First: Designed for async/await patterns ## What is the Convertapi MCP server, and what's possible with it? The Convertapi MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Convertapi account. It provides structured and secure access to file conversion and management tools, so your agent can perform actions like converting documents, uploading files, retrieving converted outputs, and managing temporary file storage on your behalf. - Multi-format file conversion: Instantly convert documents, images, and spreadsheets between formats like PDF, DOCX, and JPG with just a prompt. - Bulk and asynchronous processing: Use asynchronous conversion for large files or batch jobs, allowing your agent to handle long-running tasks without delays. - File upload and remote import: Upload files directly or import them from remote URLs, making it easy to work with files stored anywhere on the web. - Download and manage uploaded files: Retrieve converted outputs, download original or processed files, or delete unused uploads from temporary storage. - Format compatibility discovery: Ask your agent to list which formats can be converted to a desired output, ensuring smooth workflow automation. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `CONVERTAPI_ASYNC_CONVERT` | Async Convert | Tool to perform an asynchronous file conversion. Use when converting large or long-running files to avoid client timeouts. | | `CONVERTAPI_ASYNC_DELETE_JOB` | Delete Async Job | Tool to delete a previously created asynchronous conversion job. Use when the job is no longer required to free server resources. | | `CONVERTAPI_CHECK_CONVERSION_SUPPORT` | Check Conversion Support | Tool to check whether a specific file format conversion is supported by ConvertAPI. Use this before attempting conversions to verify compatibility and avoid errors. | | `CONVERTAPI_CONVERT_DELETE_UPLOADED_FILE` | Delete Uploaded File | Tool to delete a previously uploaded file. Use when the file is no longer needed and should be removed from temporary storage. | | `CONVERTAPI_CONVERT_GET_SUPPORTED_INPUT_FORMATS_FOR_OUTPUT` | Get Supported Input Formats For Output | Retrieves a complete list of input file formats that ConvertAPI can convert to a specified output format. Use this to check which source formats are compatible with your desired target format before initiating conversions. | | `CONVERTAPI_CONVERT_PDF_TO_DOCX` | Convert PDF to DOCX | Tool to convert PDF files to DOCX format. Use when you need editable Word documents from PDFs. Provide PDF content or URL and receive DOCX file metadata and download links. | | `CONVERTAPI_CONVERT_PDF_TO_JPG_AND_STORE` | Convert PDF to JPG and Store | Tool to convert a PDF to JPG and store the result on the server. Use when individual JPG pages are needed for further workflow steps. | | `CONVERTAPI_CONVERT_UPLOAD_FILE_FROM_URL` | Upload File From URL | Tool to upload a file directly from a remote URL. Use when you need to import files hosted on a remote server without downloading locally. | | `CONVERTAPI_DOWNLOAD_FILE` | Download File | Tool to download a converted or uploaded file from ConvertAPI server using its FileId. Use when you need to retrieve a previously converted or uploaded file. Set download='inline' to display in browser. | | `CONVERTAPI_DOWNLOAD_UPLOADED_FILE` | Download Uploaded File | Tool to download a previously uploaded file by its FileId. Use when you need to retrieve the original file data stored temporarily on the server (expires after 3 hours). Example prompt: "Download uploaded file with ID 25811safe8e61dd3f51ef00ee5f58b92" | | `CONVERTAPI_GET_CONVERTER_SPEC` | Get Converter Spec | Tool to retrieve the OpenAPI specification for a specific file conversion endpoint. Use when you need detailed parameter schemas and documentation for converting from one format to another. | | `CONVERTAPI_GET_FILE_INFO` | Get File Info | Tool to get metadata information about a stored file without downloading it. Use when you need to check file properties like name, size, or type before downloading. | | `CONVERTAPI_GET_OPENAPI_SCHEMA` | Get OpenAPI Schema | Tool to retrieve the complete OpenAPI 3.0 specification for all ConvertAPI endpoints. Use when you need comprehensive API documentation for code generation, automated testing, or understanding available conversion operations and their parameters. | | `CONVERTAPI_GET_SUPPORTED_OUTPUT_FORMATS_FOR_INPUT` | Get Supported Output Formats For Input | Tool to list all output formats a given input format can be converted into. Use when you need to dynamically retrieve conversion options for a specific input format. | | `CONVERTAPI_GET_USER` | Get User Information | Tool to get authenticated user account information including balance, conversions consumed, and remaining seconds. Use when you need to check account status or conversion limits. | | `CONVERTAPI_GET_USER_STATISTICS` | Get User Statistics | Tool to retrieve usage statistics for the authenticated user account. Use when you need to analyze conversions performed during a specific date range. | | `CONVERTAPI_LIST_CONVERTERS` | List All Converters | Tool to retrieve a comprehensive list of all available file converters in ConvertAPI. Use when you need to discover all supported conversion types, check which formats can be converted, or view available parameters for each converter. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Convertapi MCP server is an implementation of the Model Context Protocol that connects your AI agent to Convertapi. It provides structured and secure access so your agent can perform Convertapi operations on your behalf through a secure, permission-based interface. With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster. ## Step-by-step Guide ### 1. Prerequisites Before starting, make sure you have: - Python 3.9 or higher - A Composio account with an active API key - Basic familiarity with Python and async programming ### 1. Getting API Keys for OpenAI and Composio OpenAI API Key - Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) and create an API key. You'll need credits to use the models, or you can connect to another model provider. - Keep the API key safe. Composio API Key - Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs). - Navigate to your API settings and generate a new API key. - Store this key securely as you'll need it for authentication. ### 2. Install dependencies Install the required libraries. What's happening: - composio connects your agent to external SaaS tools like Convertapi - pydantic-ai lets you create structured AI agents with tool support - python-dotenv loads your environment variables securely from a .env file ```bash pip install composio pydantic-ai python-dotenv ``` ### 3. Set up environment variables Create a .env file in your project root. What's happening: - COMPOSIO_API_KEY authenticates your agent to Composio's API - USER_ID associates your session with your account for secure tool access - OPENAI_API_KEY to access OpenAI LLMs ```bash COMPOSIO_API_KEY=your_composio_api_key_here USER_ID=your_user_id_here OPENAI_API_KEY=your_openai_api_key ``` ### 4. Import dependencies What's happening: - We load environment variables and import required modules - Composio manages connections to Convertapi - MCPServerStreamableHTTP connects to the Convertapi MCP server endpoint - Agent from Pydantic AI lets you define and run the AI assistant ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from pydantic_ai import Agent from pydantic_ai.mcp import MCPServerStreamableHTTP load_dotenv() ``` ### 5. Create a Tool Router Session What's happening: - We're creating a Tool Router session that gives your agent access to Convertapi tools - The create method takes the user ID and specifies which toolkits should be available - The returned session.mcp.url is the MCP server URL that your agent will use ```python async def main(): api_key = os.getenv("COMPOSIO_API_KEY") user_id = os.getenv("USER_ID") if not api_key or not user_id: raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment") # Create a Composio Tool Router session for Convertapi composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["convertapi"], ) url = session.mcp.url if not url: raise ValueError("Composio session did not return an MCP URL") ``` ### 6. Initialize the Pydantic AI Agent What's happening: - The MCP client connects to the Convertapi endpoint - The agent uses GPT-5 to interpret user commands and perform Convertapi operations - The instructions field defines the agent's role and behavior ```python # Attach the MCP server to a Pydantic AI Agent convertapi_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[convertapi_mcp], instructions=( "You are a Convertapi assistant. Use Convertapi tools to help users " "with their requests. Ask clarifying questions when needed." ), ) ``` ### 7. Build the chat interface What's happening: - The agent reads input from the terminal and streams its response - Convertapi API calls happen automatically under the hood - The model keeps conversation history to maintain context across turns ```python # Simple REPL with message history history = [] print("Chat started! Type 'exit' or 'quit' to end.\n") print("Try asking the agent to help you with Convertapi.\n") while True: user_input = input("You: ").strip() if user_input.lower() in {"exit", "quit", "bye"}: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n", flush=True) async with agent.run_stream(user_input, message_history=history) as stream_result: collected_text = "" async for chunk in stream_result.stream_output(): text_piece = None if isinstance(chunk, str): text_piece = chunk elif hasattr(chunk, "delta") and isinstance(chunk.delta, str): text_piece = chunk.delta elif hasattr(chunk, "text"): text_piece = chunk.text if text_piece: collected_text += text_piece result = stream_result print(f"Agent: {collected_text}\n") history = result.all_messages() ``` ### 8. Run the application What's happening: - The asyncio loop launches the agent and keeps it running until you exit ```python if __name__ == "__main__": asyncio.run(main()) ``` ## Complete Code ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from pydantic_ai import Agent from pydantic_ai.mcp import MCPServerStreamableHTTP load_dotenv() async def main(): api_key = os.getenv("COMPOSIO_API_KEY") user_id = os.getenv("USER_ID") if not api_key or not user_id: raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment") # Create a Composio Tool Router session for Convertapi composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["convertapi"], ) url = session.mcp.url if not url: raise ValueError("Composio session did not return an MCP URL") # Attach the MCP server to a Pydantic AI Agent convertapi_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[convertapi_mcp], instructions=( "You are a Convertapi assistant. Use Convertapi tools to help users " "with their requests. Ask clarifying questions when needed." ), ) # Simple REPL with message history history = [] print("Chat started! Type 'exit' or 'quit' to end.\n") print("Try asking the agent to help you with Convertapi.\n") while True: user_input = input("You: ").strip() if user_input.lower() in {"exit", "quit", "bye"}: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n", flush=True) async with agent.run_stream(user_input, message_history=history) as stream_result: collected_text = "" async for chunk in stream_result.stream_output(): text_piece = None if isinstance(chunk, str): text_piece = chunk elif hasattr(chunk, "delta") and isinstance(chunk.delta, str): text_piece = chunk.delta elif hasattr(chunk, "text"): text_piece = chunk.text if text_piece: collected_text += text_piece result = stream_result print(f"Agent: {collected_text}\n") history = result.all_messages() if __name__ == "__main__": asyncio.run(main()) ``` ## Conclusion You've built a Pydantic AI agent that can interact with Convertapi through Composio's Tool Router. With this setup, your agent can perform real Convertapi actions through natural language. You can extend this further by: - Adding other toolkits like Gmail, HubSpot, or Salesforce - Building a web-based chat interface around this agent - Using multiple MCP endpoints to enable cross-app workflows (for example, Gmail + Convertapi for workflow automation) This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations. ## How to build Convertapi MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/convertapi/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/convertapi/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/convertapi/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/convertapi/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/convertapi/framework/codex) - [OpenClaw](https://composio.dev/toolkits/convertapi/framework/openclaw) - [Hermes](https://composio.dev/toolkits/convertapi/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/convertapi/framework/cli) - [Google ADK](https://composio.dev/toolkits/convertapi/framework/google-adk) - [LangChain](https://composio.dev/toolkits/convertapi/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/convertapi/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/convertapi/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/convertapi/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/convertapi/framework/crew-ai) ## Related Toolkits - [Google Drive](https://composio.dev/toolkits/googledrive) - Google Drive is a cloud storage platform for uploading, sharing, and collaborating on files. It's perfect for keeping your documents accessible and organized across devices. - [Google Docs](https://composio.dev/toolkits/googledocs) - Google Docs is a cloud-based word processor that enables document creation and real-time collaboration. Its seamless sharing and version history make team editing and content management a breeze. - [Google Super](https://composio.dev/toolkits/googlesuper) - Google Super is an all-in-one suite combining Gmail, Drive, Calendar, Sheets, Analytics, and more. It gives you a unified platform to manage your digital life, boosting productivity and organization. - [Affinda](https://composio.dev/toolkits/affinda) - Affinda is an AI-powered document processing platform that automates data extraction from resumes, invoices, and more. It streamlines document-heavy workflows by turning files into structured, actionable data. - [Agility cms](https://composio.dev/toolkits/agility_cms) - Agility CMS is a headless content management system for building and managing digital experiences across platforms. It lets teams update content quickly and deliver omnichannel experiences with ease. - [Algodocs](https://composio.dev/toolkits/algodocs) - Algodocs is an AI-powered platform that automates data extraction from business documents. It delivers fast, secure, and accurate processing without templates or manual training. - [Api2pdf](https://composio.dev/toolkits/api2pdf) - Api2Pdf is a REST API for generating PDFs from HTML, URLs, and documents using powerful engines like wkhtmltopdf and Headless Chrome. It streamlines document conversion and automation for developers and businesses. - [Aryn](https://composio.dev/toolkits/aryn) - Aryn is an AI-powered platform for parsing, extracting, and analyzing data from unstructured documents. Use it to automate document processing and unlock actionable insights from your files. - [Boldsign](https://composio.dev/toolkits/boldsign) - Boldsign is a digital eSignature platform for sending, signing, and tracking documents online. Organizations use it to automate agreements and manage legally binding workflows efficiently. - [Boloforms](https://composio.dev/toolkits/boloforms) - BoloForms is an eSignature platform built for small businesses, offering unlimited signatures, templates, and forms. It simplifies digital document signing and team collaboration at a predictable, fixed price. - [Box](https://composio.dev/toolkits/box) - Box is a cloud content management and file sharing platform for businesses. It helps teams securely store, organize, and collaborate on files from anywhere. - [Carbone](https://composio.dev/toolkits/carbone) - Carbone is a blazing-fast report generator that turns JSON data into PDFs, Word docs, spreadsheets, and more using flexible templates. It lets you automate document creation at scale with minimal code. - [Castingwords](https://composio.dev/toolkits/castingwords) - CastingWords is a transcription service specializing in human-powered, accurate transcripts via a simple API. Get seamless audio-to-text conversion for interviews, meetings, podcasts, and more. - [Cloudconvert](https://composio.dev/toolkits/cloudconvert) - CloudConvert is a powerful file conversion service supporting over 200 file formats. It streamlines converting, compressing, and managing documents, media, and more, all in one place. - [Cloudlayer](https://composio.dev/toolkits/cloudlayer) - Cloudlayer is a document and asset generation service for creating PDFs and images via API or SDKs. It lets you automate high-quality doc creation, saving dev time and reducing manual work. - [Cloudpress](https://composio.dev/toolkits/cloudpress) - Cloudpress is a content export tool for Google Docs and Notion. It automates publishing to your favorite Content Management Systems. - [Contentful graphql](https://composio.dev/toolkits/contentful_graphql) - Contentful graphql is a content delivery API that lets you access Contentful data using GraphQL queries. It gives you efficient, flexible ways to fetch and manage structured content for any digital project. - [Conversion tools](https://composio.dev/toolkits/conversion_tools) - Conversion Tools is an online service for converting documents between formats such as PDF, Word, Excel, XML, and CSV. It lets you automate complex document workflows with just a few clicks. - [Craftmypdf](https://composio.dev/toolkits/craftmypdf) - CraftMyPDF is a web-based service for designing and generating PDFs with templates and live data. It streamlines document creation by automating personalized PDFs at scale. - [Docmosis](https://composio.dev/toolkits/docmosis) - Docmosis generates PDF and Word documents from user-defined templates. It's perfect for merging data fields to quickly produce reports, invoices, and business letters. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Convertapi MCP? With a standalone Convertapi MCP server, the agents and LLMs can only access a fixed set of Convertapi tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Convertapi and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with Pydantic AI? Yes, you can. Pydantic AI fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Convertapi tools. ### Can I manage the permissions and scopes for Convertapi while using Tool Router? Yes, absolutely. You can configure which Convertapi scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do. ### How safe is my data with Composio Tool Router? All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Convertapi data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) ยท [Composio docs](https://docs.composio.dev/llms.txt)