Messages

Listing Messages

List all messages in an inbox. Results are returned in reverse chronological order (newest first).

curl https://agentinbox.in/api/v1/inboxes/inb_123/messages \
  -H "Authorization: Bearer $AgentInbox_API_KEY"

const messages = await client.messages.list({ inboxId: "inb_123" });
for (const msg of messages.data) {
  console.log(msg.subject, msg.from);
}

messages = client.messages.list(inbox_id="inb_123")
for msg in messages.data:
    print(msg.subject, msg.from)

Getting a Message

Retrieve a specific message by its ID. The response includes headers, body content, and any extractions.

curl https://agentinbox.in/api/v1/messages/msg_456 \
  -H "Authorization: Bearer $AgentInbox_API_KEY"

const message = await client.messages.get("msg_456");
console.log(message.subject);
console.log(message.body.text);

Extracting Data

Automatically extract structured data from messages. AgentInbox supports 8 built-in extraction types plus LLM-powered fallback.

const extraction = await client.extractions.create({
  messageId: "msg_456",
  type: "otp",
});
console.log(extraction.value); // "123456"

extraction = client.extractions.create(
    message_id="msg_456",
    type="otp",
)
print(extraction.value)  # "123456"

Supported Extraction Types

Body Content

Messages include both text and HTML body content. The API returns both versions when available.

const message = await client.messages.get("msg_456");
console.log(message.body.text);   // Plain text
console.log(message.body.html);   // HTML content
console.log(message.body.raw);    // Raw MIME

Body Fields

• text — Plain text body, stripped of HTML tags
• html — Original HTML body content
• raw — Raw MIME message for advanced use cases

Real-Time Notifications

Use webhooks to receive real-time notifications when messages arrive. See the Webhooks guide for setup instructions.

{
  "event": "email.received",
  "timestamp": "2024-06-12T10:30:00Z",
  "data": {
    "inboxId": "inb_123",
    "messageId": "msg_456",
    "subject": "Your verification code",
    "from": "noreply@example.com"
  }
}

Next Steps