Quickstart

Get your API Key

First, you’ll need an AgentMail API key. You can request one from the link below.

Once you have your key, create a .env file in your project’s root directory and add your key to it. We recommend using environment variables to keep your keys secure.

1
AGENTMAIL_API_KEY="YOUR_API_KEY"

Install the SDK

Install the AgentMail SDK using your preferred package manager. We’ll also use a library to load the environment variable from the .env file.

$
pip install agentmail python-dotenv

Create an inbox and send an email

Now you’re ready to make your first API call. Create a new file (e.g., quickstart.py or quickstart.ts) and add the following code. This script will initialize the AgentMail client, create a new inbox, and then send a test email.

1
import os
2
from dotenv import load_dotenv
3
from agentmail import AgentMail
4
5
# Load the API key from the .env file
6
load_dotenv()
7
api_key = os.getenv("AGENTMAIL_API_KEY")
8
9
# Initialize the client
10
client = AgentMail(api_key=api_key)
11
12
# Create an inbox
13
print("Creating inbox...")
14
inbox = client.inboxes.create() # domain is optional
15
print("Inbox created successfully!")
16
print(inbox)

Run the code

Execute the script from your terminal.

$
python quickstart.py

You should see the details of your newly created inbox printed to the console. Congratulations, you’ve successfully created your first AgentMail inbox!