С чего начать

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

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

Для запросов к 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()

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