[ENG-312] Quickest Start

[tanishq-atm]

Summary by cubic

Added a “Quickest start” section at the top of the Quickstart page with copy-paste install commands and working Python/TypeScript snippets to send an email fast. Addresses ENG-312 by surfacing the shortest path and linking to the Console for the API key.

• New Features

  • Pip/npm install commands and ready-to-run Python/TypeScript examples with API key guidance.

• Bug Fixes

  • Corrected the Python send example to use inbox.inbox_id and proper parameters.

^{Written for commit 477d136. Summary will update on new commits.}

[github-actions]

🌿 Preview your docs: https://agentmail-preview-a174b4ac-721e-4cfd-8fe8-47f4a4b0b287.docs.buildwithfern.com

[cubic-dev-ai]

1 issue found across 1 file

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="fern/pages/get-started/quickstart.mdx">

<violation number="1" location="fern/pages/get-started/quickstart.mdx:35">
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.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

[cubic-dev-ai]

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>