Quickstart

SDK’s

We currently support Python and TypeScript/Node.js. If you would like us to support another language, please reach out to us.

Python

Node/TS

Quick Install

Install AgentMail using your preferred package manager:

$
pip install agentmail

Prerequisites

• Python 3.8 or higher
• An AgentMail API key (Request your API key)

Verify Installation

Test your installation:

1
from agentmail import AgentMail
2
3
# Should print the version number
4
print(AgentMail.__version__)

Basic Usage

Here’s how to initialize the client and create your first inbox:

1
from agentmail import AgentMail
2
3
# Initialize the client
4
5
client = AgentMail(api_key="YOUR_API_KEY")
6
7
# Create an inbox
8
9
inbox = client.inboxes.create(domain="yourdomain.com")

Error Handling

Handle API errors gracefully with built-in error types:

1
from agentmail.core.api_error import ApiError
2
3
try:
4
    client.inboxes.create(domain="yourdomain.com")
5
except ApiError as e:
6
    print(f"Error {e.status_code}: {e.body}")

Async Support

Python users can also use our async client for non-blocking operations:

1
import asyncio
2
from agentmail import AsyncAgentMail
3
4
async_client = AsyncAgentMail(api_key="YOUR_API_KEY")
5
6
async def main():
7
    await async_client.inboxes.create(domain="yourdomain.com")
8
9
asyncio.run(main())

Environment Support

• Python: Python 3.8+
• TypeScript/Node.js: Node.js 18+, Vercel, Cloudflare Workers, Deno v1.25+, Bun 1.0+, React Native

Need Help?