agentmail 0.4.18 → 0.4.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (166) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/domains/client/Client.d.ts +1 -1
  3. package/dist/cjs/api/resources/domains/client/Client.js +1 -1
  4. package/dist/cjs/api/resources/drafts/client/Client.d.ts +1 -1
  5. package/dist/cjs/api/resources/drafts/client/Client.js +1 -1
  6. package/dist/cjs/api/resources/inboxEvents/exports.d.ts +1 -0
  7. package/dist/cjs/api/resources/inboxEvents/exports.js +18 -0
  8. package/dist/cjs/api/resources/inboxEvents/index.d.ts +1 -0
  9. package/dist/cjs/api/resources/inboxEvents/index.js +17 -0
  10. package/dist/cjs/api/resources/inboxEvents/types/InboxEvent.d.ts +17 -0
  11. package/dist/cjs/api/resources/inboxEvents/types/InboxEvent.js +3 -0
  12. package/dist/cjs/api/resources/inboxEvents/types/InboxEventId.d.ts +4 -0
  13. package/dist/cjs/api/resources/inboxEvents/types/InboxEventId.js +3 -0
  14. package/dist/cjs/api/resources/inboxEvents/types/InboxEventType.d.ts +6 -0
  15. package/dist/cjs/api/resources/inboxEvents/types/InboxEventType.js +9 -0
  16. package/dist/cjs/api/resources/inboxEvents/types/ListInboxEventsResponse.d.ts +8 -0
  17. package/dist/cjs/api/resources/inboxEvents/types/ListInboxEventsResponse.js +3 -0
  18. package/dist/cjs/api/resources/inboxEvents/types/index.d.ts +4 -0
  19. package/dist/cjs/api/resources/inboxEvents/types/index.js +20 -0
  20. package/dist/cjs/api/resources/inboxes/client/Client.d.ts +4 -1
  21. package/dist/cjs/api/resources/inboxes/client/Client.js +14 -9
  22. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts +1 -1
  23. package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +1 -1
  24. package/dist/cjs/api/resources/inboxes/resources/events/client/Client.d.ts +32 -0
  25. package/dist/cjs/api/resources/inboxes/resources/events/client/Client.js +136 -0
  26. package/dist/cjs/api/resources/inboxes/resources/events/client/index.d.ts +1 -0
  27. package/dist/cjs/api/resources/inboxes/resources/events/client/index.js +17 -0
  28. package/dist/cjs/api/resources/inboxes/resources/events/client/requests/ListInboxEventsRequest.d.ts +10 -0
  29. package/dist/cjs/api/resources/inboxes/resources/events/client/requests/ListInboxEventsRequest.js +3 -0
  30. package/dist/cjs/api/resources/inboxes/resources/events/client/requests/index.d.ts +1 -0
  31. package/dist/cjs/api/resources/inboxes/resources/events/client/requests/index.js +2 -0
  32. package/dist/cjs/api/resources/inboxes/resources/events/exports.d.ts +2 -0
  33. package/dist/cjs/api/resources/inboxes/resources/events/exports.js +21 -0
  34. package/dist/cjs/api/resources/inboxes/resources/events/index.d.ts +1 -0
  35. package/dist/cjs/api/resources/inboxes/resources/events/index.js +17 -0
  36. package/dist/cjs/api/resources/inboxes/resources/index.d.ts +2 -0
  37. package/dist/cjs/api/resources/inboxes/resources/index.js +3 -1
  38. package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.d.ts +1 -1
  39. package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.js +1 -1
  40. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +1 -1
  41. package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +1 -1
  42. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +1 -1
  43. package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +1 -1
  44. package/dist/cjs/api/resources/index.d.ts +2 -0
  45. package/dist/cjs/api/resources/index.js +3 -1
  46. package/dist/cjs/api/resources/lists/client/Client.d.ts +1 -1
  47. package/dist/cjs/api/resources/lists/client/Client.js +1 -1
  48. package/dist/cjs/api/resources/organizations/client/Client.d.ts +6 -1
  49. package/dist/cjs/api/resources/organizations/client/Client.js +6 -1
  50. package/dist/cjs/api/resources/pods/client/Client.d.ts +1 -1
  51. package/dist/cjs/api/resources/pods/client/Client.js +1 -1
  52. package/dist/cjs/api/resources/pods/resources/domains/client/Client.d.ts +1 -1
  53. package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +1 -1
  54. package/dist/cjs/api/resources/pods/resources/drafts/client/Client.d.ts +1 -1
  55. package/dist/cjs/api/resources/pods/resources/drafts/client/Client.js +1 -1
  56. package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.d.ts +1 -1
  57. package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.js +1 -1
  58. package/dist/cjs/api/resources/pods/resources/lists/client/Client.d.ts +1 -1
  59. package/dist/cjs/api/resources/pods/resources/lists/client/Client.js +1 -1
  60. package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +1 -1
  61. package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +1 -1
  62. package/dist/cjs/api/resources/threads/client/Client.d.ts +2 -2
  63. package/dist/cjs/api/resources/threads/client/Client.js +2 -2
  64. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +1 -1
  65. package/dist/cjs/api/resources/webhooks/client/Client.js +1 -1
  66. package/dist/cjs/serialization/resources/inboxEvents/index.d.ts +1 -0
  67. package/dist/cjs/serialization/resources/inboxEvents/index.js +17 -0
  68. package/dist/cjs/serialization/resources/inboxEvents/types/InboxEvent.d.ts +21 -0
  69. package/dist/cjs/serialization/resources/inboxEvents/types/InboxEvent.js +53 -0
  70. package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventId.d.ts +7 -0
  71. package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventId.js +39 -0
  72. package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventType.d.ts +7 -0
  73. package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventType.js +39 -0
  74. package/dist/cjs/serialization/resources/inboxEvents/types/ListInboxEventsResponse.d.ts +16 -0
  75. package/dist/cjs/serialization/resources/inboxEvents/types/ListInboxEventsResponse.js +48 -0
  76. package/dist/cjs/serialization/resources/inboxEvents/types/index.d.ts +4 -0
  77. package/dist/cjs/serialization/resources/inboxEvents/types/index.js +20 -0
  78. package/dist/cjs/serialization/resources/index.d.ts +2 -0
  79. package/dist/cjs/serialization/resources/index.js +3 -1
  80. package/dist/cjs/version.d.ts +1 -1
  81. package/dist/cjs/version.js +1 -1
  82. package/dist/esm/BaseClient.mjs +2 -2
  83. package/dist/esm/api/resources/domains/client/Client.d.mts +1 -1
  84. package/dist/esm/api/resources/domains/client/Client.mjs +1 -1
  85. package/dist/esm/api/resources/drafts/client/Client.d.mts +1 -1
  86. package/dist/esm/api/resources/drafts/client/Client.mjs +1 -1
  87. package/dist/esm/api/resources/inboxEvents/exports.d.mts +1 -0
  88. package/dist/esm/api/resources/inboxEvents/exports.mjs +2 -0
  89. package/dist/esm/api/resources/inboxEvents/index.d.mts +1 -0
  90. package/dist/esm/api/resources/inboxEvents/index.mjs +1 -0
  91. package/dist/esm/api/resources/inboxEvents/types/InboxEvent.d.mts +17 -0
  92. package/dist/esm/api/resources/inboxEvents/types/InboxEvent.mjs +2 -0
  93. package/dist/esm/api/resources/inboxEvents/types/InboxEventId.d.mts +4 -0
  94. package/dist/esm/api/resources/inboxEvents/types/InboxEventId.mjs +2 -0
  95. package/dist/esm/api/resources/inboxEvents/types/InboxEventType.d.mts +6 -0
  96. package/dist/esm/api/resources/inboxEvents/types/InboxEventType.mjs +6 -0
  97. package/dist/esm/api/resources/inboxEvents/types/ListInboxEventsResponse.d.mts +8 -0
  98. package/dist/esm/api/resources/inboxEvents/types/ListInboxEventsResponse.mjs +2 -0
  99. package/dist/esm/api/resources/inboxEvents/types/index.d.mts +4 -0
  100. package/dist/esm/api/resources/inboxEvents/types/index.mjs +4 -0
  101. package/dist/esm/api/resources/inboxes/client/Client.d.mts +4 -1
  102. package/dist/esm/api/resources/inboxes/client/Client.mjs +6 -1
  103. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.d.mts +1 -1
  104. package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +1 -1
  105. package/dist/esm/api/resources/inboxes/resources/events/client/Client.d.mts +32 -0
  106. package/dist/esm/api/resources/inboxes/resources/events/client/Client.mjs +99 -0
  107. package/dist/esm/api/resources/inboxes/resources/events/client/index.d.mts +1 -0
  108. package/dist/esm/api/resources/inboxes/resources/events/client/index.mjs +1 -0
  109. package/dist/esm/api/resources/inboxes/resources/events/client/requests/ListInboxEventsRequest.d.mts +10 -0
  110. package/dist/esm/api/resources/inboxes/resources/events/client/requests/ListInboxEventsRequest.mjs +2 -0
  111. package/dist/esm/api/resources/inboxes/resources/events/client/requests/index.d.mts +1 -0
  112. package/dist/esm/api/resources/inboxes/resources/events/client/requests/index.mjs +1 -0
  113. package/dist/esm/api/resources/inboxes/resources/events/exports.d.mts +2 -0
  114. package/dist/esm/api/resources/inboxes/resources/events/exports.mjs +3 -0
  115. package/dist/esm/api/resources/inboxes/resources/events/index.d.mts +1 -0
  116. package/dist/esm/api/resources/inboxes/resources/events/index.mjs +1 -0
  117. package/dist/esm/api/resources/inboxes/resources/index.d.mts +2 -0
  118. package/dist/esm/api/resources/inboxes/resources/index.mjs +2 -0
  119. package/dist/esm/api/resources/inboxes/resources/lists/client/Client.d.mts +1 -1
  120. package/dist/esm/api/resources/inboxes/resources/lists/client/Client.mjs +1 -1
  121. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +1 -1
  122. package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +1 -1
  123. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +1 -1
  124. package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +1 -1
  125. package/dist/esm/api/resources/index.d.mts +2 -0
  126. package/dist/esm/api/resources/index.mjs +2 -0
  127. package/dist/esm/api/resources/lists/client/Client.d.mts +1 -1
  128. package/dist/esm/api/resources/lists/client/Client.mjs +1 -1
  129. package/dist/esm/api/resources/organizations/client/Client.d.mts +6 -1
  130. package/dist/esm/api/resources/organizations/client/Client.mjs +6 -1
  131. package/dist/esm/api/resources/pods/client/Client.d.mts +1 -1
  132. package/dist/esm/api/resources/pods/client/Client.mjs +1 -1
  133. package/dist/esm/api/resources/pods/resources/domains/client/Client.d.mts +1 -1
  134. package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +1 -1
  135. package/dist/esm/api/resources/pods/resources/drafts/client/Client.d.mts +1 -1
  136. package/dist/esm/api/resources/pods/resources/drafts/client/Client.mjs +1 -1
  137. package/dist/esm/api/resources/pods/resources/inboxes/client/Client.d.mts +1 -1
  138. package/dist/esm/api/resources/pods/resources/inboxes/client/Client.mjs +1 -1
  139. package/dist/esm/api/resources/pods/resources/lists/client/Client.d.mts +1 -1
  140. package/dist/esm/api/resources/pods/resources/lists/client/Client.mjs +1 -1
  141. package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +1 -1
  142. package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +1 -1
  143. package/dist/esm/api/resources/threads/client/Client.d.mts +2 -2
  144. package/dist/esm/api/resources/threads/client/Client.mjs +2 -2
  145. package/dist/esm/api/resources/webhooks/client/Client.d.mts +1 -1
  146. package/dist/esm/api/resources/webhooks/client/Client.mjs +1 -1
  147. package/dist/esm/serialization/resources/inboxEvents/index.d.mts +1 -0
  148. package/dist/esm/serialization/resources/inboxEvents/index.mjs +1 -0
  149. package/dist/esm/serialization/resources/inboxEvents/types/InboxEvent.d.mts +21 -0
  150. package/dist/esm/serialization/resources/inboxEvents/types/InboxEvent.mjs +17 -0
  151. package/dist/esm/serialization/resources/inboxEvents/types/InboxEventId.d.mts +7 -0
  152. package/dist/esm/serialization/resources/inboxEvents/types/InboxEventId.mjs +3 -0
  153. package/dist/esm/serialization/resources/inboxEvents/types/InboxEventType.d.mts +7 -0
  154. package/dist/esm/serialization/resources/inboxEvents/types/InboxEventType.mjs +3 -0
  155. package/dist/esm/serialization/resources/inboxEvents/types/ListInboxEventsResponse.d.mts +16 -0
  156. package/dist/esm/serialization/resources/inboxEvents/types/ListInboxEventsResponse.mjs +12 -0
  157. package/dist/esm/serialization/resources/inboxEvents/types/index.d.mts +4 -0
  158. package/dist/esm/serialization/resources/inboxEvents/types/index.mjs +4 -0
  159. package/dist/esm/serialization/resources/index.d.mts +2 -0
  160. package/dist/esm/serialization/resources/index.mjs +2 -0
  161. package/dist/esm/version.d.mts +1 -1
  162. package/dist/esm/version.mjs +1 -1
  163. package/dist/llms-full.txt +912 -362
  164. package/dist/llms.txt +9 -1
  165. package/package.json +12 -1
  166. package/reference.md +100 -18
@@ -3,7 +3,9 @@
3
3
  title: Welcome
4
4
  slug: welcome
5
5
  description: Your starting point for building with the AgentMail API.
6
- ---------------------------------------------------------------------
6
+ ---------------------
7
+
8
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
7
9
 
8
10
  <Tip title="Welcome to AgentMail!" icon="fa-solid fa-star">
9
11
  We're thrilled to have you here! Dive in to learn how to give your AI agents their own email inboxes.
@@ -43,13 +45,14 @@ AgentMail is an API platform for giving AI agents their own inboxes to send, rec
43
45
  </Card>
44
46
  </CardGroup>
45
47
 
46
-
47
48
  ***
48
49
 
49
50
  title: Introduction
50
51
  subtitle: Give AI agents email inboxes
51
52
  slug: introduction
52
- ------------------
53
+ ---------------------
54
+
55
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
53
56
 
54
57
  ## What is AgentMail?
55
58
 
@@ -147,7 +150,13 @@ Our customers use AgentMail for agent identity, authentication, and communicatio
147
150
  ## Get Started
148
151
 
149
152
  <CardGroup>
150
- <Card title="Quickstart" icon="fa-solid fa-book" href="/quickstart" />
153
+ <Card title="Quickstart" icon="fa-solid fa-book" href="/quickstart">
154
+ Create your first inbox and send an email in minutes.
155
+ </Card>
156
+
157
+ <Card title="Receive emails" icon="fa-solid fa-bell" href="/webhooks-overview">
158
+ Set up webhooks or WebSockets to receive incoming messages in real time.
159
+ </Card>
151
160
 
152
161
  <Card title="API Reference" icon="fa-solid fa-code" href="/api-reference" />
153
162
  </CardGroup>
@@ -160,16 +169,15 @@ Our customers use AgentMail for agent identity, authentication, and communicatio
160
169
  <Card title="Email" icon="fa-solid fa-envelope" href="mailto:support@agentmail.cc" />
161
170
  </CardGroup>
162
171
 
163
-
164
172
  ***
165
173
 
166
174
  title: Quickstart
167
175
  subtitle: Create your first inbox with the AgentMail API
168
176
  slug: quickstart
169
- description: >-
170
- Follow this guide to make your first AgentMail API request and create a new
171
- email inbox.
172
- ------------
177
+ description: Follow this guide to make your first AgentMail API request and create a new email inbox.
178
+ ---------------------
179
+
180
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
173
181
 
174
182
  ## Quickest start
175
183
 
@@ -187,13 +195,39 @@ email inbox.
187
195
  ```
188
196
  </CodeBlocks>
189
197
 
190
- Get your API key from the [Console](https://console.agentmail.to) and replace `am_...` in the code below.
198
+ Sign up your agent and get an API key in one call (no console needed):
191
199
 
192
200
  <CodeBlocks>
193
201
  ```python title="Python"
194
202
  from agentmail import AgentMail
195
203
 
204
+ client = AgentMail()
205
+ response = client.agent.sign_up(human_email="you@example.com", username="my-agent")
206
+ # response.api_key -> store this securely
207
+ # response.inbox_id -> my-agent@agentmail.to
208
+ ```
209
+
210
+ ```typescript title="TypeScript"
211
+ import { AgentMailClient } from "agentmail";
212
+
213
+ const client = new AgentMailClient();
214
+ const response = await client.agent.signUp({ humanEmail: "you@example.com", username: "my-agent" });
215
+ // response.apiKey -> store this securely
216
+ // response.inboxId -> my-agent@agentmail.to
217
+ ```
218
+
219
+ ```bash title="CLI"
220
+ agentmail agent sign-up --human-email you@example.com --username my-agent
221
+ ```
222
+ </CodeBlocks>
223
+
224
+ Verify with the OTP sent to your email, then send a message:
225
+
226
+ <CodeBlocks>
227
+ ```python title="Python"
196
228
  client = AgentMail(api_key="am_...")
229
+ client.agent.verify(otp_code="123456")
230
+
197
231
  inbox = client.inboxes.create()
198
232
  client.inboxes.messages.send(inbox.inbox_id, to="user@example.com", subject="Hello", text="Hello from my agent!")
199
233
  ```
@@ -201,14 +235,16 @@ Get your API key from the [Console](https://console.agentmail.to) and replace `a
201
235
  ```typescript title="TypeScript"
202
236
  import { AgentMailClient } from "agentmail";
203
237
 
204
- (async () => {
205
- const client = new AgentMailClient({ apiKey: "am_..." });
206
- const inbox = await client.inboxes.create();
207
- await client.inboxes.messages.send(inbox.inboxId, { to: "user@example.com", subject: "Hello", text: "Hello from my agent!" });
208
- })();
238
+ const client = new AgentMailClient({ apiKey: "am_..." });
239
+ await client.agent.verify({ otpCode: "123456" });
240
+
241
+ const inbox = await client.inboxes.create();
242
+ await client.inboxes.messages.send(inbox.inboxId, { to: "user@example.com", subject: "Hello", text: "Hello from my agent!" });
209
243
  ```
210
244
 
211
245
  ```bash title="CLI"
246
+ agentmail agent verify --otp-code 123456
247
+
212
248
  # create an inbox
213
249
  agentmail inboxes create
214
250
 
@@ -221,6 +257,10 @@ Get your API key from the [Console](https://console.agentmail.to) and replace `a
221
257
  ```
222
258
  </CodeBlocks>
223
259
 
260
+ <Note>
261
+ Already have an account? Get your API key from the [Console](https://console.agentmail.to) and skip straight to sending emails.
262
+ </Note>
263
+
224
264
  ## Copy for Cursor / Claude
225
265
 
226
266
  Copy one of the blocks below into Cursor or Claude for a complete, working AgentMail integration. Each block includes setup, API reference, error handling, rate limiting, and idempotency guidance.
@@ -232,6 +272,10 @@ Copy one of the blocks below into Cursor or Claude for a complete, working Agent
232
272
 
233
273
  Setup: pip install agentmail python-dotenv. Set AGENTMAIL_API_KEY in .env.
234
274
 
275
+ Agent sign-up (no API key needed):
276
+ - agent.sign_up(human_email, username) — returns api_key, inbox_id, organization_id
277
+ - agent.verify(otp_code) — verify with OTP sent to human_email
278
+
235
279
  API reference:
236
280
  - inboxes.create(username?, domain?, display_name?, client_id?) — client_id for idempotent retries
237
281
  - messages.send(inbox_id, to, subject, text, html?, cc?, bcc?, reply_to?, attachments?)
@@ -276,6 +320,10 @@ Copy one of the blocks below into Cursor or Claude for a complete, working Agent
276
320
  *
277
321
  * Setup: npm install agentmail dotenv. Set AGENTMAIL_API_KEY in .env.
278
322
  *
323
+ * Agent sign-up (no API key needed):
324
+ * - agent.signUp({ humanEmail, username }) — returns apiKey, inboxId, organizationId
325
+ * - agent.verify({ otpCode }) — verify with OTP sent to humanEmail
326
+ *
279
327
  * API reference:
280
328
  * - inboxes.create({ username?, domain?, displayName?, clientId? }) — clientId for idempotent retries
281
329
  * - messages.send(inboxId, { to, subject, text, html?, cc?, bcc?, replyTo?, attachments? })
@@ -327,25 +375,84 @@ Copy one of the blocks below into Cursor or Claude for a complete, working Agent
327
375
  for reply content without quoted history.
328
376
  </Tip>
329
377
 
330
- This guide will walk you through installing the AgentMail SDK, authenticating with your API key, and creating your first email inbox.
378
+ This guide walks you through signing up, authenticating, and creating your first email inbox.
331
379
 
332
380
  <Steps>
333
- <Step title="Access the AgentMail Console">
334
- First, you'll need to access the AgentMail Console to manage your account and API keys. Click the link below to get started.
381
+ <Step title="Sign up and get an API key">
382
+ You have two options to get an API key:
383
+
384
+ **Option A: Agent sign-up (programmatic)**
385
+
386
+ Use the Agent API to create an account and get an API key without leaving your terminal. No console access needed.
387
+
388
+ <CodeBlocks>
389
+ ```python title="Python"
390
+ from agentmail import AgentMail
391
+
392
+ client = AgentMail()
393
+ response = client.agent.sign_up(
394
+ human_email="you@example.com",
395
+ username="my-agent"
396
+ )
397
+ print(response.api_key) # store this securely
398
+ print(response.inbox_id) # my-agent@agentmail.to
399
+ ```
400
+
401
+ ```typescript title="TypeScript"
402
+ import { AgentMailClient } from "agentmail";
403
+
404
+ const client = new AgentMailClient();
405
+ const response = await client.agent.signUp({
406
+ humanEmail: "you@example.com",
407
+ username: "my-agent",
408
+ });
409
+ console.log(response.apiKey); // store this securely
410
+ console.log(response.inboxId); // my-agent@agentmail.to
411
+ ```
412
+
413
+ ```bash title="CLI"
414
+ agentmail agent sign-up \
415
+ --human-email you@example.com \
416
+ --username my-agent
417
+ ```
418
+ </CodeBlocks>
335
419
 
336
- <Card title="Open AgentMail Console" icon="fa-solid fa-desktop" href="https://console.agentmail.to" target="_blank" />
420
+ A 6-digit OTP is sent to the provided email. Verify to unlock full permissions:
337
421
 
338
- If you don't have an account yet, you can sign up directly from the console. Once you're logged in, you'll be able to manage your inboxes, view analytics, and create API keys.
422
+ <CodeBlocks>
423
+ ```python title="Python"
424
+ client = AgentMail(api_key=response.api_key)
425
+ client.agent.verify(otp_code="123456")
426
+ ```
427
+
428
+ ```typescript title="TypeScript"
429
+ const authedClient = new AgentMailClient({ apiKey: response.apiKey });
430
+ await authedClient.agent.verify({ otpCode: "123456" });
431
+ ```
432
+
433
+ ```bash title="CLI"
434
+ agentmail agent verify --otp-code 123456
435
+ ```
436
+ </CodeBlocks>
437
+
438
+ <Info>
439
+ The sign-up endpoint is idempotent. Calling it again with the same email rotates the API key and resends the OTP if expired.
440
+ </Info>
441
+
442
+ **Option B: Console (manual)**
443
+
444
+ Go to the [AgentMail Console](https://console.agentmail.to), create an account, and generate an API key from the dashboard.
445
+ ![API Key Creation Screenshot](https://files.buildwithfern.com/https://agentmail-production.docs.buildwithfern.com/4e665f546efdf08d30178fcfbd996298ed7b3d1d44709fc742ed5315fed9532e/assets/api-key-creation.png)
339
446
  </Step>
340
447
 
341
- <Step title="Create an API Key">
342
- Now that you're in the console, you'll need to create an API key to
343
- authenticate your requests. Navigate to the API Keys section in your console
344
- dashboard. ![API Key Creation Screenshot](https://files.buildwithfern.com/https://agentmail-production.docs.buildwithfern.com/4e665f546efdf08d30178fcfbd996298ed7b3d1d44709fc742ed5315fed9532e/assets/api-key-creation.png) Click
345
- "Create New API Key" and give it a descriptive name. Once created, copy the
346
- API key and store it securely. Create a `.env` file in your project's root
347
- directory and add your key to it. We recommend using environment variables to
348
- keep your keys secure.
448
+ <Step title="Store your API key">
449
+ Create a `.env` file in your project root and add your key:
450
+
451
+ ```bash
452
+ AGENTMAIL_API_KEY=am_...
453
+ ```
454
+
455
+ We recommend using environment variables to keep your keys secure.
349
456
  </Step>
350
457
 
351
458
  <Step title="Install the SDK">
@@ -475,23 +582,40 @@ This guide will walk you through installing the AgentMail SDK, authenticating wi
475
582
 
476
583
  ## Next Steps
477
584
 
478
- Congrats, you sent your first email via AgentMail. But this isn't our strength. Explore the full power of creating agents that can autonomously reply, take action, parse attachments, semantically search your inbox, by exploring our docs and tutorials below.
585
+ You've created an inbox and sent your first email. Now set up your agent to receive and respond to incoming messages:
586
+
587
+ <CardGroup>
588
+ <Card title="Receive emails with WebSockets" icon="fa-solid fa-plug" href="/websockets">
589
+ The fastest way to receive emails. No public URL or ngrok needed.
590
+ </Card>
591
+
592
+ <Card title="Receive emails with webhooks" icon="fa-solid fa-bell" href="/webhooks-overview">
593
+ Get real-time HTTP notifications when emails arrive.
594
+ </Card>
595
+
596
+ <Card title="Sending & receiving guide" icon="fa-solid fa-right-left" href="/sending-receiving-email">
597
+ Build a complete conversational agent workflow.
598
+ </Card>
599
+
600
+ <Card title="API Reference" icon="fa-solid fa-code" href="/api-reference">
601
+ Explore the full API with interactive examples.
602
+ </Card>
603
+ </CardGroup>
479
604
 
480
605
  <Note>
481
606
  Looking for a different language? Email us at
482
607
  [support@agentmail.cc](mailto:support@agentmail.cc) and we'll get you set up.
483
608
  </Note>
484
609
 
485
-
486
610
  ***
487
611
 
488
612
  title: Inboxes
489
613
  subtitle: The foundation of your agent's identity and communication.
490
614
  slug: inboxes
491
- description: >-
492
- Learn how AgentMail Inboxes act as scalable, API-first email accounts for your
493
- agents.
494
- -------
615
+ description: Learn how AgentMail Inboxes act as scalable, API-first email accounts for your agents.
616
+ ---------------------
617
+
618
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
495
619
 
496
620
  ## What is an Inbox?
497
621
 
@@ -612,8 +736,8 @@ Here at AgentMail we've now made an `Inbox` an API resource, meaning you can per
612
736
  --domain domain.com \
613
737
  --display-name "Docs Tester"
614
738
 
615
- # retrieve an inbox
616
- agentmail inboxes retrieve --inbox-id my_name@domain.com
739
+ # get an inbox
740
+ agentmail inboxes get --inbox-id my_name@domain.com
617
741
 
618
742
  # list all inboxes
619
743
  agentmail inboxes list
@@ -727,16 +851,15 @@ Copy one of the blocks below into Cursor or Claude for complete Inboxes API know
727
851
  ```
728
852
  </CodeBlocks>
729
853
 
730
-
731
854
  ***
732
855
 
733
856
  title: Messages
734
857
  subtitle: The fundamental unit of communication for your agents.
735
858
  slug: messages
736
- description: >-
737
- Learn how to send, receive, and manage emails as Message objects with the
738
- AgentMail API.
739
- --------------
859
+ description: Learn how to send, receive, and manage emails as Message objects with the AgentMail API.
860
+ ---------------------
861
+
862
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
740
863
 
741
864
  ## What is a Message?
742
865
 
@@ -938,8 +1061,8 @@ You can retrieve the details of any specific `Message` by providing its ID along
938
1061
  ```
939
1062
 
940
1063
  ```bash title="CLI"
941
- # retrieve a specific message
942
- agentmail inboxes:messages retrieve \
1064
+ # get a specific message
1065
+ agentmail inboxes:messages get \
943
1066
  --inbox-id my_inbox@agentmail.to \
944
1067
  --message-id "<abc123@agentmail.to>"
945
1068
  ```
@@ -1199,10 +1322,14 @@ When processing incoming messages, always treat `html` as the primary content so
1199
1322
 
1200
1323
  ## Receiving `Messages`
1201
1324
 
1325
+ <Warning>
1326
+ **Inbound emails require the sender's domain to have SPF or DKIM configured.** To reduce spoofing and phishing, AgentMail drops inbound emails when the sender's domain has neither SPF nor DKIM set up. If a sender reports that their email never arrived, this is the most likely cause. Once they configure SPF/DKIM on their domain, their emails will start landing in your inbox again. See [Why are my emails not showing up?](/knowledge-base/inbound-emails-missing) for details.
1327
+ </Warning>
1328
+
1202
1329
  While you can periodically list `Messages` to check for new emails, the most efficient way to handle incoming `Messages` for your agents is with `Webhooks`. By configuring a `Webhook` endpoint, AgentMail can notify your application/agent in real-time as soon as a new `Message` arrives, so you can take action on them.
1203
1330
 
1204
1331
  <CardGroup>
1205
- <Card title="Guide: Webhooks" icon="fa-solid fa-bolt" href="/overview">
1332
+ <Card title="Guide: Webhooks" icon="fa-solid fa-bolt" href="/webhooks-overview">
1206
1333
  Learn how to set up webhooks for real-time message processing.
1207
1334
  </Card>
1208
1335
  </CardGroup>
@@ -1268,16 +1395,15 @@ AgentMail doesn't have a dedicated "mark as read" endpoint — instead, you use
1268
1395
  ```
1269
1396
  ```
1270
1397
 
1271
-
1272
1398
  ***
1273
1399
 
1274
1400
  title: Threads
1275
1401
  subtitle: Organizing conversations across your Inboxes.
1276
1402
  slug: threads
1277
- description: >-
1278
- Learn how AgentMail Threads group messages into conversations and how to query
1279
- them across your entire organization.
1280
- -------------------------------------
1403
+ description: Learn how AgentMail Threads group messages into conversations and how to query them across your entire organization.
1404
+ ---------------------
1405
+
1406
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
1281
1407
 
1282
1408
  ## What is a Thread?
1283
1409
 
@@ -1298,7 +1424,7 @@ This is the standard way to retrieve all the conversations associated with a sin
1298
1424
  # You'll need an inbox ID to list threads from.
1299
1425
  inbox_id = "inbound-agent@agentmail.to"
1300
1426
 
1301
- # This retrieves all threads within the specified Inbox
1427
+ # This loads all threads within the specified Inbox
1302
1428
 
1303
1429
  inbox_threads = client.inboxes.threads.list(inbox_id=inbox_id)
1304
1430
 
@@ -1308,7 +1434,7 @@ This is the standard way to retrieve all the conversations associated with a sin
1308
1434
  // You'll need an inbox ID to list threads from.
1309
1435
  const inboxId = "inbound-agent@agentmail.to";
1310
1436
 
1311
- // This retrieves all threads within the specified Inbox
1437
+ // This loads all threads within the specified Inbox
1312
1438
  const inboxThreads = await client.inboxes.threads.list("inbound-agent@agentmail.to");
1313
1439
 
1314
1440
  console.log(`Found ${inboxThreads.count} threads in Inbox ${inboxId}.`);
@@ -1365,7 +1491,7 @@ You can also retrieve a single `Thread` by its ID. This will return the `Thread`
1365
1491
  ```python
1366
1492
  thread_id = "thread_456def"
1367
1493
 
1368
- # This retrieves a single thread and its messages
1494
+ # This loads a single thread and its messages
1369
1495
 
1370
1496
  thread = client.threads.get(
1371
1497
  thread_id="thread_id"
@@ -1378,7 +1504,7 @@ You can also retrieve a single `Thread` by its ID. This will return the `Thread`
1378
1504
  ```typescript title="TypeScript"
1379
1505
  const threadId = "thread_456def";
1380
1506
 
1381
- // This retrieves a single thread and its messages
1507
+ // This loads a single thread and its messages
1382
1508
  const thread = await client.threads.get(
1383
1509
  "thread_id"
1384
1510
  )
@@ -1387,8 +1513,8 @@ You can also retrieve a single `Thread` by its ID. This will return the `Thread`
1387
1513
  ```
1388
1514
 
1389
1515
  ```bash title="CLI"
1390
- # retrieve a single thread by id
1391
- agentmail threads retrieve \
1516
+ # get a single thread by id
1517
+ agentmail threads get \
1392
1518
  --thread-id thread_456def
1393
1519
  ```
1394
1520
  </CodeBlocks>
@@ -1476,16 +1602,15 @@ Copy one of the blocks below into Cursor or Claude for complete Threads API know
1476
1602
  ```
1477
1603
  </CodeBlocks>
1478
1604
 
1479
-
1480
1605
  ***
1481
1606
 
1482
1607
  title: Drafts
1483
1608
  subtitle: Preparing and scheduling Messages for your agents.
1484
1609
  slug: drafts
1485
- description: >-
1486
- Learn how to create, manage, and send Drafts to enable advanced agent
1487
- workflows like human-in-the-loop review and scheduled sending.
1488
- --------------------------------------------------------------
1610
+ description: Learn how to create, manage, and send Drafts to enable advanced agent workflows like human-in-the-loop review and scheduled sending.
1611
+ ---------------------
1612
+
1613
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
1489
1614
 
1490
1615
  ## What is a Draft?
1491
1616
 
@@ -1568,8 +1693,8 @@ Once a `Draft` is created, you can retrieve it by its ID
1568
1693
  ```
1569
1694
 
1570
1695
  ```bash title="CLI"
1571
- # retrieve a draft by id
1572
- agentmail inboxes:drafts retrieve \
1696
+ # get a draft by id
1697
+ agentmail inboxes:drafts get \
1573
1698
  --inbox-id my_inbox@domain.com \
1574
1699
  --draft-id draft_id_123
1575
1700
  ```
@@ -2033,16 +2158,15 @@ Copy one of the blocks below into Cursor or Claude for complete Drafts API knowl
2033
2158
  ```
2034
2159
  </CodeBlocks>
2035
2160
 
2036
-
2037
2161
  ***
2038
2162
 
2039
2163
  title: Labels
2040
2164
  subtitle: Organizing and categorizing your agent's conversations at scale.
2041
2165
  slug: labels
2042
- description: >-
2043
- Learn how to use Labels to manage state, track campaigns, and filter messages
2044
- for powerful agentic workflows.
2045
- -------------------------------
2166
+ description: Learn how to use Labels to manage state, track campaigns, and filter messages for powerful agentic workflows.
2167
+ ---------------------
2168
+
2169
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
2046
2170
 
2047
2171
  ## What are `Labels`?
2048
2172
 
@@ -2292,16 +2416,15 @@ Copy one of the blocks below into Cursor or Claude for complete Labels usage in
2292
2416
  based on their content.
2293
2417
  </Callout>
2294
2418
 
2295
-
2296
2419
  ***
2297
2420
 
2298
2421
  title: Lists
2299
2422
  subtitle: Filter emails by allowing or blocking specific addresses and domains.
2300
2423
  slug: lists
2301
- description: >-
2302
- Learn how to use Lists to control which email addresses and domains your
2303
- agents can send to or receive from.
2304
- -----------------------------------
2424
+ description: Learn how to use Lists to control which email addresses and domains your agents can send to or receive from.
2425
+ ---------------------
2426
+
2427
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
2305
2428
 
2306
2429
  ## What are Lists?
2307
2430
 
@@ -2415,8 +2538,8 @@ Retrieve a specific entry from a list by its email address or domain.
2415
2538
  ```
2416
2539
 
2417
2540
  ```bash title="CLI"
2418
- # retrieve a specific entry
2419
- agentmail lists retrieve \
2541
+ # get a specific entry
2542
+ agentmail lists get \
2420
2543
  --direction receive \
2421
2544
  --type allow \
2422
2545
  --entry partner@example.com
@@ -2601,16 +2724,15 @@ Copy one of the blocks below into Cursor or Claude for complete Lists API knowle
2601
2724
  ```
2602
2725
  </CodeBlocks>
2603
2726
 
2604
-
2605
2727
  ***
2606
2728
 
2607
2729
  title: Attachments
2608
2730
  subtitle: Sending and receiving files with your agents.
2609
2731
  slug: attachments
2610
- description: >-
2611
- Learn how to send files as attachments, and download incoming attachments from
2612
- both messages and threads.
2613
- --------------------------
2732
+ description: Learn how to send files as attachments, and download incoming attachments from both messages and threads.
2733
+ ---------------------
2734
+
2735
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
2614
2736
 
2615
2737
  ## What are `Attachments`?
2616
2738
 
@@ -2835,12 +2957,13 @@ Copy one of the blocks below into Cursor or Claude for complete Attachments usag
2835
2957
  ```
2836
2958
  </CodeBlocks>
2837
2959
 
2838
-
2839
2960
  ***
2840
2961
 
2841
2962
  title: Pods
2842
2963
  description: Learn how to use pods for multi-tenant email management
2843
- --------------------------------------------------------------------
2964
+ ---------------------
2965
+
2966
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
2844
2967
 
2845
2968
  ## What are Pods?
2846
2969
 
@@ -3131,16 +3254,15 @@ Pod: "Marketing-Agent"
3131
3254
  * Learn about [Inboxes](/inboxes) and how to create email accounts within pods
3132
3255
  * Explore [Domains](/custom-domains) to set up custom email domains for your pods
3133
3256
 
3134
-
3135
3257
  ***
3136
3258
 
3137
3259
  title: Permissions
3138
3260
  subtitle: Control what your API keys can access with granular permissions.
3139
3261
  slug: permissions
3140
- description: >-
3141
- Learn how to configure fine-grained permissions on API keys to restrict access
3142
- to specific resources and operations.
3143
- -------------------------------------
3262
+ description: Learn how to configure fine-grained permissions on API keys to restrict access to specific resources and operations.
3263
+ ---------------------
3264
+
3265
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
3144
3266
 
3145
3267
  ## What are Permissions?
3146
3268
 
@@ -3572,24 +3694,71 @@ Copy one of the blocks below into Cursor or Claude for complete Permissions API
3572
3694
  * **Combine with scopes for defense in depth.** Pair permissions with [pod-scoped](/multi-tenancy#pod-scoped-keys) or [inbox-scoped](/multi-tenancy#inbox-scoped-keys) keys. Scopes limit *which* resources a key can see, while permissions limit *what* it can do.
3573
3695
  * **Filter unwanted content from agents.** Set `label_spam_read`, `label_blocked_read`, and `label_trash_read` to `false` on agent-facing keys. This prevents agents from seeing or processing unwanted email, keeping their context clean.
3574
3696
 
3575
-
3576
3697
  ***
3577
3698
 
3578
3699
  title: Agent Onboarding
3579
3700
  subtitle: Everything you need to onboard your AI agent to AgentMail
3580
3701
  slug: agent-onboarding
3581
- description: >-
3582
- Resources for AI coding assistants, MCP servers, skills, and agent-friendly
3583
- documentation.
3584
- --------------
3702
+ description: Resources for AI coding assistants, MCP servers, skills, and agent-friendly documentation.
3703
+ ---------------------
3704
+
3705
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
3585
3706
 
3586
3707
  > Everything you need to onboard your AI agent to AgentMail — the email platform built for AI agents.
3587
3708
 
3588
3709
  If you're developing with AI, AgentMail offers several resources to improve your experience.
3589
3710
 
3590
- ## Prerequisite: Create an API Key
3711
+ ## Get an API key
3712
+
3713
+ Your agent can sign up programmatically using the Agent API. No console access needed.
3714
+
3715
+ <CodeBlocks>
3716
+ ```python title="Python"
3717
+ from agentmail import AgentMail
3718
+
3719
+ client = AgentMail()
3720
+ response = client.agent.sign_up(human_email="you@example.com", username="my-agent")
3721
+ # response.api_key -> store this securely
3722
+ # response.inbox_id -> my-agent@agentmail.to
3723
+ ```
3591
3724
 
3592
- You'll need a human to create an AgentMail account at [console.agentmail.to](https://console.agentmail.to). Once you have an account, create an API key from the dashboard. With an API key, your agent can create inboxes, send and receive emails, manage threads, and more.
3725
+ ```typescript title="TypeScript"
3726
+ import { AgentMailClient } from "agentmail";
3727
+
3728
+ const client = new AgentMailClient();
3729
+ const response = await client.agent.signUp({ humanEmail: "you@example.com", username: "my-agent" });
3730
+ // response.apiKey -> store this securely
3731
+ // response.inboxId -> my-agent@agentmail.to
3732
+ ```
3733
+
3734
+ ```bash title="CLI"
3735
+ agentmail agent sign-up --human-email you@example.com --username my-agent
3736
+ ```
3737
+ </CodeBlocks>
3738
+
3739
+ A 6-digit OTP is sent to the provided email. Verify to unlock full permissions:
3740
+
3741
+ <CodeBlocks>
3742
+ ```python title="Python"
3743
+ client = AgentMail(api_key=response.api_key)
3744
+ client.agent.verify(otp_code="123456")
3745
+ ```
3746
+
3747
+ ```typescript title="TypeScript"
3748
+ const authedClient = new AgentMailClient({ apiKey: response.apiKey });
3749
+ await authedClient.agent.verify({ otpCode: "123456" });
3750
+ ```
3751
+
3752
+ ```bash title="CLI"
3753
+ agentmail agent verify --otp-code 123456
3754
+ ```
3755
+ </CodeBlocks>
3756
+
3757
+ <Info>
3758
+ The sign-up endpoint is idempotent. Calling it again with the same email rotates the API key and resends the OTP if expired.
3759
+ </Info>
3760
+
3761
+ Alternatively, a human can create an account at [console.agentmail.to](https://console.agentmail.to) and generate an API key from the dashboard.
3593
3762
 
3594
3763
  <Info>
3595
3764
  AgentMail's free tier includes 3 inboxes and 3,000 emails/month. Your agent can start building immediately.
@@ -3717,19 +3886,26 @@ export AGENTMAIL_API_KEY="your-api-key-here"
3717
3886
  View the skill source and full documentation.
3718
3887
  </Card>
3719
3888
 
3720
- ## Quick Start for Agents
3889
+ ## Quick start for agents
3721
3890
 
3722
- Create an inbox and send your first email in a few lines:
3891
+ Sign up, create an inbox, and send your first email:
3723
3892
 
3724
3893
  <CodeBlocks>
3725
3894
  ```python title="Python"
3726
3895
  from agentmail import AgentMail
3727
3896
 
3728
- client = AgentMail(api_key="am_...")
3897
+ # sign up (no API key needed)
3898
+ client = AgentMail()
3899
+ response = client.agent.sign_up(human_email="you@example.com", username="my-agent")
3900
+
3901
+ # after verifying with the OTP sent to your email:
3902
+ client = AgentMail(api_key=response.api_key)
3903
+ client.agent.verify(otp_code="123456")
3904
+
3905
+ # create an inbox and send an email
3729
3906
  inbox = client.inboxes.create(display_name="My AI Agent")
3730
3907
  print(f"Agent email: {inbox.inbox_id}")
3731
3908
 
3732
- # Send an email
3733
3909
  client.inboxes.messages.send(
3734
3910
  inbox.inbox_id,
3735
3911
  to="user@example.com",
@@ -3741,12 +3917,19 @@ Create an inbox and send your first email in a few lines:
3741
3917
  ```typescript title="TypeScript"
3742
3918
  import { AgentMailClient } from "agentmail";
3743
3919
 
3744
- const client = new AgentMailClient({ apiKey: "am_..." });
3745
- const inbox = await client.inboxes.create({ displayName: "My AI Agent" });
3920
+ // sign up (no API key needed)
3921
+ const client = new AgentMailClient();
3922
+ const response = await client.agent.signUp({ humanEmail: "you@example.com", username: "my-agent" });
3923
+
3924
+ // after verifying with the OTP sent to your email:
3925
+ const authedClient = new AgentMailClient({ apiKey: response.apiKey });
3926
+ await authedClient.agent.verify({ otpCode: "123456" });
3927
+
3928
+ // create an inbox and send an email
3929
+ const inbox = await authedClient.inboxes.create({ displayName: "My AI Agent" });
3746
3930
  console.log(`Agent email: ${inbox.inboxId}`);
3747
3931
 
3748
- // Send an email
3749
- await client.inboxes.messages.send(inbox.inboxId, {
3932
+ await authedClient.inboxes.messages.send(inbox.inboxId, {
3750
3933
  to: "user@example.com",
3751
3934
  subject: "Hello from my AI agent",
3752
3935
  text: "Hi! I'm an AI agent with my own email address."
@@ -3754,6 +3937,10 @@ Create an inbox and send your first email in a few lines:
3754
3937
  ```
3755
3938
 
3756
3939
  ```bash title="CLI"
3940
+ # sign up and verify
3941
+ agentmail agent sign-up --human-email you@example.com --username my-agent
3942
+ agentmail agent verify --otp-code 123456
3943
+
3757
3944
  # create an inbox
3758
3945
  agentmail inboxes create --display-name "My AI Agent"
3759
3946
 
@@ -3766,6 +3953,10 @@ Create an inbox and send your first email in a few lines:
3766
3953
  ```
3767
3954
  </CodeBlocks>
3768
3955
 
3956
+ <Note>
3957
+ Already have an API key? Skip the sign-up step and initialize the client directly with your key.
3958
+ </Note>
3959
+
3769
3960
  ### Receive and reply to emails
3770
3961
 
3771
3962
  <CodeBlocks>
@@ -3791,17 +3982,17 @@ Create an inbox and send your first email in a few lines:
3791
3982
 
3792
3983
  ```typescript title="TypeScript"
3793
3984
  // List threads in the inbox
3794
- const threads = await client.inboxes.threads.list(inbox.inboxId);
3985
+ const threads = await authedClient.inboxes.threads.list(inbox.inboxId);
3795
3986
 
3796
3987
  // Get the latest thread
3797
- const thread = await client.inboxes.threads.get(
3988
+ const thread = await authedClient.inboxes.threads.get(
3798
3989
  inbox.inboxId,
3799
3990
  threads.threads[0].threadId
3800
3991
  );
3801
3992
 
3802
3993
  // Reply to the latest message
3803
3994
  const latestMessage = thread.messages[thread.messages.length - 1];
3804
- await client.inboxes.messages.reply(
3995
+ await authedClient.inboxes.messages.reply(
3805
3996
  inbox.inboxId,
3806
3997
  latestMessage.messageId,
3807
3998
  { to: [latestMessage.from], text: "Thanks for your email! I'll look into this." }
@@ -3866,16 +4057,15 @@ Unlike traditional email APIs that are built for one-way transactional email, Ag
3866
4057
  </Card>
3867
4058
  </CardGroup>
3868
4059
 
3869
-
3870
4060
  ***
3871
4061
 
3872
4062
  title: Skills
3873
4063
  subtitle: Add AgentMail to AI coding assistants with the official skill
3874
4064
  slug: integrations/skills
3875
- description: >-
3876
- AgentMail's official skill for OpenClaw, Claude Code, Cursor, and other AI
3877
- assistants
3878
- ----------
4065
+ description: AgentMail's official skill for OpenClaw, Claude Code, Cursor, and other AI assistants
4066
+ ---------------------
4067
+
4068
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
3879
4069
 
3880
4070
  ## Getting started
3881
4071
 
@@ -3999,14 +4189,15 @@ Once installed, you can ask your AI assistant to perform email tasks:
3999
4189
  * [AgentMail API Reference](/api-reference)
4000
4190
  * [AgentMail Console](https://console.agentmail.to)
4001
4191
 
4002
-
4003
4192
  ***
4004
4193
 
4005
4194
  title: MCP
4006
4195
  subtitle: Connect AgentMail to any MCP-compatible AI client
4007
4196
  slug: integrations/mcp
4008
4197
  description: AgentMail's Model Context Protocol (MCP) integration
4009
- -----------------------------------------------------------------
4198
+ ---------------------
4199
+
4200
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
4010
4201
 
4011
4202
  ## Getting started
4012
4203
 
@@ -4042,14 +4233,15 @@ The AgentMail MCP server works with any MCP-compatible client, including:
4042
4233
 
4043
4234
  For detailed setup instructions and available tools, visit [mcp.agentmail.to](https://mcp.agentmail.to).
4044
4235
 
4045
-
4046
4236
  ***
4047
4237
 
4048
4238
  title: CLI
4049
4239
  subtitle: Manage AgentMail resources from the command line
4050
4240
  slug: integrations/cli
4051
4241
  description: AgentMail's official command-line interface
4052
- --------------------------------------------------------
4242
+ ---------------------
4243
+
4244
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
4053
4245
 
4054
4246
  ## Getting started
4055
4247
 
@@ -4119,7 +4311,7 @@ agentmail webhooks create \
4119
4311
  The CLI provides commands for:
4120
4312
 
4121
4313
  * **Inbox management:** Create, list, update, and delete inboxes
4122
- * **Message operations:** Send, reply, forward, and retrieve emails
4314
+ * **Message operations:** Send, reply, forward, and read emails
4123
4315
  * **Thread management:** List and manage email threads
4124
4316
  * **Drafts:** Create, update, send, and delete drafts
4125
4317
  * **Webhooks:** Create and manage webhook endpoints
@@ -4159,14 +4351,15 @@ openclaw skills install agentmail-to/agentmail-skills/agentmail-cli
4159
4351
 
4160
4352
  This works with any compatible tool, including OpenClaw, Claude Code, Cursor, and Codex. See the [Skills](/integrations/skills) page for more details.
4161
4353
 
4162
-
4163
4354
  ***
4164
4355
 
4165
4356
  title: Google ADK
4166
4357
  subtitle: Give your Google ADK agent its own email inbox
4167
4358
  slug: integrations/google-adk
4168
4359
  description: AgentMail's Google Agent Development Kit (ADK) integration
4169
- -----------------------------------------------------------------------
4360
+ ---------------------
4361
+
4362
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
4170
4363
 
4171
4364
  ## Getting started
4172
4365
 
@@ -4277,14 +4470,15 @@ Once connected, your ADK agent has access to the following AgentMail tools:
4277
4470
  | `forward_message` | Forward a message to another recipient |
4278
4471
  | `update_message` | Update message properties such as read status |
4279
4472
 
4280
-
4281
4473
  ***
4282
4474
 
4283
4475
  title: OpenClaw
4284
4476
  subtitle: Give your OpenClaw agent its own email inbox
4285
4477
  slug: integrations/openclaw
4286
4478
  description: AgentMail's OpenClaw integration
4287
- ---------------------------------------------
4479
+ ---------------------
4480
+
4481
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
4288
4482
 
4289
4483
  ## Getting started
4290
4484
 
@@ -4505,14 +4699,15 @@ Now OpenClaw will be notified whenever a new email arrives, allowing it to proac
4505
4699
  * [OpenClaw Documentation](https://docs.openclaw.ai)
4506
4700
  * [OpenClaw Skills Guide](https://docs.openclaw.ai/tools/skills)
4507
4701
 
4508
-
4509
4702
  ***
4510
4703
 
4511
4704
  title: Replit
4512
4705
  subtitle: Integrate AgentMail with your Replit apps and agents
4513
4706
  slug: integrations/replit
4514
4707
  description: AgentMail's Replit integration
4515
- -------------------------------------------
4708
+ ---------------------
4709
+
4710
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
4516
4711
 
4517
4712
  ## Getting started
4518
4713
 
@@ -4721,14 +4916,15 @@ Email is critical to identity and communication on the internet. Much of the con
4721
4916
 
4722
4917
  These are just a few select verticals, but we have seen AgentMail be effective in automating any email task across every function. If a human does it with email, it can be automated with AgentMail.
4723
4918
 
4724
-
4725
4919
  ***
4726
4920
 
4727
4921
  title: x402
4728
4922
  subtitle: Pay-per-use AgentMail with the x402 payment protocol
4729
4923
  slug: integrations/x402
4730
4924
  description: AgentMail's x402 integration for HTTP-native payments
4731
- ------------------------------------------------------------------
4925
+ ---------------------
4926
+
4927
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
4732
4928
 
4733
4929
  ## Getting started
4734
4930
 
@@ -4883,14 +5079,15 @@ This means your agent can use the full AgentMail API (inboxes, messages, threads
4883
5079
  * [AgentMail API reference](/api-reference)
4884
5080
  * [WebSockets overview](/websockets)
4885
5081
 
4886
-
4887
5082
  ***
4888
5083
 
4889
5084
  title: MPP
4890
5085
  subtitle: Pay-per-use AgentMail with Stripe's Machine Payments Protocol
4891
5086
  slug: integrations/mpp
4892
5087
  description: AgentMail's MPP integration for machine-to-machine payments via Stripe
4893
- -----------------------------------------------------------------------------------
5088
+ ---------------------
5089
+
5090
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
4894
5091
 
4895
5092
  ## Getting started
4896
5093
 
@@ -4978,14 +5175,15 @@ This means your agent can use the full AgentMail API (inboxes, messages, threads
4978
5175
  * [AgentMail API reference](/api-reference)
4979
5176
  * [WebSockets overview](/websockets)
4980
5177
 
4981
-
4982
5178
  ***
4983
5179
 
4984
5180
  title: Integrate LiveKit Agents
4985
5181
  subtitle: Build a voice assistant with real time email capabilities.
4986
5182
  slug: integrate-livekit-agents
4987
5183
  description: A step-by-step guide to integrate with the LiveKit Agents SDK.
4988
- ---------------------------------------------------------------------------
5184
+ ---------------------
5185
+
5186
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
4989
5187
 
4990
5188
  ## Overview
4991
5189
 
@@ -5112,14 +5310,15 @@ Run your agent inside the terminal and send it an email
5112
5310
  python agent.py console
5113
5311
  ```
5114
5312
 
5115
-
5116
5313
  ***
5117
5314
 
5118
5315
  title: Sim.ai
5119
5316
  subtitle: Connect AgentMail to your Sim.ai workflows
5120
5317
  slug: integrations/sim
5121
5318
  description: AgentMail's Sim.ai integration
5122
- -------------------------------------------
5319
+ ---------------------
5320
+
5321
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
5123
5322
 
5124
5323
  ## Getting started
5125
5324
 
@@ -5188,16 +5387,15 @@ Once connected, Sim provides access to the following AgentMail operations:
5188
5387
  * [AgentMail API reference](/api-reference)
5189
5388
  * [Webhooks overview](/webhooks/webhooks-overview)
5190
5389
 
5191
-
5192
5390
  ***
5193
5391
 
5194
- title: 'Guide: Sending & Receiving Email'
5392
+ title: Guide: Sending & Receiving Email
5195
5393
  subtitle: Building your first conversational agent workflow.
5196
5394
  slug: sending-receiving-email
5197
- description: >-
5198
- A step-by-step guide to the practical workflow of sending initial emails and
5199
- handling replies to have a full conversation.
5200
- ---------------------------------------------
5395
+ description: A step-by-step guide to the practical workflow of sending initial emails and handling replies to have a full conversation.
5396
+ ---------------------
5397
+
5398
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
5201
5399
 
5202
5400
  This guide walks you through the complete, practical workflow of an agent having a conversation. While the `Core Concepts` pages detail the individual API calls, this guide shows you how to stitch them together to create a functional conversational loop.
5203
5401
 
@@ -5344,7 +5542,7 @@ Here's the step-by-step logic for a polling-based conversational agent.
5344
5542
  <Callout intent="success" title="Real-Time Processing with Webhooks">
5345
5543
  For production applications, polling is inefficient. The best way to handle incoming replies is to use `Webhooks`. This allows AgentMail to notify your agent instantly when a new `Message` arrives, so you can reply in real-time.
5346
5544
 
5347
- [**Learn how to set up `Webhooks` →**](/overview)
5545
+ [**Learn how to set up `Webhooks` →**](/webhooks-overview)
5348
5546
  </Callout>
5349
5547
 
5350
5548
  ## Scheduling Emails
@@ -5393,16 +5591,15 @@ Create a `Draft` with the `send_at` field and AgentMail handles the rest. The em
5393
5591
  For more details on scheduled sending—including how to cancel, reschedule, list scheduled drafts, and build conditional follow-up workflows—see the [**Drafts**](/drafts) page.
5394
5592
  </Callout>
5395
5593
 
5396
-
5397
5594
  ***
5398
5595
 
5399
5596
  title: IMAP & SMTP
5400
5597
  subtitle: Connect to AgentMail with standard email protocols
5401
5598
  slug: imap-smtp
5402
- description: >-
5403
- Configure IMAP and SMTP to access your AgentMail inboxes using email clients
5404
- or programmatic access.
5405
- -----------------------
5599
+ description: Configure IMAP and SMTP to access your AgentMail inboxes using email clients or programmatic access.
5600
+ ---------------------
5601
+
5602
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
5406
5603
 
5407
5604
  <Callout intent="warn" title="IMAP is Under Development">
5408
5605
  IMAP support is currently under development and will be available in the coming weeks. The documentation below describes the planned functionality. SMTP is fully available today.
@@ -5641,16 +5838,15 @@ sendEmail().catch(console.error);
5641
5838
  | Access to all folders | API |
5642
5839
  | Bulk operations | API |
5643
5840
 
5644
-
5645
5841
  ***
5646
5842
 
5647
- title: 'Guide: Multi-Tenancy'
5648
- subtitle: 'Pods, scoped keys, and event routing for your customers.'
5843
+ title: Guide: Multi-Tenancy
5844
+ subtitle: Pods, scoped keys, and event routing for your customers.
5649
5845
  slug: multi-tenancy
5650
- description: >-
5651
- How to use pods, scoped API keys, and webhook filtering to build multi-tenant
5652
- email on AgentMail.
5653
- -------------------
5846
+ description: How to use pods, scoped API keys, and webhook filtering to build multi-tenant email on AgentMail.
5847
+ ---------------------
5848
+
5849
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
5654
5850
 
5655
5851
  If you're building a platform where each of your customers needs their own email infrastructure, this is how you set it up. The basic idea: create a `Pod` per customer, give them a scoped API key, and route webhook events to the right place.
5656
5852
 
@@ -5936,18 +6132,15 @@ Here's what onboarding a new tenant looks like end to end:
5936
6132
  ```
5937
6133
  </CodeBlocks>
5938
6134
 
5939
-
5940
6135
  ***
5941
6136
 
5942
6137
  title: Using Custom Domains
5943
- subtitle: >-
5944
- Strengthen your agent's identity and improve deliverability with your own
5945
- domain.
6138
+ subtitle: Strengthen your agent's identity and improve deliverability with your own domain.
5946
6139
  slug: custom-domains
5947
- description: >-
5948
- A step-by-step guide to configuring your custom domain with AgentMail for
5949
- enhanced branding and trust.
5950
- ----------------------------
6140
+ description: A step-by-step guide to configuring your custom domain with AgentMail for enhanced branding and trust.
6141
+ ---------------------
6142
+
6143
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
5951
6144
 
5952
6145
  ## Why Use a Custom Domain?
5953
6146
 
@@ -6346,18 +6539,15 @@ DNS can be tricky. Here are some common issues and how to resolve them.
6346
6539
 
6347
6540
  Check out our guide on [Email Deliverability](/email-deliverability) for tips on warming up your new domain and maintaining a healthy sender reputation.
6348
6541
 
6349
-
6350
6542
  ***
6351
6543
 
6352
6544
  title: Managing Your Domains
6353
- subtitle: >-
6354
- Best practices for monitoring, scaling, and optimizing your domain strategy
6355
- for agent fleets.
6545
+ subtitle: Best practices for monitoring, scaling, and optimizing your domain strategy for agent fleets.
6356
6546
  slug: managing-domains
6357
- description: >-
6358
- Learn how to manage your custom domains effectively using AgentMail's API for
6359
- enhanced deliverability and reputation management.
6360
- --------------------------------------------------
6547
+ description: Learn how to manage your custom domains effectively using AgentMail's API for enhanced deliverability and reputation management.
6548
+ ---------------------
6549
+
6550
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
6361
6551
 
6362
6552
  ## From Setup to Strategy
6363
6553
 
@@ -6425,16 +6615,15 @@ By default, AgentMail configures your domain with a strict DMARC policy (`p=reje
6425
6615
 
6426
6616
  However, this is obviously up to your discretion if you want to impose a more relaxed DMARC policy, whether its `p=none` where it doesn't do anything if both SPF and DMARC fail, or its `p=quarantine`, where it puts the mail in spam/junk. Feel free to do more research at your own discretion. You can do this by changing the value in the TXT record in your DNS configuration where the name starts with `_dmarc`.
6427
6617
 
6428
-
6429
6618
  ***
6430
6619
 
6431
6620
  title: Webhooks Overview
6432
6621
  subtitle: Get real-time notifications for email events.
6433
- slug: overview
6434
- description: >-
6435
- Learn how to use Webhooks to build responsive, event-driven email agents with
6436
- AgentMail.
6437
- ----------
6622
+ slug: webhooks-overview
6623
+ description: Learn how to use Webhooks to build responsive, event-driven email agents with AgentMail.
6624
+ ---------------------
6625
+
6626
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
6438
6627
 
6439
6628
  Webhooks are the best way to get real-time information about what's happening with your emails. Instead of constantly asking the AgentMail API if there's a new email (a process called polling), you can register a URL, and we will send you a `POST` request with the details as soon as an event happens.
6440
6629
 
@@ -6445,6 +6634,10 @@ This event-driven approach is more efficient and allows you to build fast, respo
6445
6634
  * **Real-Time Speed:** Build conversational agents that can reply to incoming emails in seconds.
6446
6635
  * **Efficiency:** Eliminates the need for constant polling, which saves you computational resources and simplifies your application logic.
6447
6636
 
6637
+ <Callout intent="info" title="Prefer a simpler setup?">
6638
+ If you don't want to expose a public URL or set up ngrok, [WebSockets](/websockets) let you receive the same events over a persistent connection with no external tooling required.
6639
+ </Callout>
6640
+
6448
6641
  ## Available Events
6449
6642
 
6450
6643
  AgentMail supports nine webhook event types. When creating a webhook, you can subscribe to specific events or receive all of them. See [Webhook Events](/events) for full payload details.
@@ -6545,7 +6738,7 @@ Omitted content is always available through the API. After receiving a webhook,
6545
6738
 
6546
6739
  ```bash title="CLI"
6547
6740
  # fetch the full message after receiving a webhook
6548
- agentmail inboxes:messages retrieve \
6741
+ agentmail inboxes:messages get \
6549
6742
  --inbox-id <inbox_id> \
6550
6743
  --message-id <message_id>
6551
6744
  ```
@@ -6687,18 +6880,23 @@ Copy one of the blocks below into Cursor or Claude for complete Webhooks API kno
6687
6880
  Learn how to verify webhook signatures to secure your endpoints.
6688
6881
  </Card>
6689
6882
 
6883
+ <Card title="WebSockets" href="/websockets">
6884
+ Receive events over a persistent connection with no public URL required.
6885
+ </Card>
6886
+
6690
6887
  <Card title="Example: Event-Driven Agent" href="/github-star-agent">
6691
6888
  Build a fully deployable, event-driven agent that can respond to emails in
6692
6889
  real time.
6693
6890
  </Card>
6694
6891
  </CardGroup>
6695
6892
 
6696
-
6697
6893
  ***
6698
6894
 
6699
6895
  title: Webhook Events
6700
6896
  slug: events
6701
- ------------
6897
+ ---------------------
6898
+
6899
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
6702
6900
 
6703
6901
  As mentioned in the overview, webhooks allow us to create event-driven applications.
6704
6902
 
@@ -7241,16 +7439,15 @@ For example, if you only need to trigger workflows on incoming messages, you can
7241
7439
 
7242
7440
  If you have any specific webhook notifications you would like, please ping us in the `#feature-requests` channel in the [Discord](https://discord.gg/hTYatWYWBc)
7243
7441
 
7244
-
7245
7442
  ***
7246
7443
 
7247
7444
  title: Webhook Setup Guide
7248
7445
  subtitle: Step-by-step guide to configure webhooks.
7249
7446
  slug: webhook-setup
7250
- description: >-
7251
- A comprehensive guide to setting up webhooks with ngrok and AgentMail,
7252
- including account creation, inbox setup, and code examples.
7253
- -----------------------------------------------------------
7447
+ description: A comprehensive guide to setting up webhooks with ngrok and AgentMail, including account creation, inbox setup, and code examples.
7448
+ ---------------------
7449
+
7450
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
7254
7451
 
7255
7452
  This guide walks you through the complete process of setting up webhooks to receive real-time notifications from AgentMail. You'll learn how to create an ngrok account, set up an inbox, configure webhooks, and write a simple webhook receiver.
7256
7453
 
@@ -7263,6 +7460,10 @@ Before you start, make sure you have:
7263
7460
  * `pip` package manager
7264
7461
  * Basic familiarity with Python and terminal commands
7265
7462
 
7463
+ <Callout intent="info" title="Want something simpler?">
7464
+ Webhooks require a public URL and tools like ngrok. If you'd rather skip that setup, [WebSockets](/websockets) give you real-time events over a persistent connection with no external tooling. See the [WebSockets quickstart](/websockets/quickstart).
7465
+ </Callout>
7466
+
7266
7467
  ## Installation
7267
7468
 
7268
7469
  First, install the required Python packages:
@@ -7545,7 +7746,7 @@ For production deployments:
7545
7746
  Learn how to verify webhook signatures for secure endpoints.
7546
7747
  </Card>
7547
7748
 
7548
- <Card title="Webhooks Overview" href="/overview">
7749
+ <Card title="Webhooks Overview" href="/webhooks-overview">
7549
7750
  Learn more about how webhooks work and their payload structure.
7550
7751
  </Card>
7551
7752
 
@@ -7554,16 +7755,15 @@ For production deployments:
7554
7755
  </Card>
7555
7756
  </CardGroup>
7556
7757
 
7557
-
7558
7758
  ***
7559
7759
 
7560
7760
  title: Verifying Webhooks
7561
7761
  subtitle: Ensure webhook requests are authentically from AgentMail.
7562
7762
  slug: webhook-verification
7563
- description: >-
7564
- Learn how to verify webhook signatures to secure your webhook endpoints and
7565
- prevent spoofed requests.
7566
- -------------------------
7763
+ description: Learn how to verify webhook signatures to secure your webhook endpoints and prevent spoofed requests.
7764
+ ---------------------
7765
+
7766
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
7567
7767
 
7568
7768
  When building webhook receivers, it's critical to verify that incoming requests actually originate from AgentMail and haven't been tampered with. AgentMail uses [Svix](https://www.svix.com/) to deliver webhooks, which provides cryptographic signature verification.
7569
7769
 
@@ -7610,7 +7810,7 @@ Each webhook endpoint has a unique signing secret that you'll use to verify requ
7610
7810
 
7611
7811
  ```bash title="CLI"
7612
7812
  # get webhook details including the signing secret
7613
- agentmail webhooks retrieve --webhook-id ep_xxx
7813
+ agentmail webhooks get --webhook-id ep_xxx
7614
7814
  ```
7615
7815
  </CodeBlocks>
7616
7816
 
@@ -8006,16 +8206,15 @@ For production, you'll need to deploy your webhook server to a hosting provider
8006
8206
  </Card>
8007
8207
  </CardGroup>
8008
8208
 
8009
-
8010
8209
  ***
8011
8210
 
8012
8211
  title: WebSockets
8013
- subtitle: 'Real-time, low-latency email event streaming'
8212
+ subtitle: Real-time, low-latency email event streaming
8014
8213
  slug: websockets
8015
- description: >-
8016
- Learn how to use WebSockets for instant email notifications without webhooks
8017
- or polling.
8018
- -----------
8214
+ description: Learn how to use WebSockets for instant email notifications without webhooks or polling.
8215
+ ---------------------
8216
+
8217
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
8019
8218
 
8020
8219
  WebSockets provide a persistent, bidirectional connection to AgentMail for receiving email events in real-time. Unlike webhooks, WebSockets don't require a public URL or external tools like ngrok.
8021
8220
 
@@ -8458,13 +8657,14 @@ Copy one of the blocks below into Cursor or Claude for WebSockets in one shot.
8458
8657
 
8459
8658
  ***
8460
8659
 
8461
-
8462
8660
  ***
8463
8661
 
8464
8662
  title: WebSockets Quickstart
8465
8663
  subtitle: Get started with real-time email event streaming
8466
8664
  slug: websockets/quickstart
8467
- ---------------------------
8665
+ ---------------------
8666
+
8667
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
8468
8668
 
8469
8669
  ## Copy for Cursor / Claude
8470
8670
 
@@ -8552,16 +8752,15 @@ with client.websockets.connect() as socket:
8552
8752
  print(f"Received message from: {msg.from_}")
8553
8753
  ```
8554
8754
 
8555
-
8556
8755
  ***
8557
8756
 
8558
8757
  title: Email Deliverability
8559
- subtitle: 'Best practices for landing your emails in the inbox, not the spam folder.'
8758
+ subtitle: Best practices for landing your emails in the inbox, not the spam folder.
8560
8759
  slug: email-deliverability
8561
- description: >-
8562
- Learn the strategies and best practices for maximizing your email
8563
- deliverability with AgentMail.
8564
- ------------------------------
8760
+ description: Learn the strategies and best practices for maximizing your email deliverability with AgentMail.
8761
+ ---------------------
8762
+
8763
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
8565
8764
 
8566
8765
  ## What is Email Deliverability?
8567
8766
 
@@ -8667,16 +8866,15 @@ The content of your email plays a huge role in whether it's seen as a valuable m
8667
8866
  </Step>
8668
8867
  </Steps>
8669
8868
 
8670
-
8671
8869
  ***
8672
8870
 
8673
8871
  title: Idempotent Requests
8674
8872
  subtitle: Learn how to use idempotency keys to build safe and reliable API integrations.
8675
8873
  slug: idempotency
8676
- description: >-
8677
- A guide to using the client\_id parameter in AgentMail to prevent duplicate
8678
- resources and safely retry API requests.
8679
- ----------------------------------------
8874
+ description: A guide to using the client_id parameter in AgentMail to prevent duplicate resources and safely retry API requests.
8875
+ ---------------------
8876
+
8877
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
8680
8878
 
8681
8879
  ## What is Idempotency?
8682
8880
 
@@ -8722,18 +8920,15 @@ To use idempotency effectively, the `client_id` you generate must be unique and
8722
8920
 
8723
8921
  A common and highly effective pattern is to generate a UUID (like a `UUID v4`) on your client side for a resource you are about to create, save that UUID in your own database, and then use it as the `client_id` in the API call. This gives you a reliable key to use for any retries.
8724
8922
 
8725
-
8726
8923
  ***
8727
8924
 
8728
- title: 'Example: Event-Driven Agent'
8729
- subtitle: >-
8730
- Build a proactive, event-driven GitHub agent that uses Webhooks to handle
8731
- replies in real time.
8925
+ title: Example: Event-Driven Agent
8926
+ subtitle: Build a proactive, event-driven GitHub agent that uses Webhooks to handle replies in real time.
8732
8927
  slug: webhook-agent
8733
- description: >-
8734
- A step-by-step guide to building a sophisticated agent that performs proactive
8735
- outreach and uses webhooks for inbound message processing.
8736
- ----------------------------------------------------------
8928
+ description: A step-by-step guide to building a sophisticated agent that performs proactive outreach and uses webhooks for inbound message processing.
8929
+ ---------------------
8930
+
8931
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
8737
8932
 
8738
8933
  This tutorial walks you through building a sophisticated, dual-mode agent. It will:
8739
8934
 
@@ -9141,15 +9336,14 @@ You now have a fully event-driven agent that can both initiate conversations and
9141
9336
  ```
9142
9337
  ```
9143
9338
 
9144
-
9145
9339
  ***
9146
9340
 
9147
9341
  title: Auto-Reply Email Agent
9148
- description: >-
9149
- Build a simple agent that automatically responds to incoming emails with
9150
- personalized messages
9342
+ description: Build a simple agent that automatically responds to incoming emails with personalized messages
9151
9343
  ---------------------
9152
9344
 
9345
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
9346
+
9153
9347
  ## Overview
9154
9348
 
9155
9349
  Learn how to build an email auto-reply agent that automatically responds to incoming emails. This beginner-friendly example demonstrates the core concepts of building with AgentMail: receiving webhooks, processing email events, and sending automated replies.
@@ -10013,14 +10207,13 @@ Your agent now has conversation memory. When replying to follow-up emails, the A
10013
10207
 
10014
10208
  If you build something cool with AgentMail, we'd love to hear about it. Share in our [Discord community](https://discord.gg/hTYatWYWBc)!
10015
10209
 
10016
-
10017
10210
  ***
10018
10211
 
10019
10212
  title: Smart Email Labeling Agent
10020
- description: >-
10021
- Build an AI-powered agent that automatically classifies and labels incoming
10022
- emails across multiple dimensions
10023
- ---------------------------------
10213
+ description: Build an AI-powered agent that automatically classifies and labels incoming emails across multiple dimensions
10214
+ ---------------------
10215
+
10216
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
10024
10217
 
10025
10218
  ## Overview
10026
10219
 
@@ -10729,15 +10922,14 @@ Use this data to identify bottlenecks, improve processes, and make data-driven d
10729
10922
 
10730
10923
  Congratulations! You've built an AI-powered email classification system. This agent showcases how AgentMail's labeling feature can power sophisticated inbox automation and analytics.
10731
10924
 
10732
-
10733
10925
  ***
10734
10926
 
10735
10927
  title: Sales Agent with WebSocket
10736
10928
  slug: sales-agent-websocket
10737
- description: >-
10738
- A step-by-step guide to building an AI-powered sales agent that uses WebSocket
10739
- for real-time email processing without polling or webhooks.
10740
- -----------------------------------------------------------
10929
+ description: A step-by-step guide to building an AI-powered sales agent that uses WebSocket for real-time email processing without polling or webhooks.
10930
+ ---------------------
10931
+
10932
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
10741
10933
 
10742
10934
  ## Overview
10743
10935
 
@@ -11455,6 +11647,7 @@ await socket.send_subscribe(Subscribe(inbox_ids=[
11455
11647
 
11456
11648
  If you build something cool with AgentMail, we'd love to hear about it. Share in our [Discord community](https://discord.gg/hTYatWYWBc)!
11457
11649
 
11650
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
11458
11651
 
11459
11652
  # Live Email Agents
11460
11653
 
@@ -11497,15 +11690,14 @@ Ready to build your own intelligent email agent? Check out our [quickstart guide
11497
11690
  demo.
11498
11691
  </Note>
11499
11692
 
11500
-
11501
11693
  ***
11502
11694
 
11503
11695
  title: Frequently Asked Questions (FAQ)
11504
11696
  slug: faq
11505
- description: >-
11506
- Find answers to common questions about AgentMail, from core concepts to best
11507
- practices and security.
11508
- -----------------------
11697
+ description: Find answers to common questions about AgentMail, from core concepts to best practices and security.
11698
+ ---------------------
11699
+
11700
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
11509
11701
 
11510
11702
  <AccordionGroup>
11511
11703
  <Accordion title="What is AgentMail?">
@@ -11537,7 +11729,7 @@ practices and security.
11537
11729
  For production applications, **Webhooks are the recommended method**. They
11538
11730
  provide real-time notifications and are far more efficient than constantly
11539
11731
  polling the API for new messages. You can learn how to set them up in our
11540
- [Webhooks Overview](/overview).
11732
+ [Webhooks Overview](/webhooks-overview).
11541
11733
  </Accordion>
11542
11734
 
11543
11735
  <Accordion title="How do I get just the new content from a reply?">
@@ -11557,16 +11749,15 @@ practices and security.
11557
11749
  </Accordion>
11558
11750
  </AccordionGroup>
11559
11751
 
11560
-
11561
11752
  ***
11562
11753
 
11563
11754
  title: Email Reply Extraction with Talon
11564
11755
  subtitle: Extract clean reply content from email threads using Talon library
11565
11756
  slug: talon-reply-extraction
11566
- description: >-
11567
- Learn how to use Talon to extract new content from email replies, removing
11568
- quoted text with 93.8% accuracy.
11569
- --------------------------------
11757
+ description: Learn how to use Talon to extract new content from email replies, removing quoted text with 93.8% accuracy.
11758
+ ---------------------
11759
+
11760
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
11570
11761
 
11571
11762
  ## Why Talon?
11572
11763
 
@@ -12096,15 +12287,14 @@ TalonJS provides 90.6% accuracy with slightly faster performance (1.88ms), makin
12096
12287
  * The 3.2% accuracy difference is acceptable for most use cases
12097
12288
  </Tip>
12098
12289
 
12099
-
12100
12290
  ***
12101
12291
 
12102
12292
  title: Join the AgentMail Community
12103
12293
  slug: community
12104
- description: >-
12105
- Connect with the AgentMail team and developers, share what you're building,
12106
- and get support.
12107
- ----------------
12294
+ description: Connect with the AgentMail team and developers, share what you're building, and get support.
12295
+ ---------------------
12296
+
12297
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
12108
12298
 
12109
12299
  <CardGroup>
12110
12300
  <Card title="Join our Discord Server" href="https://discord.com/invite/hTYatWYWBc" icon="fa-brands fa-discord">
@@ -12129,13 +12319,14 @@ and get support.
12129
12319
  To learn more about our premium plans and dedicated support options, please visit our website [here](https://agentmail.to/pricing).
12130
12320
  </Callout>
12131
12321
 
12132
-
12133
12322
  ***
12134
12323
 
12135
12324
  title: Support
12136
12325
  slug: support
12137
12326
  description: Get help with AgentMail through our support channels.
12138
- ------------------------------------------------------------------
12327
+ ---------------------
12328
+
12329
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
12139
12330
 
12140
12331
  ## Need Help?
12141
12332
 
@@ -12147,13 +12338,14 @@ description: Get help with AgentMail through our support channels.
12147
12338
  <Card title="Email Support" icon="fa-solid fa-envelope" href="mailto:support@agentmail.cc" />
12148
12339
  </Cards>
12149
12340
 
12150
-
12151
12341
  ***
12152
12342
 
12153
- title: 'Understanding Email Authentication (SPF, DKIM, DMARC)'
12343
+ title: Understanding Email Authentication (SPF, DKIM, DMARC)
12154
12344
  slug: email-protocols
12155
- description: 'Learn why we ask for DNS records and what SPF, DKIM, and DMARC are.'
12156
- ----------------------------------------------------------------------------------
12345
+ description: Learn why we ask for DNS records and what SPF, DKIM, and DMARC are.
12346
+ ---------------------
12347
+
12348
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
12157
12349
 
12158
12350
  When you add a custom domain to AgentMail, we ask you to add several records to your DNS settings. We understand that this can seem daunting, and we want to be completely transparent about what these records are and why they are necessary.
12159
12351
 
@@ -12226,14 +12418,15 @@ This is some records that we might give you:
12226
12418
 
12227
12419
  We hope this provides a clear and transparent look into why these DNS records are required. By setting them up, you enable AgentMail to provide a secure and reliable email experience for your AI agents.
12228
12420
 
12229
-
12230
12421
  ***
12231
12422
 
12232
12423
  title: SOC 2 Compliance
12233
12424
  description: AgentMail's SOC 2 Type I and Type II compliance.
12234
- sidebar\_position: 40
12235
- lastUpdated: '2026-03-17'
12236
- -------------------------
12425
+ sidebar_position: 40
12426
+ lastUpdated: 2026-03-17
12427
+ ---------------------
12428
+
12429
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
12237
12430
 
12238
12431
  > AgentMail has achieved **SOC 2 Type I** (July 2025) and **Type II** (Q1 2026) compliance.
12239
12432
 
@@ -12361,13 +12554,14 @@ Organizations evaluating AgentMail can [request SOC 2 documentation](mailto:secu
12361
12554
 
12362
12555
  ***
12363
12556
 
12364
-
12365
12557
  ***
12366
12558
 
12367
12559
  title: Spam & Virus Detection
12368
12560
  slug: spam-virus-detection
12369
12561
  description: How AgentMail automatically scans incoming emails for spam and viruses.
12370
- ------------------------------------------------------------------------------------
12562
+ ---------------------
12563
+
12564
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
12371
12565
 
12372
12566
  AgentMail automatically scans every inbound message for spam and viruses before it reaches your inbox. This happens transparently — there is nothing you need to configure.
12373
12567
 
@@ -12418,14 +12612,15 @@ Each thread object includes a `spam` label indicating whether it was flagged as
12418
12612
  }
12419
12613
  ```
12420
12614
 
12421
-
12422
12615
  ***
12423
12616
 
12424
12617
  title: API Welcome
12425
12618
  subtitle: Getting Started with AgentMail
12426
12619
  slug: api-reference
12427
12620
  description: Quick overview of the AgentMail SDK
12428
- ------------------------------------------------
12621
+ ---------------------
12622
+
12623
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
12429
12624
 
12430
12625
  ## Introduction
12431
12626
 
@@ -12463,6 +12658,7 @@ If you have any other languages you would like us to support, please [reach out
12463
12658
 
12464
12659
  All of our SDKs are open source and available under the MIT license.
12465
12660
 
12661
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
12466
12662
 
12467
12663
  # Sign Up
12468
12664
 
@@ -12750,6 +12946,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
12750
12946
  dataTask.resume()
12751
12947
  ```
12752
12948
 
12949
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
12950
+
12753
12951
  # Verify
12754
12952
 
12755
12953
  POST https://api.agentmail.to/v0/agent/verify
@@ -13007,6 +13205,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
13007
13205
  dataTask.resume()
13008
13206
  ```
13009
13207
 
13208
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
13209
+
13010
13210
  # List Inboxes
13011
13211
 
13012
13212
  GET https://api.agentmail.to/v0/inboxes
@@ -13289,13 +13489,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
13289
13489
  dataTask.resume()
13290
13490
  ```
13291
13491
 
13492
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
13493
+
13292
13494
  # Get Inbox
13293
13495
 
13294
13496
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}
13295
13497
 
13296
13498
  **CLI:**
13297
13499
  ```bash
13298
- agentmail inboxes retrieve --inbox-id <inbox_id>
13500
+ agentmail inboxes get --inbox-id <inbox_id>
13299
13501
  ```
13300
13502
 
13301
13503
  Reference: https://docs.agentmail.to/api-reference/inboxes/get
@@ -13315,7 +13517,7 @@ paths:
13315
13517
  description: |-
13316
13518
  **CLI:**
13317
13519
  ```bash
13318
- agentmail inboxes retrieve --inbox-id <inbox_id>
13520
+ agentmail inboxes get --inbox-id <inbox_id>
13319
13521
  ```
13320
13522
  tags:
13321
13523
  - subpackage_inboxes
@@ -13554,6 +13756,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
13554
13756
  dataTask.resume()
13555
13757
  ```
13556
13758
 
13759
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
13760
+
13557
13761
  # Create Inbox
13558
13762
 
13559
13763
  POST https://api.agentmail.to/v0/inboxes
@@ -13842,6 +14046,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
13842
14046
  dataTask.resume()
13843
14047
  ```
13844
14048
 
14049
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
14050
+
13845
14051
  # Update Inbox
13846
14052
 
13847
14053
  PATCH https://api.agentmail.to/v0/inboxes/{inbox_id}
@@ -14149,6 +14355,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
14149
14355
  dataTask.resume()
14150
14356
  ```
14151
14357
 
14358
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
14359
+
14152
14360
  # Delete Inbox
14153
14361
 
14154
14362
  DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}
@@ -14366,6 +14574,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
14366
14574
  dataTask.resume()
14367
14575
  ```
14368
14576
 
14577
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
14578
+
14369
14579
  # List Threads
14370
14580
 
14371
14581
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/threads
@@ -14865,13 +15075,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
14865
15075
  dataTask.resume()
14866
15076
  ```
14867
15077
 
15078
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
15079
+
14868
15080
  # Get Thread
14869
15081
 
14870
15082
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}
14871
15083
 
14872
15084
  **CLI:**
14873
15085
  ```bash
14874
- agentmail inboxes:threads retrieve --inbox-id <inbox_id> --thread-id <thread_id>
15086
+ agentmail inboxes:threads get --inbox-id <inbox_id> --thread-id <thread_id>
14875
15087
  ```
14876
15088
 
14877
15089
  Reference: https://docs.agentmail.to/api-reference/inboxes/threads/get
@@ -14893,7 +15105,7 @@ paths:
14893
15105
 
14894
15106
  ```bash
14895
15107
 
14896
- agentmail inboxes:threads retrieve --inbox-id <inbox_id> --thread-id
15108
+ agentmail inboxes:threads get --inbox-id <inbox_id> --thread-id
14897
15109
  <thread_id>
14898
15110
 
14899
15111
  ```
@@ -15438,6 +15650,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
15438
15650
  dataTask.resume()
15439
15651
  ```
15440
15652
 
15653
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
15654
+
15441
15655
  # Get Attachment
15442
15656
 
15443
15657
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}/attachments/{attachment_id}
@@ -15734,6 +15948,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
15734
15948
  dataTask.resume()
15735
15949
  ```
15736
15950
 
15951
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
15952
+
15737
15953
  # Update Thread
15738
15954
 
15739
15955
  PATCH https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}
@@ -16043,6 +16259,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
16043
16259
  dataTask.resume()
16044
16260
  ```
16045
16261
 
16262
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
16263
+
16046
16264
  # Delete Thread
16047
16265
 
16048
16266
  DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}
@@ -16287,6 +16505,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
16287
16505
  dataTask.resume()
16288
16506
  ```
16289
16507
 
16508
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
16509
+
16290
16510
  # List Messages
16291
16511
 
16292
16512
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/messages
@@ -16805,13 +17025,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
16805
17025
  dataTask.resume()
16806
17026
  ```
16807
17027
 
17028
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
17029
+
16808
17030
  # Get Message
16809
17031
 
16810
17032
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}
16811
17033
 
16812
17034
  **CLI:**
16813
17035
  ```bash
16814
- agentmail inboxes:messages retrieve --inbox-id <inbox_id> --message-id <message_id>
17036
+ agentmail inboxes:messages get --inbox-id <inbox_id> --message-id <message_id>
16815
17037
  ```
16816
17038
 
16817
17039
  Reference: https://docs.agentmail.to/api-reference/inboxes/messages/get
@@ -16833,7 +17055,7 @@ paths:
16833
17055
 
16834
17056
  ```bash
16835
17057
 
16836
- agentmail inboxes:messages retrieve --inbox-id <inbox_id> --message-id
17058
+ agentmail inboxes:messages get --inbox-id <inbox_id> --message-id
16837
17059
  <message_id>
16838
17060
 
16839
17061
  ```
@@ -17251,6 +17473,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
17251
17473
  dataTask.resume()
17252
17474
  ```
17253
17475
 
17476
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
17477
+
17254
17478
  # Get Attachment
17255
17479
 
17256
17480
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/attachments/{attachment_id}
@@ -17547,6 +17771,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
17547
17771
  dataTask.resume()
17548
17772
  ```
17549
17773
 
17774
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
17775
+
17550
17776
  # Get Raw Message
17551
17777
 
17552
17778
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/raw
@@ -17809,6 +18035,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
17809
18035
  dataTask.resume()
17810
18036
  ```
17811
18037
 
18038
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
18039
+
17812
18040
  # Update Message
17813
18041
 
17814
18042
  PATCH https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}
@@ -18121,6 +18349,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
18121
18349
  dataTask.resume()
18122
18350
  ```
18123
18351
 
18352
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
18353
+
18124
18354
  # Delete Message
18125
18355
 
18126
18356
  DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}
@@ -18357,6 +18587,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
18357
18587
  dataTask.resume()
18358
18588
  ```
18359
18589
 
18590
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
18591
+
18360
18592
  # Send Message
18361
18593
 
18362
18594
  POST https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/send
@@ -18763,6 +18995,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
18763
18995
  dataTask.resume()
18764
18996
  ```
18765
18997
 
18998
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
18999
+
18766
19000
  # Reply To Message
18767
19001
 
18768
19002
  POST https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/reply
@@ -19175,6 +19409,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
19175
19409
  dataTask.resume()
19176
19410
  ```
19177
19411
 
19412
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
19413
+
19178
19414
  # Reply All Message
19179
19415
 
19180
19416
  POST https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/reply-all
@@ -19563,6 +19799,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
19563
19799
  dataTask.resume()
19564
19800
  ```
19565
19801
 
19802
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
19803
+
19566
19804
  # Forward Message
19567
19805
 
19568
19806
  POST https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/forward
@@ -19975,6 +20213,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
19975
20213
  dataTask.resume()
19976
20214
  ```
19977
20215
 
20216
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
20217
+
19978
20218
  # List Drafts
19979
20219
 
19980
20220
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts
@@ -20427,13 +20667,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
20427
20667
  dataTask.resume()
20428
20668
  ```
20429
20669
 
20670
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
20671
+
20430
20672
  # Get Draft
20431
20673
 
20432
20674
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}
20433
20675
 
20434
20676
  **CLI:**
20435
20677
  ```bash
20436
- agentmail inboxes:drafts retrieve --inbox-id <inbox_id> --draft-id <draft_id>
20678
+ agentmail inboxes:drafts get --inbox-id <inbox_id> --draft-id <draft_id>
20437
20679
  ```
20438
20680
 
20439
20681
  Reference: https://docs.agentmail.to/api-reference/inboxes/drafts/get
@@ -20450,14 +20692,10 @@ paths:
20450
20692
  get:
20451
20693
  operationId: get
20452
20694
  summary: Get Draft
20453
- description: >-
20695
+ description: |-
20454
20696
  **CLI:**
20455
-
20456
20697
  ```bash
20457
-
20458
- agentmail inboxes:drafts retrieve --inbox-id <inbox_id> --draft-id
20459
- <draft_id>
20460
-
20698
+ agentmail inboxes:drafts get --inbox-id <inbox_id> --draft-id <draft_id>
20461
20699
  ```
20462
20700
  tags:
20463
20701
  - subpackage_inboxes.subpackage_inboxes/drafts
@@ -20847,6 +21085,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
20847
21085
  dataTask.resume()
20848
21086
  ```
20849
21087
 
21088
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
21089
+
20850
21090
  # Get Attachment
20851
21091
 
20852
21092
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}/attachments/{attachment_id}
@@ -21143,6 +21383,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
21143
21383
  dataTask.resume()
21144
21384
  ```
21145
21385
 
21386
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
21387
+
21146
21388
  # Create Draft
21147
21389
 
21148
21390
  POST https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts
@@ -21631,6 +21873,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
21631
21873
  dataTask.resume()
21632
21874
  ```
21633
21875
 
21876
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
21877
+
21634
21878
  # Update Draft
21635
21879
 
21636
21880
  PATCH https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}
@@ -22096,6 +22340,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
22096
22340
  dataTask.resume()
22097
22341
  ```
22098
22342
 
22343
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
22344
+
22099
22345
  # Delete Draft
22100
22346
 
22101
22347
  DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}
@@ -22327,6 +22573,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
22327
22573
  dataTask.resume()
22328
22574
  ```
22329
22575
 
22576
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
22577
+
22330
22578
  # Send Draft
22331
22579
 
22332
22580
  POST https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}/send
@@ -22647,6 +22895,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
22647
22895
  dataTask.resume()
22648
22896
  ```
22649
22897
 
22898
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
22899
+
22650
22900
  # List Entries
22651
22901
 
22652
22902
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/lists/{direction}/{type}
@@ -22961,13 +23211,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
22961
23211
  dataTask.resume()
22962
23212
  ```
22963
23213
 
23214
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
23215
+
22964
23216
  # Get List Entry
22965
23217
 
22966
23218
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
22967
23219
 
22968
23220
  **CLI:**
22969
23221
  ```bash
22970
- agentmail inboxes:lists retrieve --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
23222
+ agentmail inboxes:lists get --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
22971
23223
  ```
22972
23224
 
22973
23225
  Reference: https://docs.agentmail.to/api-reference/inboxes/lists/get
@@ -22989,7 +23241,7 @@ paths:
22989
23241
 
22990
23242
  ```bash
22991
23243
 
22992
- agentmail inboxes:lists retrieve --inbox-id <inbox_id> --direction
23244
+ agentmail inboxes:lists get --inbox-id <inbox_id> --direction
22993
23245
  <direction> --type <type> --entry <entry>
22994
23246
 
22995
23247
  ```
@@ -23267,6 +23519,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
23267
23519
  dataTask.resume()
23268
23520
  ```
23269
23521
 
23522
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
23523
+
23270
23524
  # Create List Entry
23271
23525
 
23272
23526
  POST https://api.agentmail.to/v0/inboxes/{inbox_id}/lists/{direction}/{type}
@@ -23604,6 +23858,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
23604
23858
  dataTask.resume()
23605
23859
  ```
23606
23860
 
23861
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
23862
+
23607
23863
  # Delete List Entry
23608
23864
 
23609
23865
  DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
@@ -23859,6 +24115,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
23859
24115
  dataTask.resume()
23860
24116
  ```
23861
24117
 
24118
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
24119
+
23862
24120
  # Query Metrics
23863
24121
 
23864
24122
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/metrics
@@ -24168,6 +24426,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
24168
24426
  dataTask.resume()
24169
24427
  ```
24170
24428
 
24429
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
24430
+
24171
24431
  # List API Keys
24172
24432
 
24173
24433
  GET https://api.agentmail.to/v0/inboxes/{inbox_id}/api-keys
@@ -24589,6 +24849,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
24589
24849
  dataTask.resume()
24590
24850
  ```
24591
24851
 
24852
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
24853
+
24592
24854
  # Create API Key
24593
24855
 
24594
24856
  POST https://api.agentmail.to/v0/inboxes/{inbox_id}/api-keys
@@ -25018,6 +25280,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
25018
25280
  dataTask.resume()
25019
25281
  ```
25020
25282
 
25283
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
25284
+
25021
25285
  # Delete API Key
25022
25286
 
25023
25287
  DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/api-keys/{api_key_id}
@@ -25249,6 +25513,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
25249
25513
  dataTask.resume()
25250
25514
  ```
25251
25515
 
25516
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
25517
+
25252
25518
  # List Threads
25253
25519
 
25254
25520
  GET https://api.agentmail.to/v0/threads
@@ -25741,13 +26007,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
25741
26007
  dataTask.resume()
25742
26008
  ```
25743
26009
 
26010
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
26011
+
25744
26012
  # Get Thread
25745
26013
 
25746
26014
  GET https://api.agentmail.to/v0/threads/{thread_id}
25747
26015
 
25748
26016
  **CLI:**
25749
26017
  ```bash
25750
- agentmail threads retrieve --thread-id <thread_id>
26018
+ agentmail threads get --thread-id <thread_id>
25751
26019
  ```
25752
26020
 
25753
26021
  Reference: https://docs.agentmail.to/api-reference/threads/get
@@ -25767,7 +26035,7 @@ paths:
25767
26035
  description: |-
25768
26036
  **CLI:**
25769
26037
  ```bash
25770
- agentmail threads retrieve --thread-id <thread_id>
26038
+ agentmail threads get --thread-id <thread_id>
25771
26039
  ```
25772
26040
  tags:
25773
26041
  - subpackage_threads
@@ -26304,13 +26572,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
26304
26572
  dataTask.resume()
26305
26573
  ```
26306
26574
 
26575
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
26576
+
26307
26577
  # Get Attachment
26308
26578
 
26309
26579
  GET https://api.agentmail.to/v0/threads/{thread_id}/attachments/{attachment_id}
26310
26580
 
26311
26581
  **CLI:**
26312
26582
  ```bash
26313
- agentmail threads retrieve-attachment --thread-id <thread_id> --attachment-id <attachment_id>
26583
+ agentmail threads get-attachment --thread-id <thread_id> --attachment-id <attachment_id>
26314
26584
  ```
26315
26585
 
26316
26586
  Reference: https://docs.agentmail.to/api-reference/threads/get-attachment
@@ -26332,8 +26602,8 @@ paths:
26332
26602
 
26333
26603
  ```bash
26334
26604
 
26335
- agentmail threads retrieve-attachment --thread-id <thread_id>
26336
- --attachment-id <attachment_id>
26605
+ agentmail threads get-attachment --thread-id <thread_id> --attachment-id
26606
+ <attachment_id>
26337
26607
 
26338
26608
  ```
26339
26609
  tags:
@@ -26590,6 +26860,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
26590
26860
  dataTask.resume()
26591
26861
  ```
26592
26862
 
26863
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
26864
+
26593
26865
  # Update Thread
26594
26866
 
26595
26867
  PATCH https://api.agentmail.to/v0/threads/{thread_id}
@@ -26889,6 +27161,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
26889
27161
  dataTask.resume()
26890
27162
  ```
26891
27163
 
27164
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
27165
+
26892
27166
  # Delete Thread
26893
27167
 
26894
27168
  DELETE https://api.agentmail.to/v0/threads/{thread_id}
@@ -27122,6 +27396,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
27122
27396
  dataTask.resume()
27123
27397
  ```
27124
27398
 
27399
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
27400
+
27125
27401
  # List Drafts
27126
27402
 
27127
27403
  GET https://api.agentmail.to/v0/drafts
@@ -27567,13 +27843,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
27567
27843
  dataTask.resume()
27568
27844
  ```
27569
27845
 
27846
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
27847
+
27570
27848
  # Get Draft
27571
27849
 
27572
27850
  GET https://api.agentmail.to/v0/drafts/{draft_id}
27573
27851
 
27574
27852
  **CLI:**
27575
27853
  ```bash
27576
- agentmail drafts retrieve --draft-id <draft_id>
27854
+ agentmail drafts get --draft-id <draft_id>
27577
27855
  ```
27578
27856
 
27579
27857
  Reference: https://docs.agentmail.to/api-reference/drafts/get
@@ -27593,7 +27871,7 @@ paths:
27593
27871
  description: |-
27594
27872
  **CLI:**
27595
27873
  ```bash
27596
- agentmail drafts retrieve --draft-id <draft_id>
27874
+ agentmail drafts get --draft-id <draft_id>
27597
27875
  ```
27598
27876
  tags:
27599
27877
  - subpackage_drafts
@@ -27977,6 +28255,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
27977
28255
  dataTask.resume()
27978
28256
  ```
27979
28257
 
28258
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
28259
+
27980
28260
  # Get Attachment
27981
28261
 
27982
28262
  GET https://api.agentmail.to/v0/drafts/{draft_id}/attachments/{attachment_id}
@@ -28263,6 +28543,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
28263
28543
  dataTask.resume()
28264
28544
  ```
28265
28545
 
28546
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
28547
+
28266
28548
  # List Webhooks
28267
28549
 
28268
28550
  GET https://api.agentmail.to/v0/webhooks
@@ -28577,13 +28859,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
28577
28859
  dataTask.resume()
28578
28860
  ```
28579
28861
 
28862
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
28863
+
28580
28864
  # Get Webhook
28581
28865
 
28582
28866
  GET https://api.agentmail.to/v0/webhooks/{webhook_id}
28583
28867
 
28584
28868
  **CLI:**
28585
28869
  ```bash
28586
- agentmail webhooks retrieve --webhook-id <webhook_id>
28870
+ agentmail webhooks get --webhook-id <webhook_id>
28587
28871
  ```
28588
28872
 
28589
28873
  Reference: https://docs.agentmail.to/api-reference/webhooks/get
@@ -28603,7 +28887,7 @@ paths:
28603
28887
  description: |-
28604
28888
  **CLI:**
28605
28889
  ```bash
28606
- agentmail webhooks retrieve --webhook-id <webhook_id>
28890
+ agentmail webhooks get --webhook-id <webhook_id>
28607
28891
  ```
28608
28892
  tags:
28609
28893
  - subpackage_webhooks
@@ -28874,6 +29158,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
28874
29158
  dataTask.resume()
28875
29159
  ```
28876
29160
 
29161
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
29162
+
28877
29163
  # Create Webhook
28878
29164
 
28879
29165
  POST https://api.agentmail.to/v0/webhooks
@@ -29227,6 +29513,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
29227
29513
  dataTask.resume()
29228
29514
  ```
29229
29515
 
29516
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
29517
+
29230
29518
  # Update Webhook
29231
29519
 
29232
29520
  PATCH https://api.agentmail.to/v0/webhooks/{webhook_id}
@@ -29586,6 +29874,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
29586
29874
  dataTask.resume()
29587
29875
  ```
29588
29876
 
29877
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
29878
+
29589
29879
  # Delete Webhook
29590
29880
 
29591
29881
  DELETE https://api.agentmail.to/v0/webhooks/{webhook_id}
@@ -29803,6 +30093,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
29803
30093
  dataTask.resume()
29804
30094
  ```
29805
30095
 
30096
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
30097
+
29806
30098
  # Message Received
29807
30099
 
29808
30100
  POST
@@ -30232,6 +30524,8 @@ components:
30232
30524
 
30233
30525
  ```
30234
30526
 
30527
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
30528
+
30235
30529
  # Message Sent
30236
30530
 
30237
30531
  POST
@@ -30358,6 +30652,8 @@ components:
30358
30652
 
30359
30653
  ```
30360
30654
 
30655
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
30656
+
30361
30657
  # Message Delivered
30362
30658
 
30363
30659
  POST
@@ -30484,6 +30780,8 @@ components:
30484
30780
 
30485
30781
  ```
30486
30782
 
30783
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
30784
+
30487
30785
  # Message Bounced
30488
30786
 
30489
30787
  POST
@@ -30631,6 +30929,8 @@ components:
30631
30929
 
30632
30930
  ```
30633
30931
 
30932
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
30933
+
30634
30934
  # Message Complained
30635
30935
 
30636
30936
  POST
@@ -30765,6 +31065,8 @@ components:
30765
31065
 
30766
31066
  ```
30767
31067
 
31068
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
31069
+
30768
31070
  # Message Rejected
30769
31071
 
30770
31072
  POST
@@ -30889,6 +31191,8 @@ components:
30889
31191
 
30890
31192
  ```
30891
31193
 
31194
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
31195
+
30892
31196
  # Domain Verified
30893
31197
 
30894
31198
  POST
@@ -31084,6 +31388,8 @@ components:
31084
31388
 
31085
31389
  ```
31086
31390
 
31391
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
31392
+
31087
31393
  # Connect
31088
31394
 
31089
31395
  GET /v0
@@ -32095,6 +32401,8 @@ components:
32095
32401
 
32096
32402
  ```
32097
32403
 
32404
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
32405
+
32098
32406
  # List Domains
32099
32407
 
32100
32408
  GET https://api.agentmail.to/v0/domains
@@ -32377,13 +32685,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
32377
32685
  dataTask.resume()
32378
32686
  ```
32379
32687
 
32688
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
32689
+
32380
32690
  # Get Domain
32381
32691
 
32382
32692
  GET https://api.agentmail.to/v0/domains/{domain_id}
32383
32693
 
32384
32694
  **CLI:**
32385
32695
  ```bash
32386
- agentmail domains retrieve --domain-id <domain_id>
32696
+ agentmail domains get --domain-id <domain_id>
32387
32697
  ```
32388
32698
 
32389
32699
  Reference: https://docs.agentmail.to/api-reference/domains/get
@@ -32403,7 +32713,7 @@ paths:
32403
32713
  description: |-
32404
32714
  **CLI:**
32405
32715
  ```bash
32406
- agentmail domains retrieve --domain-id <domain_id>
32716
+ agentmail domains get --domain-id <domain_id>
32407
32717
  ```
32408
32718
  tags:
32409
32719
  - subpackage_domains
@@ -32703,6 +33013,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
32703
33013
  dataTask.resume()
32704
33014
  ```
32705
33015
 
33016
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
33017
+
32706
33018
  # Get Zone File
32707
33019
 
32708
33020
  GET https://api.agentmail.to/v0/domains/{domain_id}/zone-file
@@ -32925,6 +33237,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
32925
33237
  dataTask.resume()
32926
33238
  ```
32927
33239
 
33240
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
33241
+
32928
33242
  # Create Domain
32929
33243
 
32930
33244
  POST https://api.agentmail.to/v0/domains
@@ -33288,6 +33602,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
33288
33602
  dataTask.resume()
33289
33603
  ```
33290
33604
 
33605
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
33606
+
33291
33607
  # Update Domain
33292
33608
 
33293
33609
  PATCH https://api.agentmail.to/v0/domains/{domain_id}
@@ -33645,6 +33961,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
33645
33961
  dataTask.resume()
33646
33962
  ```
33647
33963
 
33964
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
33965
+
33648
33966
  # Delete Domain
33649
33967
 
33650
33968
  DELETE https://api.agentmail.to/v0/domains/{domain_id}
@@ -33862,6 +34180,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
33862
34180
  dataTask.resume()
33863
34181
  ```
33864
34182
 
34183
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
34184
+
33865
34185
  # Verify Domain
33866
34186
 
33867
34187
  POST https://api.agentmail.to/v0/domains/{domain_id}/verify
@@ -34079,6 +34399,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
34079
34399
  dataTask.resume()
34080
34400
  ```
34081
34401
 
34402
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
34403
+
34082
34404
  # List Entries
34083
34405
 
34084
34406
  GET https://api.agentmail.to/v0/lists/{direction}/{type}
@@ -34372,13 +34694,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
34372
34694
  dataTask.resume()
34373
34695
  ```
34374
34696
 
34697
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
34698
+
34375
34699
  # Get List Entry
34376
34700
 
34377
34701
  GET https://api.agentmail.to/v0/lists/{direction}/{type}/{entry}
34378
34702
 
34379
34703
  **CLI:**
34380
34704
  ```bash
34381
- agentmail lists retrieve --direction <direction> --type <type> --entry <entry>
34705
+ agentmail lists get --direction <direction> --type <type> --entry <entry>
34382
34706
  ```
34383
34707
 
34384
34708
  Reference: https://docs.agentmail.to/api-reference/lists/get
@@ -34400,7 +34724,7 @@ paths:
34400
34724
 
34401
34725
  ```bash
34402
34726
 
34403
- agentmail lists retrieve --direction <direction> --type <type> --entry
34727
+ agentmail lists get --direction <direction> --type <type> --entry
34404
34728
  <entry>
34405
34729
 
34406
34730
  ```
@@ -34661,6 +34985,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
34661
34985
  dataTask.resume()
34662
34986
  ```
34663
34987
 
34988
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
34989
+
34664
34990
  # Create List Entry
34665
34991
 
34666
34992
  POST https://api.agentmail.to/v0/lists/{direction}/{type}
@@ -34981,6 +35307,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
34981
35307
  dataTask.resume()
34982
35308
  ```
34983
35309
 
35310
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
35311
+
34984
35312
  # Delete List Entry
34985
35313
 
34986
35314
  DELETE https://api.agentmail.to/v0/lists/{direction}/{type}/{entry}
@@ -35226,6 +35554,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
35226
35554
  dataTask.resume()
35227
35555
  ```
35228
35556
 
35557
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
35558
+
35229
35559
  # Query Metrics
35230
35560
 
35231
35561
  GET https://api.agentmail.to/v0/metrics
@@ -35524,6 +35854,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
35524
35854
  dataTask.resume()
35525
35855
  ```
35526
35856
 
35857
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
35858
+
35527
35859
  # List API Keys
35528
35860
 
35529
35861
  GET https://api.agentmail.to/v0/api-keys
@@ -35918,6 +36250,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
35918
36250
  dataTask.resume()
35919
36251
  ```
35920
36252
 
36253
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
36254
+
35921
36255
  # Create API Key
35922
36256
 
35923
36257
  POST https://api.agentmail.to/v0/api-keys
@@ -36315,6 +36649,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
36315
36649
  dataTask.resume()
36316
36650
  ```
36317
36651
 
36652
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
36653
+
36318
36654
  # Delete API Key
36319
36655
 
36320
36656
  DELETE https://api.agentmail.to/v0/api-keys/{api_key_id}
@@ -36532,6 +36868,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
36532
36868
  dataTask.resume()
36533
36869
  ```
36534
36870
 
36871
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
36872
+
36535
36873
  # List Pods
36536
36874
 
36537
36875
  GET https://api.agentmail.to/v0/pods
@@ -36801,13 +37139,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
36801
37139
  dataTask.resume()
36802
37140
  ```
36803
37141
 
37142
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
37143
+
36804
37144
  # Get Pod
36805
37145
 
36806
37146
  GET https://api.agentmail.to/v0/pods/{pod_id}
36807
37147
 
36808
37148
  **CLI:**
36809
37149
  ```bash
36810
- agentmail pods retrieve --pod-id <pod_id>
37150
+ agentmail pods get --pod-id <pod_id>
36811
37151
  ```
36812
37152
 
36813
37153
  Reference: https://docs.agentmail.to/api-reference/pods/get
@@ -36827,7 +37167,7 @@ paths:
36827
37167
  description: |-
36828
37168
  **CLI:**
36829
37169
  ```bash
36830
- agentmail pods retrieve --pod-id <pod_id>
37170
+ agentmail pods get --pod-id <pod_id>
36831
37171
  ```
36832
37172
  tags:
36833
37173
  - subpackage_pods
@@ -37053,6 +37393,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
37053
37393
  dataTask.resume()
37054
37394
  ```
37055
37395
 
37396
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
37397
+
37056
37398
  # Create Pod
37057
37399
 
37058
37400
  POST https://api.agentmail.to/v0/pods
@@ -37327,6 +37669,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
37327
37669
  dataTask.resume()
37328
37670
  ```
37329
37671
 
37672
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
37673
+
37330
37674
  # Delete Pod
37331
37675
 
37332
37676
  DELETE https://api.agentmail.to/v0/pods/{pod_id}
@@ -37544,6 +37888,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
37544
37888
  dataTask.resume()
37545
37889
  ```
37546
37890
 
37891
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
37892
+
37547
37893
  # List Inboxes
37548
37894
 
37549
37895
  GET https://api.agentmail.to/v0/pods/{pod_id}/inboxes
@@ -37858,13 +38204,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
37858
38204
  dataTask.resume()
37859
38205
  ```
37860
38206
 
38207
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
38208
+
37861
38209
  # Get Inbox
37862
38210
 
37863
38211
  GET https://api.agentmail.to/v0/pods/{pod_id}/inboxes/{inbox_id}
37864
38212
 
37865
38213
  **CLI:**
37866
38214
  ```bash
37867
- agentmail pods:inboxes retrieve --pod-id <pod_id> --inbox-id <inbox_id>
38215
+ agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
37868
38216
  ```
37869
38217
 
37870
38218
  Reference: https://docs.agentmail.to/api-reference/pods/inboxes/get
@@ -37884,7 +38232,7 @@ paths:
37884
38232
  description: |-
37885
38233
  **CLI:**
37886
38234
  ```bash
37887
- agentmail pods:inboxes retrieve --pod-id <pod_id> --inbox-id <inbox_id>
38235
+ agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
37888
38236
  ```
37889
38237
  tags:
37890
38238
  - subpackage_pods.subpackage_pods/inboxes
@@ -38129,6 +38477,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
38129
38477
  dataTask.resume()
38130
38478
  ```
38131
38479
 
38480
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
38481
+
38132
38482
  # Create Inbox
38133
38483
 
38134
38484
  POST https://api.agentmail.to/v0/pods/{pod_id}/inboxes
@@ -38435,6 +38785,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
38435
38785
  dataTask.resume()
38436
38786
  ```
38437
38787
 
38788
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
38789
+
38438
38790
  # Update Inbox
38439
38791
 
38440
38792
  PATCH https://api.agentmail.to/v0/pods/{pod_id}/inboxes/{inbox_id}
@@ -38744,6 +39096,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
38744
39096
  dataTask.resume()
38745
39097
  ```
38746
39098
 
39099
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
39100
+
38747
39101
  # Delete Inbox
38748
39102
 
38749
39103
  DELETE https://api.agentmail.to/v0/pods/{pod_id}/inboxes/{inbox_id}
@@ -38971,6 +39325,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
38971
39325
  dataTask.resume()
38972
39326
  ```
38973
39327
 
39328
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
39329
+
38974
39330
  # List Threads
38975
39331
 
38976
39332
  GET https://api.agentmail.to/v0/pods/{pod_id}/threads
@@ -39474,13 +39830,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
39474
39830
  dataTask.resume()
39475
39831
  ```
39476
39832
 
39833
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
39834
+
39477
39835
  # Get Thread
39478
39836
 
39479
39837
  GET https://api.agentmail.to/v0/pods/{pod_id}/threads/{thread_id}
39480
39838
 
39481
39839
  **CLI:**
39482
39840
  ```bash
39483
- agentmail pods:threads retrieve --pod-id <pod_id> --thread-id <thread_id>
39841
+ agentmail pods:threads get --pod-id <pod_id> --thread-id <thread_id>
39484
39842
  ```
39485
39843
 
39486
39844
  Reference: https://docs.agentmail.to/api-reference/pods/threads/get
@@ -39497,14 +39855,10 @@ paths:
39497
39855
  get:
39498
39856
  operationId: get
39499
39857
  summary: Get Thread
39500
- description: >-
39858
+ description: |-
39501
39859
  **CLI:**
39502
-
39503
39860
  ```bash
39504
-
39505
- agentmail pods:threads retrieve --pod-id <pod_id> --thread-id
39506
- <thread_id>
39507
-
39861
+ agentmail pods:threads get --pod-id <pod_id> --thread-id <thread_id>
39508
39862
  ```
39509
39863
  tags:
39510
39864
  - subpackage_pods.subpackage_pods/threads
@@ -40051,6 +40405,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
40051
40405
  dataTask.resume()
40052
40406
  ```
40053
40407
 
40408
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
40409
+
40054
40410
  # Get Attachment
40055
40411
 
40056
40412
  GET https://api.agentmail.to/v0/pods/{pod_id}/threads/{thread_id}/attachments/{attachment_id}
@@ -40347,6 +40703,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
40347
40703
  dataTask.resume()
40348
40704
  ```
40349
40705
 
40706
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
40707
+
40350
40708
  # Update Thread
40351
40709
 
40352
40710
  PATCH https://api.agentmail.to/v0/pods/{pod_id}/threads/{thread_id}
@@ -40656,6 +41014,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
40656
41014
  dataTask.resume()
40657
41015
  ```
40658
41016
 
41017
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
41018
+
40659
41019
  # Delete Thread
40660
41020
 
40661
41021
  DELETE https://api.agentmail.to/v0/pods/{pod_id}/threads/{thread_id}
@@ -40899,6 +41259,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
40899
41259
  dataTask.resume()
40900
41260
  ```
40901
41261
 
41262
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
41263
+
40902
41264
  # List Drafts
40903
41265
 
40904
41266
  GET https://api.agentmail.to/v0/pods/{pod_id}/drafts
@@ -41355,13 +41717,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
41355
41717
  dataTask.resume()
41356
41718
  ```
41357
41719
 
41720
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
41721
+
41358
41722
  # Get Draft
41359
41723
 
41360
41724
  GET https://api.agentmail.to/v0/pods/{pod_id}/drafts/{draft_id}
41361
41725
 
41362
41726
  **CLI:**
41363
41727
  ```bash
41364
- agentmail pods:drafts retrieve --pod-id <pod_id> --draft-id <draft_id>
41728
+ agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>
41365
41729
  ```
41366
41730
 
41367
41731
  Reference: https://docs.agentmail.to/api-reference/pods/drafts/get
@@ -41381,7 +41745,7 @@ paths:
41381
41745
  description: |-
41382
41746
  **CLI:**
41383
41747
  ```bash
41384
- agentmail pods:drafts retrieve --pod-id <pod_id> --draft-id <draft_id>
41748
+ agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>
41385
41749
  ```
41386
41750
  tags:
41387
41751
  - subpackage_pods.subpackage_pods/drafts
@@ -41775,6 +42139,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
41775
42139
  dataTask.resume()
41776
42140
  ```
41777
42141
 
42142
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
42143
+
41778
42144
  # Get Attachment
41779
42145
 
41780
42146
  GET https://api.agentmail.to/v0/pods/{pod_id}/drafts/{draft_id}/attachments/{attachment_id}
@@ -42071,6 +42437,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
42071
42437
  dataTask.resume()
42072
42438
  ```
42073
42439
 
42440
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
42441
+
42074
42442
  # List Domains
42075
42443
 
42076
42444
  GET https://api.agentmail.to/v0/pods/{pod_id}/domains
@@ -42385,13 +42753,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
42385
42753
  dataTask.resume()
42386
42754
  ```
42387
42755
 
42756
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
42757
+
42388
42758
  # Get Domain
42389
42759
 
42390
42760
  GET https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}
42391
42761
 
42392
42762
  **CLI:**
42393
42763
  ```bash
42394
- agentmail pods:domains retrieve --pod-id <pod_id> --domain-id <domain_id>
42764
+ agentmail pods:domains get --pod-id <pod_id> --domain-id <domain_id>
42395
42765
  ```
42396
42766
 
42397
42767
  Reference: https://docs.agentmail.to/api-reference/pods/domains/get
@@ -42408,14 +42778,10 @@ paths:
42408
42778
  get:
42409
42779
  operationId: get
42410
42780
  summary: Get Domain
42411
- description: >-
42781
+ description: |-
42412
42782
  **CLI:**
42413
-
42414
42783
  ```bash
42415
-
42416
- agentmail pods:domains retrieve --pod-id <pod_id> --domain-id
42417
- <domain_id>
42418
-
42784
+ agentmail pods:domains get --pod-id <pod_id> --domain-id <domain_id>
42419
42785
  ```
42420
42786
  tags:
42421
42787
  - subpackage_pods.subpackage_pods/domains
@@ -42721,6 +43087,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
42721
43087
  dataTask.resume()
42722
43088
  ```
42723
43089
 
43090
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
43091
+
42724
43092
  # Get Zone File
42725
43093
 
42726
43094
  GET https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}/zone-file
@@ -42957,6 +43325,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
42957
43325
  dataTask.resume()
42958
43326
  ```
42959
43327
 
43328
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
43329
+
42960
43330
  # Create Domain
42961
43331
 
42962
43332
  POST https://api.agentmail.to/v0/pods/{pod_id}/domains
@@ -43326,6 +43696,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
43326
43696
  dataTask.resume()
43327
43697
  ```
43328
43698
 
43699
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
43700
+
43329
43701
  # Update Domain
43330
43702
 
43331
43703
  PATCH https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}
@@ -43689,6 +44061,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
43689
44061
  dataTask.resume()
43690
44062
  ```
43691
44063
 
44064
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
44065
+
43692
44066
  # Delete Domain
43693
44067
 
43694
44068
  DELETE https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}
@@ -43916,6 +44290,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
43916
44290
  dataTask.resume()
43917
44291
  ```
43918
44292
 
44293
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
44294
+
43919
44295
  # Verify Domain
43920
44296
 
43921
44297
  POST https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}/verify
@@ -44143,6 +44519,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
44143
44519
  dataTask.resume()
44144
44520
  ```
44145
44521
 
44522
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
44523
+
44146
44524
  # List Entries
44147
44525
 
44148
44526
  GET https://api.agentmail.to/v0/pods/{pod_id}/lists/{direction}/{type}
@@ -44457,13 +44835,15 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
44457
44835
  dataTask.resume()
44458
44836
  ```
44459
44837
 
44838
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
44839
+
44460
44840
  # Get List Entry
44461
44841
 
44462
44842
  GET https://api.agentmail.to/v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
44463
44843
 
44464
44844
  **CLI:**
44465
44845
  ```bash
44466
- agentmail pods:lists retrieve --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
44846
+ agentmail pods:lists get --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
44467
44847
  ```
44468
44848
 
44469
44849
  Reference: https://docs.agentmail.to/api-reference/pods/lists/get
@@ -44485,7 +44865,7 @@ paths:
44485
44865
 
44486
44866
  ```bash
44487
44867
 
44488
- agentmail pods:lists retrieve --pod-id <pod_id> --direction <direction>
44868
+ agentmail pods:lists get --pod-id <pod_id> --direction <direction>
44489
44869
  --type <type> --entry <entry>
44490
44870
 
44491
44871
  ```
@@ -44763,6 +45143,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
44763
45143
  dataTask.resume()
44764
45144
  ```
44765
45145
 
45146
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
45147
+
44766
45148
  # Create List Entry
44767
45149
 
44768
45150
  POST https://api.agentmail.to/v0/pods/{pod_id}/lists/{direction}/{type}
@@ -45100,6 +45482,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
45100
45482
  dataTask.resume()
45101
45483
  ```
45102
45484
 
45485
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
45486
+
45103
45487
  # Delete List Entry
45104
45488
 
45105
45489
  DELETE https://api.agentmail.to/v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
@@ -45355,6 +45739,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
45355
45739
  dataTask.resume()
45356
45740
  ```
45357
45741
 
45742
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
45743
+
45358
45744
  # Query Metrics
45359
45745
 
45360
45746
  GET https://api.agentmail.to/v0/pods/{pod_id}/metrics
@@ -45664,6 +46050,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
45664
46050
  dataTask.resume()
45665
46051
  ```
45666
46052
 
46053
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
46054
+
45667
46055
  # List API Keys
45668
46056
 
45669
46057
  GET https://api.agentmail.to/v0/pods/{pod_id}/api-keys
@@ -46085,6 +46473,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
46085
46473
  dataTask.resume()
46086
46474
  ```
46087
46475
 
46476
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
46477
+
46088
46478
  # Create API Key
46089
46479
 
46090
46480
  POST https://api.agentmail.to/v0/pods/{pod_id}/api-keys
@@ -46514,6 +46904,8 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
46514
46904
  dataTask.resume()
46515
46905
  ```
46516
46906
 
46907
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
46908
+
46517
46909
  # Delete API Key
46518
46910
 
46519
46911
  DELETE https://api.agentmail.to/v0/pods/{pod_id}/api-keys/{api_key_id}
@@ -46745,11 +47137,18 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
46745
47137
  dataTask.resume()
46746
47138
  ```
46747
47139
 
47140
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47141
+
46748
47142
  # Get Organization
46749
47143
 
46750
47144
  GET https://api.agentmail.to/v0/organizations
46751
47145
 
46752
- Get the current organization.
47146
+ Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).
47147
+
47148
+ **CLI:**
47149
+ ```bash
47150
+ agentmail organizations get
47151
+ ```
46753
47152
 
46754
47153
  Reference: https://docs.agentmail.to/api-reference/organizations/get
46755
47154
 
@@ -46765,7 +47164,18 @@ paths:
46765
47164
  get:
46766
47165
  operationId: get
46767
47166
  summary: Get Organization
46768
- description: Get the current organization.
47167
+ description: >-
47168
+ Returns the organization for the authenticated API key (usage limits,
47169
+ counts, and billing metadata).
47170
+
47171
+
47172
+ **CLI:**
47173
+
47174
+ ```bash
47175
+
47176
+ agentmail organizations get
47177
+
47178
+ ```
46769
47179
  tags:
46770
47180
  - subpackage_organizations
46771
47181
  parameters:
@@ -46980,7 +47390,9 @@ dataTask.resume()
46980
47390
  title: Knowledge Base
46981
47391
  subtitle: A collection of answers to frequently asked questions.
46982
47392
  slug: knowledge-base
46983
- --------------------
47393
+ ---------------------
47394
+
47395
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
46984
47396
 
46985
47397
  ## Getting Started
46986
47398
 
@@ -47072,6 +47484,10 @@ slug: knowledge-base
47072
47484
  <Card title="Emails bouncing" icon="fa-solid fa-rotate-left" href="/knowledge-base/emails-bouncing">
47073
47485
  Diagnose and resolve email bounce issues.
47074
47486
  </Card>
47487
+
47488
+ <Card title="Email spoofing protection" icon="fa-solid fa-shield-halved" href="/knowledge-base/inbound-emails-missing">
47489
+ How AgentMail protects your inboxes from unauthenticated senders.
47490
+ </Card>
47075
47491
  </Cards>
47076
47492
 
47077
47493
  ## DNS Guides
@@ -47096,13 +47512,14 @@ Step-by-step instructions for verifying your domain with popular DNS providers.
47096
47512
  </Card>
47097
47513
  </Cards>
47098
47514
 
47099
-
47100
47515
  ***
47101
47516
 
47102
47517
  title: What is AgentMail and how is it different?
47103
47518
  subtitle: Understand how AgentMail compares to traditional email providers.
47104
47519
  slug: knowledge-base/what-is-agentmail
47105
- --------------------------------------
47520
+ ---------------------
47521
+
47522
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47106
47523
 
47107
47524
  AgentMail is email infrastructure built specifically for AI agents. Unlike transactional email APIs that focus on one-way sending, AgentMail is built for two-way agent communication: dedicated inboxes, native threading, and full receiving support with no shared sending domains.
47108
47525
 
@@ -47135,13 +47552,14 @@ AgentMail is the right choice when:
47135
47552
 
47136
47553
  Yes. AgentMail's send API works similarly. Replace your existing send call with `client.inboxes.messages.send()` and you get the same sending capability plus full receiving, threading, and agent identity features on top. See the [Quickstart](/quickstart) to get started in minutes.
47137
47554
 
47138
-
47139
47555
  ***
47140
47556
 
47141
47557
  title: What can I do with an AgentMail inbox?
47142
47558
  subtitle: A complete overview of inbox capabilities for AI agents.
47143
47559
  slug: knowledge-base/inbox-capabilities
47144
- ---------------------------------------
47560
+ ---------------------
47561
+
47562
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47145
47563
 
47146
47564
  An AgentMail inbox is a full email account for your AI agent. Each inbox gets a unique email address and can send, receive, reply, forward, and manage emails entirely through the API.
47147
47565
 
@@ -47233,13 +47651,14 @@ if threads.threads:
47233
47651
  )
47234
47652
  ```
47235
47653
 
47236
-
47237
47654
  ***
47238
47655
 
47239
47656
  title: How do I create my first inbox?
47240
47657
  subtitle: Get up and running with your first AgentMail inbox.
47241
47658
  slug: knowledge-base/creating-first-inbox
47242
- -----------------------------------------
47659
+ ---------------------
47660
+
47661
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47243
47662
 
47244
47663
  Creating an inbox gives your AI agent its own email address. You can create inboxes on the default `@agentmail.to` domain or on your own custom domain.
47245
47664
 
@@ -47332,13 +47751,14 @@ Now that you have an inbox, explore what you can do with it:
47332
47751
  * [Set up webhooks](/webhook-setup) to get notified when emails arrive
47333
47752
  * [Use labels](/labels) to track message state in your agent workflows
47334
47753
 
47335
-
47336
47754
  ***
47337
47755
 
47338
47756
  title: How do I get my API key?
47339
47757
  subtitle: Create and manage your AgentMail API keys.
47340
47758
  slug: knowledge-base/getting-api-key
47341
- ------------------------------------
47759
+ ---------------------
47760
+
47761
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47342
47762
 
47343
47763
  You need an API key to authenticate requests to the AgentMail API. API keys start with `am_` and are created in the AgentMail Console.
47344
47764
 
@@ -47402,13 +47822,14 @@ No credit card required to get started. The free tier includes:
47402
47822
 
47403
47823
  To create more inboxes or send higher volumes, see the [pricing page](https://agentmail.to/pricing).
47404
47824
 
47405
-
47406
47825
  ***
47407
47826
 
47408
47827
  title: How do I handle inbound emails with my agent?
47409
47828
  subtitle: Compare Webhooks and WebSockets for processing incoming emails.
47410
47829
  slug: knowledge-base/handling-inbound-emails
47411
- --------------------------------------------
47830
+ ---------------------
47831
+
47832
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47412
47833
 
47413
47834
  AgentMail offers two ways to process incoming emails, each suited to different use cases.
47414
47835
 
@@ -47512,13 +47933,14 @@ See the [WebSocket Overview](/websockets) for more details.
47512
47933
 
47513
47934
  For most production use cases, **webhooks** are recommended. They are reliable, event-driven, and integrate well with serverless platforms. If you need real-time events without exposing a public URL, **WebSockets** are the best option.
47514
47935
 
47515
-
47516
47936
  ***
47517
47937
 
47518
47938
  title: How do I set up allowlists and blocklists?
47519
47939
  subtitle: Control who your AI agent can send to and receive from.
47520
47940
  slug: knowledge-base/allowlists-blocklists
47521
- ------------------------------------------
47941
+ ---------------------
47942
+
47943
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47522
47944
 
47523
47945
  Allowlists and blocklists let you control who your AI agent can communicate with. This is a critical safety feature for autonomous agents running in production with minimal human oversight.
47524
47946
 
@@ -47659,13 +48081,14 @@ Without guardrails, an autonomous agent could email the wrong people, respond to
47659
48081
 
47660
48082
  For more details on the Lists API, see the [Lists core concept](/lists) documentation.
47661
48083
 
47662
-
47663
48084
  ***
47664
48085
 
47665
48086
  title: How do I manage threaded conversations?
47666
48087
  subtitle: Maintain context across multi-turn email conversations with your agent.
47667
48088
  slug: knowledge-base/threaded-conversations
47668
- -------------------------------------------
48089
+ ---------------------
48090
+
48091
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47669
48092
 
47670
48093
  Threads are how AgentMail organizes conversations. Every time your agent sends a new email, a thread is created. Replies are automatically grouped into the same thread, giving your agent full conversation context.
47671
48094
 
@@ -47789,13 +48212,14 @@ for thread in unreplied.threads:
47789
48212
  * Use labels like `unreplied`, `replied`, `escalated`, and `resolved` to track conversation state
47790
48213
  * Always reply to the **last message** in a thread to keep email headers correct
47791
48214
 
47792
-
47793
48215
  ***
47794
48216
 
47795
48217
  title: How do I build a human-in-the-loop workflow?
47796
48218
  subtitle: Keep humans in control of your agent's email communications.
47797
48219
  slug: knowledge-base/human-in-the-loop
47798
- --------------------------------------
48220
+ ---------------------
48221
+
48222
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47799
48223
 
47800
48224
  AgentMail provides several mechanisms for keeping humans involved when agents send emails. You can combine these approaches to match the level of oversight your workflow requires.
47801
48225
 
@@ -47895,13 +48319,14 @@ This acts as a hard safety boundary. Your agent can only email recipients you ha
47895
48319
  * **Use labels consistently** across your agents so dashboards and alerting work reliably
47896
48320
  * **Combine approaches:** for example, use allowlists for autonomous sending to known recipients, drafts for unknown recipients, and CC a human on everything during the first week
47897
48321
 
47898
-
47899
48322
  ***
47900
48323
 
47901
48324
  title: How do I use Pods for multi-tenant email?
47902
- subtitle: 'Isolate inboxes, domains, and data across tenants with Pods.'
48325
+ subtitle: Isolate inboxes, domains, and data across tenants with Pods.
47903
48326
  slug: knowledge-base/pods-multi-tenant
47904
- --------------------------------------
48327
+ ---------------------
48328
+
48329
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
47905
48330
 
47906
48331
  Pods provide tenant isolation for multi-tenant applications. Each Pod is an isolated workspace containing its own inboxes, domains, threads, and drafts, completely separated from other Pods.
47907
48332
 
@@ -48015,13 +48440,14 @@ client.pods.delete(pod_id=pod.pod_id)
48015
48440
 
48016
48441
  For more details, see the [Pods core concept](/pods) documentation.
48017
48442
 
48018
-
48019
48443
  ***
48020
48444
 
48021
48445
  title: How do I use labels to track email state?
48022
48446
  subtitle: Use labels to manage agent workflow state on emails and threads.
48023
48447
  slug: knowledge-base/labels-track-state
48024
- ---------------------------------------
48448
+ ---------------------
48449
+
48450
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48025
48451
 
48026
48452
  Labels are string-based tags you attach to messages and threads. They are the primary way agents track state, classify emails, and filter conversations in AgentMail.
48027
48453
 
@@ -48149,13 +48575,14 @@ for thread_item in unreplied.threads:
48149
48575
 
48150
48576
  For more details, see the [Labels core concept](/labels) documentation.
48151
48577
 
48152
-
48153
48578
  ***
48154
48579
 
48155
48580
  title: How do I set up a custom domain?
48156
48581
  subtitle: Send emails from your own domain instead of @agentmail.to.
48157
48582
  slug: knowledge-base/custom-domain-setup
48158
- ----------------------------------------
48583
+ ---------------------
48584
+
48585
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48159
48586
 
48160
48587
  Custom domains let your agent send emails from your brand (e.g., `agent@yourcompany.com`) instead of the default `@agentmail.to`. This improves deliverability and builds trust with recipients.
48161
48588
 
@@ -48247,13 +48674,14 @@ console.log(`Created: ${inbox.inboxId}`);
48247
48674
  * **One SPF record per domain:** if you already have an SPF record, merge AgentMail's `include:` into the existing record rather than creating a second one
48248
48675
  For a detailed walkthrough, see the [Creating Custom Domains](/custom-domains) guide.
48249
48676
 
48250
-
48251
48677
  ***
48252
48678
 
48253
- title: 'How do I set up SPF, DKIM, and DMARC?'
48679
+ title: How do I set up SPF, DKIM, and DMARC?
48254
48680
  subtitle: Authenticate your domain for reliable email deliverability.
48255
48681
  slug: knowledge-base/spf-dkim-dmarc
48256
- -----------------------------------
48682
+ ---------------------
48683
+
48684
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48257
48685
 
48258
48686
  SPF, DKIM, and DMARC are three email authentication protocols that prove your emails are legitimate. They are essential for deliverability: Gmail, Outlook, and other major providers now require all three for reliable inbox placement.
48259
48687
 
@@ -48344,13 +48772,14 @@ For step-by-step DNS instructions, see our provider guides: [Cloudflare](/knowle
48344
48772
 
48345
48773
  For a deeper explanation of how these protocols work, see the [SPF, DKIM, DMARC](/email-protocols) documentation.
48346
48774
 
48347
-
48348
48775
  ***
48349
48776
 
48350
48777
  title: Why are my emails going to spam?
48351
48778
  subtitle: Troubleshoot and fix spam folder placement issues.
48352
48779
  slug: knowledge-base/emails-going-to-spam
48353
- -----------------------------------------
48780
+ ---------------------
48781
+
48782
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48354
48783
 
48355
48784
  If your agent's emails are landing in spam instead of the inbox, work through these common causes in order. The most frequent issues are at the top.
48356
48785
 
@@ -48415,13 +48844,14 @@ If you have checked all of the above and emails are still going to spam, reach o
48415
48844
 
48416
48845
  For a comprehensive guide to maximizing deliverability, see the [Email Deliverability](/email-deliverability) best practices.
48417
48846
 
48418
-
48419
48847
  ***
48420
48848
 
48421
48849
  title: Warming Up
48422
48850
  subtitle: Gradually build sending reputation on a new domain or inbox.
48423
48851
  slug: knowledge-base/domain-warming
48424
- -----------------------------------
48852
+ ---------------------
48853
+
48854
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48425
48855
 
48426
48856
  Warming up is the process of gradually increasing your email volume on a new domain to build sender reputation with mailbox providers like Gmail, Outlook, and Yahoo.
48427
48857
  You can connect AgentMail inboxes to Instantly and Smartlead for programmatic warm up using [SMTP credentials](https://docs.agentmail.to/imap-smtp#finding-your-credentials).
@@ -48496,13 +48926,14 @@ You can track bounces and complaints by using [Query Metrics](https://docs.agent
48496
48926
 
48497
48927
  For more deliverability best practices, see the [Email Deliverability](/email-deliverability) guide.
48498
48928
 
48499
-
48500
48929
  ***
48501
48930
 
48502
48931
  title: How do I avoid MX record conflicts?
48503
48932
  subtitle: Add AgentMail DNS records without breaking existing email.
48504
48933
  slug: knowledge-base/mx-record-conflicts
48505
- ----------------------------------------
48934
+ ---------------------
48935
+
48936
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48506
48937
 
48507
48938
  If you already use Gmail, Outlook, or another email provider for your domain, adding AgentMail's MX records could conflict with your existing setup. Here is how to avoid that.
48508
48939
 
@@ -48579,13 +49010,14 @@ Your team's email continues to flow through Gmail. Agent emails go through Agent
48579
49010
 
48580
49011
  Pick whatever makes sense for your brand. The important thing is that it is a separate subdomain from your root domain's email.
48581
49012
 
48582
-
48583
49013
  ***
48584
49014
 
48585
49015
  title: What does a 403 error mean?
48586
49016
  subtitle: Common causes of API 403 Forbidden errors and how to fix them.
48587
49017
  slug: knowledge-base/api-403-error
48588
- ----------------------------------
49018
+ ---------------------
49019
+
49020
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48589
49021
 
48590
49022
  A `403 Forbidden` response from the AgentMail API means your request was rejected. This can happen for several reasons, and the fix depends on the cause.
48591
49023
 
@@ -48647,13 +49079,14 @@ If you get a `200` response, your key is valid and working. You can then copy th
48647
49079
 
48648
49080
  If none of the above resolves your issue, reach out in our [Discord](https://discord.com/invite/hTYatWYWBc) support channel or email [support@agentmail.cc](mailto:support@agentmail.cc) with the full error response and the endpoint you are calling.
48649
49081
 
48650
-
48651
49082
  ***
48652
49083
 
48653
49084
  title: What are the rate limits?
48654
49085
  subtitle: Understand AgentMail's rate limits and how to work within them.
48655
49086
  slug: knowledge-base/rate-limits
48656
- --------------------------------
49087
+ ---------------------
49088
+
49089
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48657
49090
 
48658
49091
  AgentMail is built for high-volume agent workflows. Limits vary by plan.
48659
49092
 
@@ -48707,13 +49140,14 @@ async function sendWithRetry(inboxId: string, params: any, maxRetries = 3) {
48707
49140
 
48708
49141
  If you need higher sending volumes or more inboxes than your current plan allows, contact [support@agentmail.cc](mailto:support@agentmail.cc) or visit the [pricing page](https://agentmail.to/pricing) for enterprise options.
48709
49142
 
48710
-
48711
49143
  ***
48712
49144
 
48713
49145
  title: How do I prevent duplicate sends?
48714
49146
  subtitle: Use idempotency to avoid sending the same email twice.
48715
49147
  slug: knowledge-base/preventing-duplicate-sends
48716
- -----------------------------------------------
49148
+ ---------------------
49149
+
49150
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48717
49151
 
48718
49152
  AI agents can sometimes retry requests due to network errors, timeouts, or logic bugs. Without safeguards, this can cause the same email to be sent multiple times. Here is how to prevent that.
48719
49153
 
@@ -48802,13 +49236,14 @@ Since drafts support `clientId`, creating the same draft multiple times is safe.
48802
49236
 
48803
49237
  For more details, see the [Idempotent Requests](/idempotency) guide.
48804
49238
 
48805
-
48806
49239
  ***
48807
49240
 
48808
49241
  title: Why is my domain not verifying?
48809
49242
  subtitle: What to do when your domain verification is stuck.
48810
49243
  slug: knowledge-base/domain-not-verifying
48811
- -----------------------------------------
49244
+ ---------------------
49245
+
49246
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48812
49247
 
48813
49248
  If your domain is stuck in a pending or failed verification state, work through these common causes.
48814
49249
 
@@ -48880,13 +49315,14 @@ You can check your domain's status in the [AgentMail Console](https://console.ag
48880
49315
 
48881
49316
  If you have checked all of the above and your domain is still not verifying, email [support@agentmail.cc](mailto:support@agentmail.cc) with your domain name and a screenshot of your DNS records. We can help diagnose the issue.
48882
49317
 
48883
-
48884
49318
  ***
48885
49319
 
48886
49320
  title: Why are my emails bouncing?
48887
49321
  subtitle: Diagnose and resolve email bounce issues.
48888
49322
  slug: knowledge-base/emails-bouncing
48889
- ------------------------------------
49323
+ ---------------------
49324
+
49325
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48890
49326
 
48891
49327
  A bounced email means the recipient's mail server rejected your message. Understanding the bounce type helps you take the right action.
48892
49328
 
@@ -48971,13 +49407,107 @@ await client.webhooks.create({
48971
49407
 
48972
49408
  For more on maintaining healthy sending metrics, see the [Email Deliverability](/email-deliverability) best practices.
48973
49409
 
49410
+ ***
49411
+
49412
+ title: Why are my emails not showing up?
49413
+ subtitle: The most common reason inbound emails go missing is that the sender's domain isn't authenticated.
49414
+ slug: knowledge-base/inbound-emails-missing
49415
+ ---------------------
49416
+
49417
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
49418
+
49419
+ <Warning>
49420
+ **The sender's domain must have SPF or DKIM configured.** To reduce spoofing and phishing, AgentMail now drops inbound emails when the sender's domain has neither SPF nor DKIM set up. If a sender reports that their email never arrived, this is the most likely cause — once they configure SPF/DKIM on their domain, their emails will start landing in your inbox again.
49421
+ </Warning>
49422
+
49423
+ AgentMail verifies every inbound email using SPF, DKIM, and DMARC authentication before delivering it to your inbox. Emails that fail any of these checks are dropped to prevent spoofing, phishing, and spam from reaching your agents.
49424
+
49425
+ This is the same standard enforced by Gmail, Outlook, Yahoo, and other major email providers.
49426
+
49427
+ ## How inbound authentication works
49428
+
49429
+ When an email arrives, AgentMail inspects the SPF, DKIM, and DMARC verdicts provided by the receiving mail server. To be delivered, an email must meet **all** of the following conditions:
49430
+
49431
+ * Neither SPF nor DKIM returns a `FAIL` verdict
49432
+ * At least one of SPF or DKIM is configured (not both `GRAY`)
49433
+ * DMARC does not return `FAIL` (unless the sender's DMARC policy is `none`)
49434
+ * The message passes virus scanning
49435
+
49436
+ If any check fails, the email is dropped.
49437
+
49438
+ | Scenario | SPF | DKIM | Result |
49439
+ | ------------------------------ | ---- | ---- | --------- |
49440
+ | Both pass | PASS | PASS | Delivered |
49441
+ | One passes, other unconfigured | PASS | GRAY | Delivered |
49442
+ | One passes, other unconfigured | GRAY | PASS | Delivered |
49443
+ | Neither configured | GRAY | GRAY | Dropped |
49444
+ | Either explicitly fails | FAIL | any | Dropped |
49445
+ | Either explicitly fails | any | FAIL | Dropped |
49446
+
49447
+ <Warning>
49448
+ Emails dropped due to failed authentication are **silently rejected**. The sender's mail server may still report successful delivery because AgentMail's servers did receive the message, but it was rejected during authentication verification. The sender gets no bounce-back or error notification.
49449
+ </Warning>
49450
+
49451
+ ## Why this matters
49452
+
49453
+ Without these checks, anyone could send emails claiming to be from any domain. SPF and DKIM authentication proves that the sending server is authorized to send on behalf of the domain in the `From` address, while DMARC ties those results to the domain's published policy. Dropping unauthenticated emails protects your agents from:
49454
+
49455
+ * **Spoofing:** forged sender addresses impersonating trusted contacts
49456
+ * **Phishing:** malicious emails designed to trick your agent into taking harmful actions
49457
+ * **Spam:** bulk unsolicited email from unverified sources
49458
+
49459
+ ## Diagnosing missing emails
49460
+
49461
+ If a sender reports that their email never arrived, check whether their domain has SPF and DKIM records configured:
49462
+
49463
+ ```bash
49464
+ # check for SPF record
49465
+ dig TXT example.com +short
49466
+ # look for a record starting with "v=spf1"
49467
+ ```
49468
+
49469
+ For DKIM, use [MXToolbox DKIM Lookup](https://mxtoolbox.com/dkim.aspx) or a similar tool. DKIM records are stored under a selector-specific subdomain (e.g., `google._domainkey.example.com`), and the selector name varies by email provider, so there is no single DNS query that covers all cases.
49470
+
49471
+ You can also use [MXToolbox SPF Lookup](https://mxtoolbox.com/spf.aspx) to verify SPF records online.
49472
+
49473
+ If the domain has neither an SPF record nor a DKIM record, that is the cause. Emails from that domain will be dropped by AgentMail and likely by other providers as well.
49474
+
49475
+ ## What to tell the sender
49476
+
49477
+ The sender needs to configure SPF and/or DKIM on their domain's DNS. This is not something you can fix on the AgentMail side, as the records must be set up by the domain owner.
49478
+
49479
+ * Add an SPF record to authorize their mail server (e.g., `v=spf1 include:_spf.google.com ~all` for Google Workspace)
49480
+ * Enable DKIM signing through their email provider's admin console
49481
+ * Consider adding a DMARC record for full authentication coverage
49482
+
49483
+ Most email providers have setup guides: [Google Workspace](https://support.google.com/a/answer/33786), [Microsoft 365](https://learn.microsoft.com/en-us/microsoft-365/security/office-365-security/email-authentication-spf-configure), [Amazon SES](https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-spf.html).
49484
+
49485
+ ## Google Workspace and internal routing
49486
+
49487
+ If the sender uses Google Workspace and the AgentMail inbox is on a subdomain of a Google Workspace domain, Google may route the email internally instead of sending it through external MX records. In this case, the email never reaches AgentMail's servers at all.
49488
+
49489
+ For example, if the Google Workspace domain is `yourcompany.com` and the AgentMail inbox is on `agents.yourcompany.com`, Google Workspace may intercept emails to `agents.yourcompany.com` and deliver them internally.
49490
+
49491
+ **How to fix:** In Google Admin Console, go to **Apps > Google Workspace > Gmail > Routing** and add a routing rule that sends mail for the AgentMail subdomain to the external MX records instead of handling it internally.
49492
+
49493
+ ## Still not receiving emails?
49494
+
49495
+ If the sender's domain does have SPF/DKIM configured and emails are still not arriving:
49496
+
49497
+ * Verify your domain's MX records are correctly pointing to AgentMail (see [MX record conflicts](/knowledge-base/mx-record-conflicts))
49498
+ * Check that your domain is fully verified in the [AgentMail Console](https://console.agentmail.to)
49499
+ * Make sure you are listening for incoming emails via [webhooks or WebSockets](/knowledge-base/handling-inbound-emails)
49500
+
49501
+ If none of the above resolves the issue, reach out in our [Discord](https://discord.com/invite/hTYatWYWBc) support channel or email [support@agentmail.cc](mailto:support@agentmail.cc).
48974
49502
 
48975
49503
  ***
48976
49504
 
48977
- title: 'DNS Guide: Cloudflare'
49505
+ title: DNS Guide: Cloudflare
48978
49506
  subtitle: Step-by-step instructions for adding AgentMail DNS records in Cloudflare.
48979
49507
  slug: knowledge-base/dns-cloudflare
48980
- -----------------------------------
49508
+ ---------------------
49509
+
49510
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
48981
49511
 
48982
49512
  ## Steps
48983
49513
 
@@ -49045,13 +49575,14 @@ Cloudflare DNS typically propagates within **1 to 5 minutes**, making it one of
49045
49575
 
49046
49576
  * **Name field auto-strips domain:** Cloudflare removes the domain portion from the Name field automatically. If your DKIM selector is `agentmail._domainkey`, enter just that. Do not enter `agentmail._domainkey.yourdomain.com`, or the record will be created incorrectly.
49047
49577
 
49048
-
49049
49578
  ***
49050
49579
 
49051
- title: 'DNS Guide: GoDaddy'
49580
+ title: DNS Guide: GoDaddy
49052
49581
  subtitle: Step-by-step instructions for adding AgentMail DNS records in GoDaddy.
49053
49582
  slug: knowledge-base/dns-godaddy
49054
- --------------------------------
49583
+ ---------------------
49584
+
49585
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
49055
49586
 
49056
49587
  ## Steps
49057
49588
 
@@ -49116,13 +49647,14 @@ GoDaddy DNS typically propagates within **15 to 30 minutes**, but it can occasio
49116
49647
 
49117
49648
  * **Parked domain or forwarding:** If your domain is parked or has forwarding enabled, GoDaddy may override your MX records. Disable parking and forwarding before setting up email receiving.
49118
49649
 
49119
-
49120
49650
  ***
49121
49651
 
49122
- title: 'DNS Guide: Route 53 (AWS)'
49652
+ title: DNS Guide: Route 53 (AWS)
49123
49653
  subtitle: Step-by-step instructions for adding AgentMail DNS records in AWS Route 53.
49124
49654
  slug: knowledge-base/dns-route53
49125
- --------------------------------
49655
+ ---------------------
49656
+
49657
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
49126
49658
 
49127
49659
  ## Steps
49128
49660
 
@@ -49190,13 +49722,32 @@ Route 53 name servers typically pick up changes within **60 seconds**, but full
49190
49722
 
49191
49723
  * **Multiple values in one record:** Route 53 lets you add multiple values to a single record. If you need to add a second MX entry, add it as a new line in the same MX record rather than creating a separate record.
49192
49724
 
49725
+ * **DKIM TXT record too long (CharacterStringTooLong error):** If your DKIM record is provided as a TXT value (rather than a CNAME), the DKIM public key is often longer than the 255-character limit that Route 53 enforces per string segment. You will see an error like `CharacterStringTooLong (Value is too long)`. To fix this, split the value into two quoted strings within a single record. The split point should be near the middle of the `p=` value. The two quoted strings must have **no space and no line break** between the closing and opening quotes. For example:
49726
+
49727
+ ```
49728
+ "v=DKIM1; k=rsa; p=MIIBIjANBgkqhki...firsthalf""secondhalf...wIDAQAB"
49729
+ ```
49730
+
49731
+ In Route 53, paste the entire value (both quoted strings) into the **Value** field as a single entry. If Route 53 shows two separate copy-pastable values instead of one, there is likely a space or line break between the two strings. Remove it so the closing `"` and opening `"` are directly adjacent (`""`).
49732
+
49733
+ **Incorrect:** A space or line break between the two quoted strings causes Route 53 to treat them as separate values.
49734
+
49735
+ <img src="https://files.buildwithfern.com/https://agentmail-production.docs.buildwithfern.com/5145d22514b03251934e96ef49b78f8ca79e6b20bfa7ec5065a343ac547338e9/assets/route53-dkim-incorrect.png" alt="Incorrect Route 53 DKIM configuration with space between quoted strings" />
49736
+
49737
+ **Correct:** The two quoted strings are directly adjacent with no space, producing a single value in Route 53.
49738
+
49739
+ <img src="https://files.buildwithfern.com/https://agentmail-production.docs.buildwithfern.com/d67b72b3e23c286ef81bb101c57098bab684785fca4bf3791fd7f0fffe864740/assets/route53-dkim-correct.png" alt="Correct Route 53 DKIM configuration with no space between quoted strings" />
49740
+
49741
+ You can also use the AWS CLI to add the record, which handles multi-string TXT values more reliably.
49193
49742
 
49194
49743
  ***
49195
49744
 
49196
- title: 'DNS Guide: Namecheap'
49745
+ title: DNS Guide: Namecheap
49197
49746
  subtitle: Step-by-step instructions for adding AgentMail DNS records in Namecheap.
49198
49747
  slug: knowledge-base/dns-namecheap
49199
- ----------------------------------
49748
+ ---------------------
49749
+
49750
+ For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
49200
49751
 
49201
49752
  ## Steps
49202
49753
 
@@ -49263,4 +49814,3 @@ Namecheap DNS typically propagates within **15 to 30 minutes**, but in some case
49263
49814
 
49264
49815
  * **Propagation delays:** Unlike some providers, Namecheap propagation can take 15 to 30 minutes. If verification fails, wait and retry before troubleshooting further.
49265
49816
 
49266
-