For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
info@patternautomation.com
ДокументацияБаза знанийЖурнал измененийСправочник API
ДокументацияБаза знанийЖурнал измененийСправочник API
    • База знаний
  • С чего начать
    • Что такое Agent Inbox?
    • Возможности ящика
    • Первый ящик
    • Получение API-ключа
  • Сценарии для агентов
    • Входящие письма
    • Allowlist и blocklist
    • Тредовые переписки
    • Human-in-the-loop
    • Pods и мультитенантность
    • Метки и состояние
  • Домены и доставляемость
    • Свой домен
    • SPF, DKIM и DMARC
    • Письма в спаме
    • Прогрев домена
    • Конфликты MX
  • Решение проблем
    • Ошибка 403
    • Лимиты запросов
    • Дублирование отправок
    • Домен не верифицируется
    • Отказы доставки (bounce)
  • Настройка DNS
    • Cloudflare
    • GoDaddy
    • Route 53 (AWS)
    • Namecheap
info@patternautomation.com
LogoLogo
On this page
  • Установите SDK
  • Создайте ящик
  • Настройка ящика
  • Идемпотентность через clientId
  • Первая отправка
  • Список ящиков
  • Дальше
С чего начать

Как создать первый ящик?

Быстрый старт с первым ящиком Agent Inbox.

Was this page helpful?
Edit this page
Previous

Как получить API-ключ?

Создание и управление ключами Agent Inbox.

Next
Built with

Ящик даёт агенту собственный адрес. Можно использовать домен по умолчанию @agentinbox.space или свой верифицированный домен.

Установите SDK

TypeScript
$npm install agentinbox

Создайте ящик

TypeScript
1import { AgentinboxClient } from "agentinbox";
2
3const client = new AgentinboxClient({ apiKey: "am_..." });
4
5// Create an inbox with a random address on agentinbox.space
6const inbox = await client.inboxes.create();
7console.log(`Inbox created: ${inbox.inboxId}`);

У ящика появится уникальный адрес (например randomname@agentinbox.space) — сразу можно отправлять и принимать почту.

Настройка ящика

Можно задать имя пользователя, домен и отображаемое имя:

TypeScript
1const inbox = await client.inboxes.create({
2 username: "support",
3 domain: "yourcompany.com",
4 displayName: "Support Agent",
5});
6
7// inbox.inboxId will be support@yourcompany.com
8console.log(`Inbox created: ${inbox.inboxId}`);

Свой домен должен быть верифицирован. См. Создание своих доменов. Без домена используется @agentinbox.space.

Идемпотентность через clientId

Если ящик создаётся программно (например при старте), используйте clientId, чтобы не плодить дубликаты — при совпадении вернётся существующий ящик:

TypeScript
1const inbox = await client.inboxes.create({
2 username: "my-agent",
3 clientId: "my-agent-inbox-v1",
4 displayName: "My Agent",
5});
6
7// Safe to call multiple times: same inbox returned every time

Первая отправка

TypeScript
1await client.inboxes.messages.send(inbox.inboxId, {
2 to: "recipient@example.com",
3 subject: "Hello from my agent!",
4 text: "This is a plain text version.",
5 html: "<p>This is an <strong>HTML</strong> version.</p>",
6});

Указывайте и text, и html — так письмо корректно отображается в клиентах и лучше доставляется.

Список ящиков

TypeScript
1const inboxes = await client.inboxes.list();
2console.log(`You have ${inboxes.count} inboxes.`);
3
4for (const inbox of inboxes.inboxes) {
5 console.log(` ${inbox.inboxId}`);
6}

Дальше

  • Отправка и приём
  • Webhooks
  • Метки