Skip to content

[ENG-312] Quickest Start #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tanishq-atm merged 1 commit into from
Mar 3, 2026
Merged

[ENG-312] Quickest Start #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 37 additions & 6 deletions fern/pages/get-started/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,38 @@ slug: quickstart
description: Follow this guide to make your first AgentMail API request and create a new email inbox.
---

## Quickest start

<CodeBlocks>
```bash title="Python"
pip install agentmail
```

```bash title="TypeScript"
npm install agentmail
```
</CodeBlocks>

Get your API key from the [Console](https://console.agentmail.to) and replace `am_...` in the code below.

<CodeBlocks>
```python title="Python"
from agentmail import AgentMail

client = AgentMail(api_key="am_...")
inbox = client.inboxes.create()
client.inboxes.messages.send(inbox.inbox_id, to="user@example.com", subject="Hello", text="Hello from my agent!")
```

```typescript title="TypeScript"
import { AgentMailClient } from "agentmail";

const client = new AgentMailClient({ apiKey: "am_..." });
const inbox = await client.inboxes.create();
Copy link

@cubic-dev-ai cubic-dev-ai bot Mar 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: Wrap the quickstart TypeScript async calls in an async function (or async IIFE) so the snippet runs in typical setups without requiring top-level-await module configuration.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At fern/pages/get-started/quickstart.mdx, line 35:

<comment>Wrap the quickstart TypeScript async calls in an async function (or async IIFE) so the snippet runs in typical setups without requiring top-level-await module configuration.</comment>

<file context>
@@ -5,6 +5,38 @@ slug: quickstart
+  import { AgentMailClient } from "agentmail";
+
+  const client = new AgentMailClient({ apiKey: "am_..." });
+  const inbox = await client.inboxes.create();
+  await client.inboxes.messages.send(inbox.inboxId, { to: "user@example.com", subject: "Hello", text: "Hello from my agent!" });
+  ```
</file context>
Fix with Cubic

await client.inboxes.messages.send(inbox.inboxId, { to: "user@example.com", subject: "Hello", text: "Hello from my agent!" });
```
</CodeBlocks>

This guide will walk you through installing the AgentMail SDK, authenticating with your API key, and creating your first email inbox.

<Steps>
Expand Down Expand Up @@ -71,12 +103,11 @@ This guide will walk you through installing the AgentMail SDK, authenticating wi
# Send Email

client.inboxes.messages.send(
inbox_id="your-email@example.com",
to="contact@agentmail.to",
subject="Hello from AgentMail!",
text="This is my first email sent with the AgentMail API."

)
inbox.inbox_id,
to="your-email@example.com",
subject="Hello from AgentMail!",
text="This is my first email sent with the AgentMail API.",
)

```

Expand Down