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
  • Шаги
  • Использование ключа
  • Ограниченные по области ключи
С чего начать

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

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

Was this page helpful?
Edit this page
Previous

Как обрабатывать входящие письма?

Webhooks и WebSockets для приёма почты.

Next
Built with

Для запросов к API нужен ключ. Ключи начинаются с am_ и создаются в консоли Agent Inbox.

Шаги

  1. Откройте консоль Agent Inbox
  2. Зарегистрируйтесь или войдите
  3. Раздел API Keys в боковом меню
  4. Create New API Key
  5. Укажите понятное имя (например my-support-agent)
  6. Сразу скопируйте ключ и храните в безопасном месте

Ключ показывается только один раз. При потере создайте новый. Не коммитьте ключи в репозиторий и не публикуйте их.

Использование ключа

Храните ключ в переменной окружения:

Bash
$# .env file
$AGENTINBOX_API_KEY=am_your_key_here

Инициализация SDK:

TypeScript
1import { AgentinboxClient } from "agentinbox";
2import "dotenv/config";
3
4const client = new AgentinboxClient({
5 apiKey: process.env.AGENTINBOX_API_KEY,
6});
7
8// Test the connection by creating an inbox
9const inbox = await client.inboxes.create();
10console.log(`Connected! Created inbox: ${inbox.inboxId}`);

Ограниченные по области ключи

Помимо ключей уровня организации можно создавать ключи для одного pod или одного ящика — доступ только к ресурсам в этой области.

  • Ключ pod:POST /pods/{pod_id}/api-keys или client.pods.api_keys.create()
  • Ключ ящика:POST /inboxes/{inbox_id}/api-keys или client.inboxes.api_keys.create()

Подробнее — Мультитенантность.