API AgencyMod

Используйте ваш AgencyMod с AgencyAI в вашей собственной системе тикетов, веб-сайте или helpdesk. Он отвечает со всем что вы установили в панели: имя, тон, уровень, инструкции, знание, документация и то что он выучил от вашей команды.

Открыть панель управления Настройки ИИ

Начало работы

01Откройте панель, вкладка ИИ, и создайте ключ под AgencyMod API. Скопируйте его сразу же, он показывается только один раз.
02Сохраните ключ на вашем сервере. Никогда не кладите его в веб-сайт, приложение или что-либо что другие могут открыть.
03Отправьте историю тикета в API с заголовком Authorization: Bearer и вашим ключом.
04Покажите ответ в тикете. Если needs_team правда, уведомите вашу команду.

Пример

cURL

curl https://bot.agencyscripts.dev/api/v1/chat \
  -H "Authorization: Bearer amk_..." \
  -H "Content-Type: application/json" \
  -d '{"customer":"Alex","messages":[{"role":"user","content":"How do I join the server?"}]}'

JavaScript (Node.js)

const antwort = await fetch("https://bot.agencyscripts.dev/api/v1/chat", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.AGENCYMOD_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    customer: "Alex",
    messages: [
      { role: "user", content: "How do I join the server?" },
    ],
  }),
});
const { answer, needs_team } = await antwort.json();

PHP

$ch = curl_init("https://bot.agencyscripts.dev/api/v1/chat");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer " . getenv("AGENCYMOD_KEY"),
    "Content-Type: application/json",
  ],
  CURLOPT_POSTFIELDS => json_encode([
    "customer" => "Alex",
    "messages" => [["role" => "user", "content" => "How do I join the server?"]],
  ]),
]);
$antwort = json_decode(curl_exec($ch), true);

Запрос

POST с телом JSON. Эти поля читаются: POST https://bot.agencyscripts.dev/api/v1/chat

messages: История, от старейшего к новому, до 20 сообщений. role это user для клиента и assistant для более ранних ответов бота, content это текст. Последнее сообщение должно быть от user. Обязательно.
customer: Имя клиента, чтобы бот мог к нему обращаться. Опционально.
messages[].name: Внутри сообщения: имя человека который его написал, полезно когда несколько человек пишут в одном тикете. Опционально.

Ответ

JSON

{
  "answer": "...",
  "needs_team": false,
  "bot": { "name": "AgencyMod", "avatar": "https://cdn.discordapp.com/..." },
  "level": "V1",
  "usage": {
    "available_percent": 92.5,
    "credit_percent": 0,
    "requests_today": 14,
    "requests_per_day": 1000,
    "requests_per_minute": 20,
    "premium": true
  },
  "ai_notice": "This answer was generated automatically by an AI (AgencyAI)."
}

answer: Ответ обычным текстом с простым markdown.
needs_team: Правда если человек должен взять верх, например при платежах, банах или проблемах которые бот не может решить.
bot: Имя и аватар из вашего оформления, чтобы показать ответ так же как в Discord.
level: Уровень AgencyAI который ответил: V1, V1.5 или V2.
usage: Оставшееся квота в процентах, ваш пополненный баланс и ваши лимиты запроса.
ai_notice: Короткое примечание что ответ написан ИИ. Покажите его вашим клиентам, чтобы они всегда знали что ИИ ответил.

Проверьте вашу квоту

GET запрос на /api/v1/status с тем же заголовком возвращает имя и аватар бота и вашу оставшуюся квоту, без использования её.

cURL

curl https://bot.agencyscripts.dev/api/v1/status \
  -H "Authorization: Bearer amk_..."

Лимиты и квота

01С Premium API может использовать до половины вашей недельной квоты ИИ, так что для Discord всегда остаётся квота. Квота обновляется каждый понедельник.
02Когда квота API пуста, она продолжает с вашим пополненным балансом. Пополнения есть в панели, вкладка ИИ, и никогда не истекают.
03Без Premium вы получаете малую пробную квоту на уровне V1. Для этого нужно минимум 20 участников и AgencyMod на вашем сервере 7 дней.
0420 запросов в минуту на ключ, 1.000 запросов в день с Premium и 150 без. До 5 ключей на сервер.

Ошибки

400: messages отсутствует, или последнее сообщение не от user.
401: Ключ отсутствует, неправильный или отозван.
402: Квота исчерпана. Пополните или получите Premium.
403: Сервер ещё не отвечает требованиям для API без Premium.
429: Слишком много запросов. Подождите момент и попробуйте снова.
503: AgencyAI не ответил. Попробуйте снова.

БезопасностьКто угодно с вашим ключом использует вашу квоту ИИ. Если ключ вышел наружу, отзовите его в панели и создайте новый. API сделана для вызовов с вашего сервера, браузеры не могут вызывать её напрямую.

Лучше ответыAPI использует то же знание что ваш бот в Discord. Заполните знание и ссылки документации на вкладке ИИ, и одобрите предложения обучения из решённых тикетов. Каждая одобренная запись улучшает Discord и API одновременно.

Что-то непонятно? Создайте тикет в категории AgencyMod на help.agencyg.de или спросите в нашем Discord. Политика конфиденциальности и условия использования