agentmail 0.5.35 → 0.5.37

package/dist/esm/serialization/resources/apps/types/App.mjs

@@ -1,13 +1,16 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../../../core/index.mjs";
+import { AppCategory } from "./AppCategory.mjs";
 import { AppId } from "./AppId.mjs";
 export const App = core.serialization.object({
     appId: core.serialization.property("app_id", AppId),
+    slug: core.serialization.string().optional(),
     name: core.serialization.string().optional(),
     updatedAt: core.serialization.property("updated_at", core.serialization.date().optional()),
     description: core.serialization.string().optional(),
     logoUrl: core.serialization.property("logo_url", core.serialization.string().optional()),
     termsUrl: core.serialization.property("terms_url", core.serialization.string().optional()),
     privacyUrl: core.serialization.property("privacy_url", core.serialization.string().optional()),
+    categories: core.serialization.list(AppCategory).optional(),
     ownerSignupLimit: core.serialization.property("owner_signup_limit", core.serialization.number().optional()),
 });

package/dist/esm/serialization/resources/apps/types/AppCategory.d.mts

@@ -0,0 +1,7 @@
+import type * as AgentMail from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+export declare const AppCategory: core.serialization.Schema<serializers.AppCategory.Raw, AgentMail.AppCategory>;
+export declare namespace AppCategory {
+    type Raw = "ai" | "search" | "scraping" | "browser" | "data" | "developer-tools" | "communication" | "productivity" | "payments" | "finance" | "commerce" | "marketing" | "analytics" | "security" | "infrastructure" | "other";
+}

package/dist/esm/serialization/resources/apps/types/AppCategory.mjs

@@ -0,0 +1,20 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+export const AppCategory = core.serialization.enum_([
+    "ai",
+    "search",
+    "scraping",
+    "browser",
+    "data",
+    "developer-tools",
+    "communication",
+    "productivity",
+    "payments",
+    "finance",
+    "commerce",
+    "marketing",
+    "analytics",
+    "security",
+    "infrastructure",
+    "other",
+]);

package/dist/esm/serialization/resources/apps/types/index.d.mts

@@ -1,4 +1,5 @@
 export * from "./App.mjs";
+export * from "./AppCategory.mjs";
 export * from "./AppId.mjs";
 export * from "./ConnectAccepted.mjs";
 export * from "./ConnectAppBody.mjs";

package/dist/esm/serialization/resources/apps/types/index.mjs

@@ -1,4 +1,5 @@
 export * from "./App.mjs";
+export * from "./AppCategory.mjs";
 export * from "./AppId.mjs";
 export * from "./ConnectAccepted.mjs";
 export * from "./ConnectAppBody.mjs";

package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.d.mts

@@ -3,6 +3,7 @@ import * as core from "../../../../core/index.mjs";
 import type * as serializers from "../../../index.mjs";
 import { ClientId } from "./ClientId.mjs";
 import { DisplayName } from "./DisplayName.mjs";
+import { InboxStatus } from "./InboxStatus.mjs";
 import { Metadata } from "./Metadata.mjs";
 export declare const CreateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.CreateInboxRequest.Raw, AgentMail.inboxes.CreateInboxRequest>;
 export declare namespace CreateInboxRequest {
@@ -11,6 +12,7 @@ export declare namespace CreateInboxRequest {
         domain?: string | null;
         display_name?: DisplayName.Raw | null;
         client_id?: ClientId.Raw | null;
+        status?: InboxStatus.Raw | null;
         metadata?: Metadata.Raw | null;
     }
 }

package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.mjs

@@ -2,11 +2,13 @@
 import * as core from "../../../../core/index.mjs";
 import { ClientId } from "./ClientId.mjs";
 import { DisplayName } from "./DisplayName.mjs";
+import { InboxStatus } from "./InboxStatus.mjs";
 import { Metadata } from "./Metadata.mjs";
 export const CreateInboxRequest = core.serialization.object({
     username: core.serialization.string().optional(),
     domain: core.serialization.string().optional(),
     displayName: core.serialization.property("display_name", DisplayName.optional()),
     clientId: core.serialization.property("client_id", ClientId.optional()),
+    status: InboxStatus.optional(),
     metadata: Metadata.optional(),
 });

package/dist/esm/serialization/resources/inboxes/types/Inbox.d.mts

@@ -6,6 +6,7 @@ import { ClientId } from "./ClientId.mjs";
 import { DisplayName } from "./DisplayName.mjs";
 import { Email } from "./Email.mjs";
 import { InboxId } from "./InboxId.mjs";
+import { InboxStatus } from "./InboxStatus.mjs";
 import { Metadata } from "./Metadata.mjs";
 export declare const Inbox: core.serialization.ObjectSchema<serializers.inboxes.Inbox.Raw, AgentMail.inboxes.Inbox>;
 export declare namespace Inbox {
@@ -15,6 +16,7 @@ export declare namespace Inbox {
         email: Email.Raw;
         display_name?: DisplayName.Raw | null;
         client_id?: ClientId.Raw | null;
+        status?: InboxStatus.Raw | null;
         metadata?: Metadata.Raw | null;
         updated_at: string;
         created_at: string;

package/dist/esm/serialization/resources/inboxes/types/Inbox.mjs

@@ -5,6 +5,7 @@ import { ClientId } from "./ClientId.mjs";
 import { DisplayName } from "./DisplayName.mjs";
 import { Email } from "./Email.mjs";
 import { InboxId } from "./InboxId.mjs";
+import { InboxStatus } from "./InboxStatus.mjs";
 import { Metadata } from "./Metadata.mjs";
 export const Inbox = core.serialization.object({
     podId: core.serialization.property("pod_id", PodId),
@@ -12,6 +13,7 @@ export const Inbox = core.serialization.object({
     email: Email,
     displayName: core.serialization.property("display_name", DisplayName.optional()),
     clientId: core.serialization.property("client_id", ClientId.optional()),
+    status: InboxStatus.optional(),
     metadata: Metadata.optional(),
     updatedAt: core.serialization.property("updated_at", core.serialization.date()),
     createdAt: core.serialization.property("created_at", core.serialization.date()),

package/dist/esm/serialization/resources/inboxes/types/InboxStatus.d.mts

@@ -0,0 +1,7 @@
+import type * as AgentMail from "../../../../api/index.mjs";
+import * as core from "../../../../core/index.mjs";
+import type * as serializers from "../../../index.mjs";
+export declare const InboxStatus: core.serialization.Schema<serializers.inboxes.InboxStatus.Raw, AgentMail.inboxes.InboxStatus>;
+export declare namespace InboxStatus {
+    type Raw = "active" | "paused";
+}

package/dist/esm/serialization/resources/inboxes/types/InboxStatus.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../../../../core/index.mjs";
+export const InboxStatus = core.serialization.enum_(["active", "paused"]);

package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.d.mts

@@ -2,11 +2,13 @@ import type * as AgentMail from "../../../../api/index.mjs";
 import * as core from "../../../../core/index.mjs";
 import type * as serializers from "../../../index.mjs";
 import { DisplayName } from "./DisplayName.mjs";
+import { InboxStatus } from "./InboxStatus.mjs";
 import { UpdateMetadata } from "./UpdateMetadata.mjs";
 export declare const UpdateInboxRequest: core.serialization.ObjectSchema<serializers.inboxes.UpdateInboxRequest.Raw, AgentMail.inboxes.UpdateInboxRequest>;
 export declare namespace UpdateInboxRequest {
     interface Raw {
         display_name?: DisplayName.Raw | null;
+        status?: InboxStatus.Raw | null;
         metadata?: (UpdateMetadata.Raw | null | undefined) | null;
     }
 }

package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.mjs

@@ -1,8 +1,10 @@
 // This file was auto-generated by Fern from our API Definition.
 import * as core from "../../../../core/index.mjs";
 import { DisplayName } from "./DisplayName.mjs";
+import { InboxStatus } from "./InboxStatus.mjs";
 import { UpdateMetadata } from "./UpdateMetadata.mjs";
 export const UpdateInboxRequest = core.serialization.object({
     displayName: core.serialization.property("display_name", DisplayName.optional()),
+    status: InboxStatus.optional(),
     metadata: UpdateMetadata.optionalNullable(),
 });

package/dist/esm/serialization/resources/inboxes/types/index.d.mts

@@ -6,6 +6,7 @@ export * from "./DisplayName.mjs";
 export * from "./Email.mjs";
 export * from "./Inbox.mjs";
 export * from "./InboxId.mjs";
+export * from "./InboxStatus.mjs";
 export * from "./ListInboxesResponse.mjs";
 export * from "./Metadata.mjs";
 export * from "./MetadataValue.mjs";

package/dist/esm/serialization/resources/inboxes/types/index.mjs

@@ -6,6 +6,7 @@ export * from "./DisplayName.mjs";
 export * from "./Email.mjs";
 export * from "./Inbox.mjs";
 export * from "./InboxId.mjs";
+export * from "./InboxStatus.mjs";
 export * from "./ListInboxesResponse.mjs";
 export * from "./Metadata.mjs";
 export * from "./MetadataValue.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.5.35";
+export declare const SDK_VERSION = "0.5.37";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.5.35";
+export const SDK_VERSION = "0.5.37";

package/dist/llms.txt

@@ -1,6 +1,6 @@
 # AgentMail | Documentation
 
-> AgentMail is an email API built for AI agents. Create inboxes, send and receive messages, manage threads, and handle webhooks programmatically.
+> AgentMail is the first email provider built for AI agents. Create inboxes, send and receive messages, manage threads, and handle webhooks programmatically. Free tier, no credit card required.
 
 ## Instructions for AI Agents
 
@@ -71,8 +71,10 @@
 - [Knowledge Base](https://docs.agentmail.to/knowledge-base.md): A collection of answers to frequently asked questions.
 - [What is AgentMail and how is it different?](https://docs.agentmail.to/knowledge-base/what-is-agentmail.md): Understand how AgentMail compares to traditional email providers.
 - [What can I do with an AgentMail inbox?](https://docs.agentmail.to/knowledge-base/inbox-capabilities.md): A complete overview of inbox capabilities for AI agents.
+- [Can I set a profile picture for my inbox?](https://docs.agentmail.to/knowledge-base/inbox-profile-pictures.md): Learn how to associate a Google profile picture with an AgentMail address, how BIMI logos differ, and when Gmail requires a VMC or CMC certificate.
 - [How do I create my first inbox?](https://docs.agentmail.to/knowledge-base/creating-first-inbox.md): Get up and running with your first AgentMail inbox.
 - [How do I get my API key?](https://docs.agentmail.to/knowledge-base/getting-api-key.md): Create and manage your AgentMail API keys.
+- [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox.md): Take ownership of an inbox your agent created without your email.
 - [How do I handle inbound emails with my agent?](https://docs.agentmail.to/knowledge-base/handling-inbound-emails.md): Compare Webhooks and WebSockets for processing incoming emails.
 - [How do I set up allowlists and blocklists?](https://docs.agentmail.to/knowledge-base/allowlists-blocklists.md): Control who your AI agent can send to and receive from.
 - [How do I manage threaded conversations?](https://docs.agentmail.to/knowledge-base/threaded-conversations.md): Maintain context across multi-turn email conversations with your agent.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "agentmail",
-    "version": "0.5.35",
+    "version": "0.5.37",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -284,6 +284,9 @@ await client.inboxes.create(undefined);
 ```bash
 agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"
 ```
+
+To pause an inbox, set `status` to `paused`; set it back to `active` to
+resume. See [Pausing an inbox](/inboxes#pausing-an-inbox).
 </dd>
 </dl>
 </dd>
@@ -1465,7 +1468,7 @@ Create a new agent organization with an inbox and API key. This endpoint is for
 
 A 6-digit OTP is sent to the human's email for verification.
 
-`human_email` is optional. Without it, the inbox can receive email but cannot send to anyone until a human is attached with the attach human endpoint. There is also no way to recover the API key, so store it durably. Calling sign-up again without `human_email` creates a new organization, which needs a different `username`: the original username stays with the lost organization's inbox.
+`human_email` is optional. Without it, the inbox can receive email but cannot send to anyone until a human is attached with the attach human endpoint or, for a US-region inbox, claims it in the AgentMail Console with the API key (see [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox)). There is also no way to recover the API key, so store it durably. Calling sign-up again without `human_email` creates a new organization, which needs a different `username`: the original username stays with the lost organization's inbox.
 
 This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
 
@@ -2166,10 +2169,11 @@ await client.apps.search({
 <dl>
 <dd>
 
-Gets one app by ID. An app in the catalog returns its full entry.
+Gets one app by ID or slug. A catalog app returns its full entry.
 A registered app that the catalog does not list returns its ID and
 name only, without `updated_at`, so anyone holding its ID can still look
-it up. List Apps and Search Apps show catalog entries only.
+it up; a slug finds catalog apps only. List Apps and Search Apps show
+catalog entries only.
 </dd>
 </dl>
 </dd>
@@ -2184,7 +2188,7 @@ it up. List Apps and Search Apps show catalog entries only.
 <dd>
 
 ```typescript
-await client.apps.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
+await client.apps.get("app_id");
 
 ```
 </dd>
@@ -2200,7 +2204,7 @@ await client.apps.get("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
 <dl>
 <dd>
 
-**app_id:** `AgentMail.AppId` 
+**app_id:** `string` — ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
     
 </dd>
 </dl>
@@ -2247,7 +2251,7 @@ Lists accounts at one app, most recent sign-in first.
 <dd>
 
 ```typescript
-await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
+await client.apps.listAccounts("app_id");
 
 ```
 </dd>
@@ -2263,7 +2267,7 @@ await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
 <dl>
 <dd>
 
-**app_id:** `AgentMail.AppId` 
+**app_id:** `string` — ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
     
 </dd>
 </dl>
@@ -2306,6 +2310,8 @@ await client.apps.listAccounts("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
 Starts signing an inbox in to an app. Returns a single-use `magic_url`,
 valid for five minutes, to open in the client that will hold the sign-in;
 the client enrolls as the inbox and continues to the app.
+An app in the catalog can be named by its `slug`, as in
+`POST /v0/apps/firecrawl/connect`.
 A `404` names the missing resource: `App` or `Inbox`.
 A `403` `AppSignupLimitError` means the app accepts no more sign-ups from
 your organization; sign in with an inbox that already has an account there.
@@ -2323,7 +2329,7 @@ your organization; sign in with an inbox that already has an account there.
 <dd>
 
 ```typescript
-await client.apps.connect("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", undefined);
+await client.apps.connect("app_id", undefined);
 
 ```
 </dd>
@@ -2339,7 +2345,7 @@ await client.apps.connect("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", undefined);
 <dl>
 <dd>
 
-**app_id:** `AgentMail.AppId` 
+**app_id:** `string` — ID of app, or the `slug` of an app in the catalog. A slug ignores case, spaces and punctuation.
     
 </dd>
 </dl>