Agentmail

https://github.com/agentmail-to/agentmail-node
Admin
Agentmail is a TypeScript SDK that provides convenient access to the Agentmail APIs for managing...
Tokens:62,559
Snippets:717
Trust Score:6.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Project Dependencies

Source: https://github.com/agentmail-to/agentmail-node/blob/main/CONTRIBUTING.md

Install the project dependencies using pnpm.

```bash
pnpm install
```

--------------------------------

### Complete event stream integration example

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/11-events-api.md

A full implementation example showing client initialization, stream connection, event handling, and graceful shutdown.

```typescript
const client = new AgentMailClient({
    apiKey: "sk_...",
    logging: {
        level: logging.LogLevel.Info,
        silent: false
    }
});

// Connect to inbox event stream
const stream = await client.inboxes.events.connect("inbox_test_123");

// Wait for ready
await stream.ready();

// Listen for incoming messages
stream.on("message:created", (event) => {
    console.log("📧 New message");
    console.log("From:", event.message.from);
    console.log("Subject:", event.message.subject);
    console.log("Time:", event.timestamp);
});

// Listen for thread updates
stream.on("thread:updated", (event) => {
    console.log("🔄 Thread updated");
    console.log("New labels:", event.labels);
});

// Listen for deletions
stream.on("message:deleted", (event) => {
    console.log("🗑️ Message deleted:", event.messageId);
});

// Graceful shutdown
process.on("SIGTERM", () => {
    console.log("Closing stream...");
    stream.close(1000, "Server shutdown");
});
```

--------------------------------

### List Messages Usage Examples

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/03-messages-api.md

Examples demonstrating how to list messages with filters such as sender, date range, and folder inclusion.

```typescript
const client = new AgentMailClient({ apiKey: "sk_..." });

// List recent messages
const result = await client.inboxes.messages.list("inbox_test_123", {
    limit: 25
});
console.log(result.messages);

// Filter by sender
const fromAlex = await client.inboxes.messages.list("inbox_test_123", {
    from: "alex@example.com"
});

// Filter by date range
const recent = await client.inboxes.messages.list("inbox_test_123", {
    after: "2024-01-01T00:00:00Z",
    before: "2024-01-31T23:59:59Z"
});

// Exclude spam
const inbox = await client.inboxes.messages.list("inbox_test_123", {
    includeSpam: false,
    includeBlocked: false,
    includeTrash: false
});
```

--------------------------------

### Usage of ready method

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Example of waiting for the connection to be established before listening for events.

```typescript
const socket = await client.websockets.connect();

// Wait for ready
await socket.ready();
console.log("Connection established");

// Now you can listen for events
socket.on("message:created", (event) => {
    console.log("Message:", event);
});
```

--------------------------------

### List threads usage example

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/04-threads-api.md

Example of listing threads with a specified limit.

```typescript
// List all threads across organization
const result = await client.threads.list({ limit: 50 });
```

--------------------------------

### Search Messages Usage Examples

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/03-messages-api.md

Examples demonstrating how to search for messages using keywords, date ranges, and sender filters.

```typescript
// Search for messages containing "invoice"
const results = await client.inboxes.messages.search("inbox_test_123", {
    q: "invoice"
});

// Search with date range
const recent = await client.inboxes.messages.search("inbox_test_123", {
    q: "urgent",
    after: "2024-01-01T00:00:00Z",
    limit: 20
});

// Search for specific sender and keyword
const results2 = await client.inboxes.messages.search("inbox_test_123", {
    q: "from:alex@example.com important"
});
```

--------------------------------

### Pino Logger Example

Source: https://github.com/agentmail-to/agentmail-node/blob/main/README.md

Example of integrating the popular `pino` logging library with the Agentmail SDK's `ILogger` interface.

```typescript
import pino from 'pino';

const pinoLogger = pino({...});

const logger: logging.ILogger = {
  debug: (msg, ...args) => pinoLogger.debug(args, msg),
  info: (msg, ...args) => pinoLogger.info(args, msg),
  warn: (msg, ...args) => pinoLogger.warn(args, msg),
  error: (msg, ...args) => pinoLogger.error(args, msg),
};
```

--------------------------------

### Winston Logger Example

Source: https://github.com/agentmail-to/agentmail-node/blob/main/README.md

Example of integrating the popular `winston` logging library with the Agentmail SDK's `ILogger` interface.

```typescript
import winston from 'winston';

const winstonLogger = winston.createLogger({...});

const logger: logging.ILogger = {
    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
    info: (msg, ...args) => winstonLogger.info(msg, ...args),
    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
    error: (msg, ...args) => winstonLogger.error(msg, ...args),
};
```

--------------------------------

### Execute Agent Signup

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Example usage of the signUp method to register a new agent.

```typescript
const client = new AgentMailClient();

const response = await client.agent.signUp({
    humanEmail: "alex@example.com",
    username: "my-support-bot",
    displayName: "Support Bot"
});

console.log("API Key:", response.apiKey);
console.log("Organization:", response.organizationId);
console.log("Inbox Email:", response.email);
console.log("Verification Required:", response.verificationRequired);
```

--------------------------------

### Install Agentmail Node Package

Source: https://github.com/agentmail-to/agentmail-node/blob/main/README.md

Install the agentmail npm package using npm.

```sh
npm i -s agentmail
```

--------------------------------

### Perform Custom HTTP Requests

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/01-client-initialization.md

Demonstrates initializing the client and executing custom GET and POST requests with specific options.

```typescript
const client = new AgentMailClient({ apiKey: "your-api-key" });

// Make a custom GET request
const response = await client.fetch("/v1/custom/endpoint", {
    method: "GET",
});
const data = await response.json();

// With custom options
const response2 = await client.fetch("/v1/other", 
    { method: "POST", body: JSON.stringify({ foo: "bar" }) },
    { timeoutInSeconds: 30, maxRetries: 3 }
);
```

--------------------------------

### Usage of close method

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Example of closing the connection cleanly.

```typescript
const socket = await client.websockets.connect();

// Use the socket...

// Close cleanly
socket.close(1000, "Done");
```

--------------------------------

### Create Simple and Complex Drafts

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/07-drafts-api.md

Examples of creating a basic draft and a complex draft with CC, BCC, and HTML content.

```typescript
// Create a simple draft
const draft = await client.inboxes.drafts.create("inbox_test_123", {
    to: ["user@example.com"],
    subject: "Meeting Agenda",
    text: "Let's discuss the Q1 goals"
});

// Create a complex draft
const draft2 = await client.inboxes.drafts.create("inbox_test_123", {
    to: ["alice@example.com", "bob@example.com"],
    cc: ["manager@example.com"],
    bcc: ["archive@example.com"],
    subject: "Project Update",
    text: "Plain text version",
    html: "<p>HTML version with <b>formatting</b></p>",
    replyTo: ["noreply@example.com"]
});

console.log("Draft created:", draft2.draftId);
```

--------------------------------

### Usage of onMessage

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Example of registering a callback to process all incoming WebSocket messages.

```typescript
const socket = await client.websockets.connect();

socket.onMessage((message) => {
    const data = JSON.parse(message.data);
    console.log("Event:", data);
});
```

--------------------------------

### Usage of send method

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Example of sending a subscription request via the WebSocket.

```typescript
const socket = await client.websockets.connect();

// Send subscription request
socket.send(JSON.stringify({
    type: "subscribe",
    inboxId: "inbox_test_123"
}));
```

--------------------------------

### List drafts usage example

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/07-drafts-api.md

Demonstrates how to call the list method with an optional limit parameter.

```typescript
const result = await client.drafts.list({ limit: 50 });
console.log(result.drafts);
```

--------------------------------

### Configure AgentMail Production Environment

Source: https://github.com/agentmail-to/agentmail-node/blob/main/README.md

Initialize the AgentMail client for the production environment. Ensure the 'agentmail' package is installed.

```typescript
import { AgentMailClient, AgentMailEnvironment } from "agentmail";

const client = new AgentMailClient({
    environment: AgentMailEnvironment.Prod,
});
```

--------------------------------

### Usage of on method

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Example of subscribing to various event types like message creation, thread updates, and deletions.

```typescript
const socket = await client.websockets.connect();

// Listen for incoming messages
socket.on("message:created", (event) => {
    console.log("New message:", event.message);
    console.log("Inbox:", event.inboxId);
});

// Listen for thread updates
socket.on("thread:updated", (event) => {
    console.log("Thread updated:", event.thread);
    console.log("Labels:", event.labels);
});

// Listen for deletions
socket.on("message:deleted", (event) => {
    console.log("Message deleted:", event.messageId);
});
```

--------------------------------

### List Inboxes Usage Example

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/02-inboxes-api.md

Demonstrates how to list inboxes and iterate through paginated results.

```typescript
const client = new AgentMailClient({ apiKey: "sk_..." });

// List first 10 inboxes
const response = await client.inboxes.list({ limit: 10 });
console.log(response.inboxes);

// Paginate through results
let pageToken: string | undefined;
do {
    const result = await client.inboxes.list({ limit: 50, pageToken });
    console.log(result.inboxes);
    pageToken = result.nextPageToken;
} while (pageToken);
```

--------------------------------

### Apply Per-Request Options

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/01-client-initialization.md

Example of passing request-specific overrides to an API method.

```typescript
const response = await client.inboxes.list({}, {
    timeoutInSeconds: 10,
    maxRetries: 0,
    headers: { "X-Custom": "value" }
});
```

--------------------------------

### Get Inbox Usage Example

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/02-inboxes-api.md

Retrieves an inbox by ID and logs its email, display name, and metadata.

```typescript
const inbox = await client.inboxes.get("inbox_test_123");
console.log(inbox.email);
console.log(inbox.displayName);
console.log(inbox.metadata);
```

--------------------------------

### Build the Project

Source: https://github.com/agentmail-to/agentmail-node/blob/main/CONTRIBUTING.md

Build the project using pnpm.

```bash
pnpm build
```

--------------------------------

### Execute Agent Verification

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Example usage of the verify method to complete organization verification.

```typescript
const client = new AgentMailClient({ apiKey: "sk_..." });

// Receive OTP from email, then verify
const response = await client.agent.verify({
    otpCode: "123456"
});

console.log("Full API Key:", response.apiKey);
console.log("Organization Status:", response.organizationStatus);
console.log("Verified:", response.verified);
```

--------------------------------

### Create Inbox Usage Example

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/02-inboxes-api.md

Creates a new inbox with a display name, username, domain, and custom metadata.

```typescript
const inbox = await client.inboxes.create({
    displayName: "Support Bot",
    username: "support",
    domain: "agentmail.to",
    metadata: {
        team: "support",
        tier: "premium"
    }
});

console.log(inbox.email); // support@agentmail.to
console.log(inbox.inboxId);
```

--------------------------------

### Get Pod Draft

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieves details for a specific draft within a pod.

```bash
agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>
```

```typescript
await client.pods.drafts.get("pod_id", "draft_id");
```

--------------------------------

### Initialize AgentMail Client with Environments

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/01-client-initialization.md

Demonstrates initializing the client using predefined environments, custom URLs, or base URL overrides.

```typescript
import { AgentMailClient, AgentMailEnvironment } from "agentmail";

// Use production environment (default)
const client = new AgentMailClient({
    apiKey: "key",
    environment: AgentMailEnvironment.Prod,
});

// Use custom environment URLs
const client2 = new AgentMailClient({
    apiKey: "key",
    environment: {
        http: "https://custom-api.example.com",
        websockets: "wss://custom-ws.example.com"
    },
});

// Override just the base URL
const client3 = new AgentMailClient({
    apiKey: "key",
    baseUrl: "https://custom.example.com",
});
```

--------------------------------

### blob() Method Usage

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/12-binary-responses.md

Definition and usage example for the blob() method, typically used in browser environments.

```typescript
public async blob(): Promise<Blob>
```

```typescript
const response = await client.inboxes.messages.getAttachment(
    "inbox_123",
    "msg_abc",
    "att_xyz"
);

const blob = await response.blob();
const url = URL.createObjectURL(blob);
// Trigger browser download
```

--------------------------------

### bytes() Method Usage

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/12-binary-responses.md

Definition and usage example for the bytes() method, useful for small to medium files.

```typescript
public async bytes(): Promise<Uint8Array>
```

```typescript
const response = await client.inboxes.messages.getAttachment(
    "inbox_123",
    "msg_abc",
    "att_xyz"
);

const bytes = await response.bytes();
const text = new TextDecoder().decode(bytes);
```

--------------------------------

### Use Full API Key

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Initialize a new client with the full-permission API key to access resources.

```typescript
// Create new client with full-permission API key
const fullClient = new AgentMailClient({ apiKey: fullApiKey });

// Now you have full access to all resources
const inboxes = await fullClient.inboxes.list();
const messages = await fullClient.inboxes.messages.list(inboxes[0].inboxId);
```

--------------------------------

### AgentMailClient Constructor Signature

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/01-client-initialization.md

The constructor accepts an optional configuration object for client setup.

```typescript
constructor(options?: AgentMailClient.Options)
```

--------------------------------

### Implement AgentMail WebSocket client

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Demonstrates initializing the client, connecting to the WebSocket, and setting up event listeners.

```typescript
const client = new AgentMailClient({
    apiKey: "sk_live_...",
    logging: {
        level: logging.LogLevel.Debug,
        silent: false
    }
});

// Connect to WebSocket
const socket = await client.websockets.connect({
    debug: true,
    reconnectAttempts: 50
});

// Wait for connection ready
await socket.ready();
console.log("Connected to AgentMail WebSocket");

// Listen for incoming messages
socket.on("message:created", (event) => {
    console.log("New message from:", event.message.from);
    console.log("Subject:", event.message.subject);
    console.log("In inbox:", event.inboxId);
});

// Listen for thread updates
socket.on("thread:updated", (event) => {
    console.log("Thread labels updated:", event.labels);
});

// Listen for all messages (fallback)
socket.onMessage((message) => {
    console.log("Raw message:", message.data);
});

// Handle graceful shutdown
process.on("SIGTERM", () => {
    socket.close(1000, "Server shutting down");
});
```

--------------------------------

### Connecting to WebSockets

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Demonstrates various ways to initialize a WebSocket connection, including basic usage, custom configuration, and abort signal handling.

```typescript
const client = new AgentMailClient({ apiKey: "sk_..." });

// Simple connection
const socket = await client.websockets.connect();

// With custom configuration
const socket2 = await client.websockets.connect({
    debug: true,
    reconnectAttempts: 10,
    connectionTimeoutInSeconds: 30
});

// With abort signal
const controller = new AbortController();
const socket3 = await client.websockets.connect({
    abortSignal: controller.signal
});

// Later, abort the connection
controller.abort();
```

--------------------------------

### get()

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/02-inboxes-api.md

Retrieves details for a specific inbox by its identifier.

```APIDOC
## get()

### Description
Retrieve details for a specific inbox.

### Parameters
- **inbox_id** (string) - Required - The inbox identifier
- **requestOptions** (RequestOptions) - Optional - Per-request SDK options

### Returns
- HttpResponsePromise<Inbox>

### Errors
- NotFoundError (404) - Inbox not found
```

--------------------------------

### Usage of reconnect method

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Example of manually triggering a reconnection.

```typescript
const socket = await client.websockets.connect();

// After some time...
await socket.reconnect();
```

--------------------------------

### Create a Webhook

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new webhook scoped to a pod.

```bash
agentmail pods:webhooks create --pod-id <pod_id> --url https://example.com/webhook --event-type message.received
```

```typescript
await client.pods.webhooks.create("pod_id", {
    url: "url",
    eventTypes: ["message.received", "message.received"]
});
```

--------------------------------

### ready()

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Returns a promise that resolves when the WebSocket connection is established.

```APIDOC
## ready()

### Description
Get a promise that resolves when the WebSocket is ready.

### Response
- **Promise<void>** - Resolves when connection is established
```

--------------------------------

### Get a Webhook

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieves details for a specific webhook by its ID.

```bash
agentmail pods:webhooks get --pod-id <pod_id> --webhook-id <webhook_id>
```

```typescript
await client.pods.webhooks.get("pod_id", "webhook_id");
```

--------------------------------

### AgentMailClient Initialization

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/01-client-initialization.md

How to initialize the SDK client using predefined environments or custom URLs.

```APIDOC
## AgentMailClient Initialization

### Description
Initializes the SDK client with an API key and environment configuration.

### Constructor
`new AgentMailClient(options: { apiKey: string, environment?: AgentMailEnvironment | { http: string, websockets: string }, baseUrl?: string })`

### Example
```typescript
import { AgentMailClient, AgentMailEnvironment } from "agentmail";

const client = new AgentMailClient({
    apiKey: "key",
    environment: AgentMailEnvironment.Prod,
});
```
```

--------------------------------

### Get Draft Attachment

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieves an attachment from a specific draft.

```bash
agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>
```

```typescript
await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
```

--------------------------------

### Create a Pod

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Create a new pod instance.

```bash
agentmail pods create --client-id my-pod
```

```typescript
await client.pods.create({});
```

--------------------------------

### Get Raw Message

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Fetches the raw content of a message.

```bash
agentmail inboxes:messages get-raw --inbox-id <inbox_id> --message-id <message_id>
```

```typescript
await client.inboxes.messages.getRaw("inbox_id", "message_id");
```

--------------------------------

### client.webhooks.create

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new webhook configuration.

```APIDOC
## client.webhooks.create

### Description
Creates a new webhook configuration.

### Parameters
- **request** (AgentMail.CreateWebhookRequest) - Required
- **requestOptions** (WebhooksClient.RequestOptions) - Optional

### Usage
```typescript
await client.webhooks.create({
    url: "url",
    eventTypes: ["message.received", "message.received"]
});
```
```

--------------------------------

### Wait for stream readiness with ready()

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/11-events-api.md

Defines the signature for the ready() method and shows how to await the stream connection before proceeding.

```typescript
public ready(): Promise<void>
```

```typescript
const stream = await client.inboxes.events.connect("inbox_test_123");
await stream.ready();
console.log("Stream ready for events");
```

--------------------------------

### Get Draft Attachment

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieve a specific attachment from a draft.

```bash
agentmail drafts get-attachment --draft-id <draft_id> --attachment-id <attachment_id>
```

```typescript
await client.drafts.getAttachment("draft_id", "attachment_id");
```

--------------------------------

### Making Custom HTTP Requests with SDK Configuration

Source: https://github.com/agentmail-to/agentmail-node/blob/main/README.md

Use the `client.fetch` method to make custom HTTP requests to unsupported API endpoints. This method allows you to leverage SDK configurations like timeouts and retries. Ensure the response is processed correctly, for example, by parsing it as JSON.

```typescript
const response = await client.fetch("/v1/custom/endpoint", {
    method: "GET",
}, {
    timeoutInSeconds: 30,
    maxRetries: 3,
    headers: {
        "X-Custom-Header": "custom-value",
    },
});

const data = await response.json();
```

--------------------------------

### Get Draft

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieve details for a specific draft by its ID.

```bash
agentmail drafts get --draft-id <draft_id>
```

```typescript
await client.drafts.get("draft_id");
```

--------------------------------

### Run Test Suite

Source: https://github.com/agentmail-to/agentmail-node/blob/main/CONTRIBUTING.md

Run the entire test suite using pnpm.

```bash
pnpm test
```

--------------------------------

### Get Inbox

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieve details for a specific inbox by its ID.

```bash
agentmail inboxes get --inbox-id <inbox_id>
```

```typescript
await client.inboxes.get("inbox_id");
```

--------------------------------

### client.pods.create

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new pod.

```APIDOC
## client.pods.create

### Description
Creates a new pod.

### Parameters
- **request** (AgentMail.CreatePodRequest) - Required - The pod creation request body
- **requestOptions** (PodsClient.RequestOptions) - Optional - Request configuration options

### Usage
```typescript
await client.pods.create({});
```
```

--------------------------------

### WebSocket Connection and Event Handling

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Demonstrates how to initialize the AgentMail client, establish a WebSocket connection, and register event listeners for various message and thread events.

```APIDOC
## WebSocket Client Interface

### Description
The AgentMail WebSocket client allows real-time monitoring of inbox activity. Users can connect to the service and subscribe to specific event types such as message creation, updates, or deletions.

### Connection Method
`client.websockets.connect(options)`

### Parameters
- **options** (object) - Required
  - **debug** (boolean) - Optional - Enable debug logging.
  - **reconnectAttempts** (number) - Optional - Number of attempts to reconnect on failure.

### Event Listeners
- `socket.on(eventType, callback)` - Register a listener for a specific event type.
- `socket.onMessage(callback)` - Register a fallback listener for all incoming messages.

### Supported Event Types
- `message:created`: Triggered when a new message is received.
- `message:updated`: Triggered when a message is updated.
- `message:deleted`: Triggered when a message is deleted.
- `thread:created`: Triggered when a new thread is created.
- `thread:updated`: Triggered when a thread is updated.
- `thread:deleted`: Triggered when a thread is deleted.
```

--------------------------------

### get()

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/07-drafts-api.md

Retrieves a specific draft message by its unique identifier.

```APIDOC
## get(inbox_id, draft_id, requestOptions?)

### Description
Retrieve a specific draft by ID.

### Parameters
- **inbox_id** (string) - Required - The inbox identifier
- **draft_id** (string) - Required - The draft identifier
- **requestOptions** (RequestOptions) - Optional - Per-request SDK options

### Returns
- HttpResponsePromise<Draft> - Complete draft with all fields

### Throws
- `NotFoundError` (404) - Draft or inbox not found
```

--------------------------------

### List metrics via CLI

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Command-line interface command to list available metrics.

```bash
agentmail metrics list
```

--------------------------------

### Listen for ThreadDeletedEvent

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/11-events-api.md

Example usage of the stream listener for thread deletions.

```typescript
stream.on("thread:deleted", (event) => {
    console.log("Thread deleted:", event.threadId);
});
```

--------------------------------

### Listen for ThreadUpdatedEvent

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/11-events-api.md

Example usage of the stream listener for thread updates.

```typescript
stream.on("thread:updated", (event) => {
    console.log("Thread labels changed:", event.labels);
});
```

--------------------------------

### client.apiKeys.create

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new API key.

```APIDOC
## client.apiKeys.create()

### Description
Creates a new API key with the specified configuration.

### Parameters
- **request** (AgentMail.CreateApiKeyRequest) - Optional
- **requestOptions** (ApiKeysClient.RequestOptions) - Optional

### Usage
```typescript
await client.apiKeys.create({});
```
```

--------------------------------

### Listen for ThreadCreatedEvent

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/11-events-api.md

Example usage of the stream listener for new threads.

```typescript
stream.on("thread:created", (event) => {
    console.log("New thread subject:", event.thread.subject);
    console.log("Senders:", event.thread.senders);
});
```

--------------------------------

### Listen for MessageDeletedEvent

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/11-events-api.md

Example usage of the stream listener for message deletions.

```typescript
stream.on("message:deleted", (event) => {
    console.log("Message deleted:", event.messageId);
});
```

--------------------------------

### AgentMailClient Initialization

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/00-index.md

How to initialize the main AgentMail client to access all available resources.

```APIDOC
## AgentMailClient

### Description
The main entry point for the AgentMail SDK. Use this client to access all resources such as inboxes, messages, and threads.

### Usage
```typescript
import { AgentMailClient } from "agentmail";

const client = new AgentMailClient({ apiKey: "..." });
```
```

--------------------------------

### signUp(request: AgentSignupRequest, requestOptions?: RequestOptions)

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Creates a new agent organization, including an inbox and an initial limited-permission API key. This method is idempotent and triggers an OTP email to the provided human email address.

```APIDOC
## signUp(request: AgentSignupRequest, requestOptions?: RequestOptions)

### Description
Creates a new agent organization with an inbox and API key. This endpoint is idempotent; calling with the same humanEmail will rotate the API key and resend the OTP if expired.

### Parameters
- **request** (AgentSignupRequest) - Required - Agent signup information
- **requestOptions** (RequestOptions) - Optional - Per-request SDK options

#### AgentSignupRequest Fields
- **humanEmail** (string) - Required - Email address of the human managing this agent
- **username** (string) - Required - Username for agent (unique across platform)
- **displayName** (string) - Optional - Display name for the agent
- **inboxEmail** (string) - Optional - Desired email address for the agent's inbox

### Response
- **apiKey** (string) - Limited-permission API key (until verified)
- **organizationId** (string) - Unique organization identifier
- **inboxId** (string) - Default inbox identifier
- **email** (string) - Email address of the inbox
- **username** (string) - Agent username
- **verificationRequired** (boolean) - Whether OTP verification is required

### Example
```typescript
const client = new AgentMailClient();
const response = await client.agent.signUp({
    humanEmail: "alex@example.com",
    username: "my-support-bot",
    displayName: "Support Bot"
});
```
```

--------------------------------

### Listen for MessageUpdatedEvent

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/11-events-api.md

Example usage of the stream listener for message updates.

```typescript
stream.on("message:updated", (event) => {
    console.log("Message labels changed:", event.labels);
});
```

--------------------------------

### Listen for MessageCreatedEvent

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/11-events-api.md

Example usage of the stream listener for new messages.

```typescript
stream.on("message:created", (event) => {
    console.log("Inbox:", event.inboxId);
    console.log("From:", event.message.from);
    console.log("Subject:", event.message.subject);
    console.log("Thread:", event.threadId);
});
```

--------------------------------

### ready()

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/11-events-api.md

Returns a promise that resolves when the stream is ready.

```APIDOC
## ready()

### Description
Returns a promise that resolves when the stream connection is fully established and ready to receive events.

### Signature
`public ready(): Promise<void>`
```

--------------------------------

### Get Thread Attachment

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Downloads or retrieves a specific attachment from a thread.

```bash
agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>
```

```typescript
await client.inboxes.threads.getAttachment("inbox_id", "thread_id", "attachment_id");
```

--------------------------------

### Create a new pod

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/10-other-resources.md

Initializes a new pod with the provided request configuration.

```typescript
public create(
    request?: CreatePodRequest,
    requestOptions?: RequestOptions
): HttpResponsePromise<Pod>
```

--------------------------------

### Get Thread Details

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieves specific thread information by ID.

```bash
agentmail inboxes:threads get --inbox-id <inbox_id> --thread-id <thread_id>
```

```typescript
await client.inboxes.threads.get("inbox_id", "thread_id");
```

--------------------------------

### client.domains.create

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new domain.

```APIDOC
## client.domains.create

### Description
Registers a new domain in the system.

### Parameters
- **request** (AgentMail.CreateDomainRequest) - Required - The domain creation details
- **requestOptions** (DomainsClient.RequestOptions) - Optional - Request configuration options
```

--------------------------------

### Get Single Message

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieve details for a specific message by its ID.

```bash
agentmail inboxes:messages get --inbox-id <inbox_id> --message-id <message_id>
```

```typescript
await client.inboxes.messages.get("inbox_id", "message_id");
```

--------------------------------

### client.pods.lists.create

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new entry in a pod list.

```APIDOC
## client.pods.lists.create

### Description
Adds a new entry to the specified pod list.

### Parameters
- **pod_id** (AgentMail.PodId) - Required
- **direction** (AgentMail.Direction) - Required
- **type** (AgentMail.ListType) - Required
- **request** (AgentMail.CreateListEntryRequest) - Required
- **requestOptions** (ListsClient.RequestOptions) - Optional
```

--------------------------------

### Get Webhook Details

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieve details for a specific webhook by its ID.

```bash
agentmail webhooks get --webhook-id <webhook_id>
```

```typescript
await client.webhooks.get("webhook_id");
```

--------------------------------

### get(inbox_id, thread_id, requestOptions)

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/04-threads-api.md

Retrieve a specific thread with all its messages.

```APIDOC
## get(inbox_id, thread_id, requestOptions)

### Description
Retrieve a specific thread with all its messages.

### Parameters
- **inbox_id** (string) - Required - The inbox identifier
- **thread_id** (string) - Required - The thread identifier
- **requestOptions** (RequestOptions) - Optional - Per-request SDK options

### Returns
- **HttpResponsePromise<Thread>** - Complete thread with all messages

### Example
```typescript
const thread = await client.inboxes.threads.get("inbox_test_123", "thread_abc123");
console.log(thread.subject);
```
```

--------------------------------

### Pagination Implementation

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/09-types-reference.md

Definition of the PageToken type and an example of how to iterate through paginated results.

```typescript
type PageToken = string;
```

```typescript
let pageToken: string | undefined;
do {
    const result = await client.inboxes.list({ limit: 50, pageToken });
    console.log(result.inboxes);
    pageToken = result.nextPageToken;
} while (pageToken);
```

--------------------------------

### fetch()

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/01-client-initialization.md

Executes a raw HTTP request using the configured SDK settings.

```APIDOC
## fetch(input, init, requestOptions)

### Description
Allows making raw HTTP requests using the SDK's internal configuration, such as authentication headers and retry logic.

### Parameters
- **input** (Request | string | URL) - Required - The URL or Request object to fetch.
- **init** (RequestInit) - Optional - Standard fetch options like method, headers, and body.
- **requestOptions** (RequestOptions) - Optional - SDK-specific per-request options like timeoutInSeconds and maxRetries.

### Response
- **Promise<Response>** - Returns a standard Web API Response object.
```

--------------------------------

### client.pods.webhooks.create(pod_id, params)

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Create a webhook scoped to this pod.

```APIDOC
## client.pods.webhooks.create(pod_id, params)

### Description
Create a webhook scoped to this pod.

### Parameters
- **pod_id** (AgentMail.PodId) - Required
- **request** (AgentMail.CreatePodWebhookRequest) - Required
- **requestOptions** (WebhooksClient.RequestOptions) - Optional

### Usage
```typescript
await client.pods.webhooks.create("pod_id", {
    url: "url",
    eventTypes: ["message.received", "message.received"]
});
```
```

--------------------------------

### Subpackage Imports

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/00-index.md

How to import specific subpackage clients for tree-shaking.

```APIDOC
## Subpackage Clients

### Description
Import specific clients directly to reduce bundle size.

### Usage
```typescript
import { InboxesClient } from "agentmail/inboxes";
import { WebsocketsClient } from "agentmail/websockets";

const inboxes = new InboxesClient({ apiKey: "..." });
const ws = new WebsocketsClient({ apiKey: "..." });
```
```

--------------------------------

### client.lists.create

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new entry in the specified list.

```APIDOC
## client.lists.create

### Description
Creates a new entry in the specified list.

### Parameters
- **direction** (AgentMail.Direction) - Required
- **type** (AgentMail.ListType) - Required
- **request** (AgentMail.CreateListEntryRequest) - Required
- **requestOptions** (ListsClient.RequestOptions) - Optional

### Usage
```typescript
await client.lists.create("send", "allow", {
    entry: "entry"
});
```
```

--------------------------------

### Get Pod Inbox

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieve details for a specific inbox within a pod.

```bash
agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
```

```typescript
await client.pods.inboxes.get("pod_id", "inbox_id");
```

--------------------------------

### Get Pod Domain

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieve details for a specific domain within a pod.

```bash
agentmail pods:domains get --pod-id <pod_id> --domain-id <domain_id>
```

```typescript
await client.pods.domains.get("pod_id", "domain_id");
```

--------------------------------

### Get an Inbox Webhook

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieves details for a specific webhook within an inbox.

```bash
agentmail inboxes:webhooks get --inbox-id <inbox_id> --webhook-id <webhook_id>
```

```typescript
await client.inboxes.webhooks.get("inbox_id", "webhook_id");
```

--------------------------------

### Handle Idempotent Signup

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Demonstrates calling the signup endpoint multiple times to rotate keys or resend OTPs.

```typescript
// First signup
const response1 = await client.agent.signUp({
    humanEmail: "alex@example.com",
    username: "bot-v1"
});

// Later, call again to get new key
const response2 = await client.agent.signUp({
    humanEmail: "alex@example.com",
    username: "bot-v1"
});

// response1.apiKey !== response2.apiKey (key rotated)
// OTP is resent to email
```

--------------------------------

### Get Message Attachment

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieves an attachment from a specific message within an inbox.

```bash
agentmail inboxes:messages get-attachment --inbox-id <inbox_id> --message-id <message_id> --attachment-id <attachment_id>
```

```typescript
await client.inboxes.messages.getAttachment("inbox_id", "message_id", "attachment_id");
```

--------------------------------

### Get Domain Zone File

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieve the zone file for a specific domain.

```bash
agentmail domains get-zone-file --domain-id <domain_id>
```

```typescript
await client.domains.getZoneFile("domain_id");
```

--------------------------------

### client.webhooks.list

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieves a list of all configured webhooks.

```APIDOC
## client.webhooks.list

### Description
Retrieves a list of all configured webhooks.

### Parameters
- **request** (AgentMail.webhooks.ListWebhooksRequest) - Optional
- **requestOptions** (WebhooksClient.RequestOptions) - Optional

### Usage
```typescript
await client.webhooks.list();
```
```

--------------------------------

### client.apiKeys.createPublicKey

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Registers a new public key.

```APIDOC
## client.apiKeys.createPublicKey()

### Description
Register a public P-256 JWK using an existing AgentMail bearer API key. Requires `api_key_create`.

### Parameters
- **request** (AgentMail.CreatePublicKeyRequest) - Optional
- **requestOptions** (ApiKeysClient.RequestOptions) - Optional

### Usage
```typescript
await client.apiKeys.createPublicKey({ publicKey: { ... } });
```
```

--------------------------------

### Get a mailing list

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/10-other-resources.md

Fetches details for a specific mailing list by ID.

```typescript
public get(
    list_id: string,
    requestOptions?: RequestOptions
): HttpResponsePromise<MailingList>
```

--------------------------------

### ListsClient.create()

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/10-other-resources.md

Creates a new mailing list.

```APIDOC
## create()

### Description
Create a new mailing list.

### Signature
`public create(request: CreateListRequest, requestOptions?: RequestOptions): HttpResponsePromise<MailingList>`
```

--------------------------------

### Define Agent Signup Method

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Method signature for creating a new agent organization.

```typescript
public signUp(
    request: AgentSignupRequest,
    requestOptions?: RequestOptions
): HttpResponsePromise<AgentSignupResponse>
```

--------------------------------

### Initialize AgentMail Client

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Initialize the client without an API key to begin the signup process.

```typescript
const client = new AgentMailClient();
// No API key needed for signup
```

--------------------------------

### Get Inbox Entry

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Fetch details for a specific entry within an inbox list.

```bash
agentmail inboxes:lists get --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
```

```typescript
await client.inboxes.lists.get("inbox_id", "send", "allow", "entry");
```

--------------------------------

### client.pods.domains.create(pod_id, params)

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new domain within a pod.

```APIDOC
## client.pods.domains.create(pod_id, params)

### Description
Registers a new domain for the specified pod.

### Parameters
- **pod_id** (AgentMail.PodId) - Required
- **request** (AgentMail.CreateDomainRequest) - Required
- **requestOptions** (DomainsClient.RequestOptions) - Optional
```

--------------------------------

### get(inbox_id, message_id, requestOptions)

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/03-messages-api.md

Retrieve a specific message by its ID from a given inbox.

```APIDOC
## get(inbox_id, message_id, requestOptions)

### Description
Retrieve a specific message by ID.

### Parameters
#### Path Parameters
- **inbox_id** (string) - Required - The inbox identifier
- **message_id** (string) - Required - The message identifier

#### Request Options
- **requestOptions** (RequestOptions) - Optional - Per-request SDK options

### Response
- **Returns** (HttpResponsePromise<Message>) - Complete message with all fields

### Errors
- **NotFoundError** (404) - Message or inbox not found
```

--------------------------------

### Sign Up New Agent

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/00-index.md

Registers a new agent and verifies the account using an OTP code.

```typescript
const response = await client.agent.signUp({
    humanEmail: "admin@example.com",
    username: "my-bot"
});

console.log("Check email for OTP");

// Later, after user provides OTP:
const verified = await client.agent.verify({ otpCode: "123456" });
console.log("API Key:", verified.apiKey);
```

--------------------------------

### Get Draft Method Definition

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/07-drafts-api.md

Method signature for retrieving a specific draft by its ID.

```typescript
public get(
    inbox_id: InboxId,
    draft_id: DraftId,
    requestOptions?: RequestOptions
): HttpResponsePromise<Draft>
```

--------------------------------

### client.pods.apiKeys.create()

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new API key for a specific pod.

```APIDOC
## client.pods.apiKeys.create(pod_id, params)

### Description
Creates a new API key for the specified pod.

### Parameters
- **pod_id** (AgentMail.PodId) - Required - The ID of the pod.
- **request** (AgentMail.CreateApiKeyRequest) - Required - The request body containing API key details.
- **requestOptions** (ApiKeysClient.RequestOptions) - Optional - Configuration options for the request.

### Usage
```typescript
await client.pods.apiKeys.create("pod_id", {});
```
```

--------------------------------

### client.agent.signUp

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Registers a new agent. This method is idempotent; calling it with an existing email will rotate the API key and resend the OTP.

```APIDOC
## client.agent.signUp

### Description
Registers a new agent using a human email and a username. This endpoint is idempotent.

### Parameters
- **humanEmail** (string) - Required - The email address of the human owner.
- **username** (string) - Required - The desired username for the agent.

### Response
- **apiKey** (string) - A limited-access API key used for the verification step.
```

--------------------------------

### Handle AgentMailTimeoutError

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/08-error-types.md

Example of catching a timeout error to implement retry logic or user feedback.

```typescript
try {
    await client.inboxes.list({}, {
        timeoutInSeconds: 5  // 5 second timeout
    });
} catch (err) {
    if (err instanceof AgentMailTimeoutError) {
        console.log("Request timed out after 5 seconds");
        // Retry with longer timeout or handle user feedback
    }
}
```

--------------------------------

### client.agent.signUp

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Registers a new agent organization. Requires a human email and a username.

```APIDOC
## client.agent.signUp

### Description
Registers a new agent organization. This method initiates the signup process.

### Parameters
- **humanEmail** (string) - Required - The email address of the human user.
- **username** (string) - Required - The desired username for the agent.

### Request Example
{
	"humanEmail": "user@example.com",
	"username": "agent_name"
}
```

--------------------------------

### Instantiate and Use AgentMailClient

Source: https://github.com/agentmail-to/agentmail-node/blob/main/README.md

Instantiate the AgentMailClient with an API key and create an inbox. Ensure you replace 'YOUR_API_KEY' with your actual API key.

```typescript
import { AgentMailClient } from "agentmail";

const client = new AgentMailClient({ apiKey: "YOUR_API_KEY" });
await client.inboxes.create(undefined);
```

--------------------------------

### arrayBuffer() Method Usage

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/12-binary-responses.md

Definition and usage example for the arrayBuffer() method, suitable for binary manipulation.

```typescript
public async arrayBuffer(): Promise<ArrayBuffer>
```

```typescript
const response = await client.domains.getZoneFile("domain_id");
const buffer = await response.arrayBuffer();
const view = new DataView(buffer);
```

--------------------------------

### AgentMailClient Constructor

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/01-client-initialization.md

Initializes a new instance of the AgentMailClient with optional configuration settings.

```APIDOC
## constructor(options?: AgentMailClient.Options)

### Description
Initializes the AgentMail client. The client provides access to various resource-specific clients and handles authentication and request configuration.

### Parameters
- **options** (AgentMailClient.Options) - Optional - Configuration object including apiKey, environment, baseUrl, headers, timeoutInSeconds, maxRetries, fetch, and logging settings.
```

--------------------------------

### stream() Method Usage

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/12-binary-responses.md

Definition and usage example for the stream() method, ideal for large files.

```typescript
public stream(): ReadableStream<Uint8Array>
```

```typescript
const response = await client.inboxes.messages.getAttachment(
    "inbox_123",
    "msg_abc",
    "att_xyz"
);

const stream = response.stream();
// Process stream data
stream.pipeTo(destination);
```

--------------------------------

### Get Pod List Entry

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Fetch details for a specific entry within a pod list.

```bash
agentmail pods:lists get --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
```

```typescript
await client.pods.lists.get("pod_id", "send", "allow", "entry");
```

--------------------------------

### Authenticate and retrieve identity via CLI

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Use the CLI command to verify the current authenticated identity.

```bash
agentmail auth me
```

--------------------------------

### client.websockets.connect

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/05-websockets-api.md

Establishes a new WebSocket connection with configurable reconnection parameters.

```APIDOC
## client.websockets.connect

### Description
Establishes a connection to the WebSocket server with specified reconnection behavior.

### Parameters
- **reconnectAttempts** (number) - Optional - Maximum number of automatic reconnection attempts (default: 30).
- **connectionTimeoutInSeconds** (number) - Optional - Timeout for establishing a new connection.

### Example
```typescript
const socket = await client.websockets.connect({
    reconnectAttempts: 100,
    connectionTimeoutInSeconds: 10
});
```
```

--------------------------------

### Get a specific list entry

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Fetches details for a specific entry identified by email or domain.

```bash
agentmail lists get --direction <direction> --type <type> --entry <entry>
```

```typescript
await client.lists.get("send", "allow", "entry");
```

--------------------------------

### Initialize Main AgentMail Client

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/00-index.md

Use the main client to access all available resources like inboxes, messages, and threads.

```typescript
import { AgentMailClient } from "agentmail";

const client = new AgentMailClient({ apiKey: "..." });
// Access all resources: client.inboxes, client.messages, client.threads, etc.
```

--------------------------------

### Batch Get Messages

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Fetch metadata for multiple messages in a single request, up to a limit of 500.

```bash
agentmail inboxes:messages batch-get --inbox-id <inbox_id> --message-id <id1> --message-id <id2>
```

```typescript
await client.inboxes.messages.batchGet("inbox_id", {
    messageIds: ["message_ids", "message_ids"]
});
```

--------------------------------

### Get Inbox Method Definition

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/02-inboxes-api.md

Method signature for retrieving details of a specific inbox by its identifier.

```typescript
public get(
    inbox_id: InboxId,
    requestOptions?: RequestOptions
): HttpResponsePromise<Inbox>
```

--------------------------------

### Get Organization Details

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Retrieves metadata for the authenticated organization, including usage limits and billing information.

```bash
agentmail organizations get
```

```typescript
await client.organizations.get();
```

--------------------------------

### Sign up for an AgentMail organization

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

Creates a new agent organization and triggers an OTP verification email. This endpoint is idempotent.

```bash
agentmail agent sign-up --human-email user@example.com --username my-agent
```

```typescript
await client.agent.signUp({
    humanEmail: "human_email",
    username: "username"
});
```

--------------------------------

### Get Webhook Headers

Source: https://github.com/agentmail-to/agentmail-node/blob/main/reference.md

List the names of custom HTTP headers for a webhook. Values are write-only and not returned.

```typescript
await client.webhooks.getHeaders("webhook_id");
```

--------------------------------

### Check Code Style

Source: https://github.com/agentmail-to/agentmail-node/blob/main/CONTRIBUTING.md

Check code style and formatting using pnpm.

```bash
pnpm run lint
```

```bash
pnpm run format:check
```

--------------------------------

### Update message properties

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/03-messages-api.md

Defines the method signature for updating message metadata and provides an example of updating labels.

```typescript
public update(
    inbox_id: InboxId,
    message_id: MessageId,
    request: UpdateMessageRequest,
    requestOptions?: RequestOptions
): HttpResponsePromise<Message>
```

```typescript
const updated = await client.inboxes.messages.update(
    "inbox_test_123",
    "msg_abc123",
    {
        labels: ["important", "follow-up"]
    }
);
```

--------------------------------

### Sign Up Agent

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/06-agent-api.md

Register a new agent using a human email and username to receive a limited API key.

```typescript
const signupResponse = await client.agent.signUp({
    humanEmail: "human@example.com",
    username: "my-agent-bot"
});

const limitedApiKey = signupResponse.apiKey;
console.log("Please check email for OTP");
```

--------------------------------

### Retrieve a message by ID

Source: https://github.com/agentmail-to/agentmail-node/blob/main/_autodocs/03-messages-api.md

Defines the method signature for fetching a message and provides an example of accessing message fields.

```typescript
public get(
    inbox_id: InboxId,
    message_id: MessageId,
    requestOptions?: RequestOptions
): HttpResponsePromise<Message>
```

```typescript
const message = await client.inboxes.messages.get("inbox_test_123", "msg_abc123");
console.log(message.from);
console.log(message.subject);
console.log(message.text);
console.log(message.attachments);
```
Tokens:
Raw