AgencyMod API

Використовуйте AgencyMod з AgencyAI у власній системі тікетів, на вебсайті чи в службі підтримки. Він відповідає з усіма налаштуваннями, які ви задали на панелі: ім'я, тон, рівень, інструкції, знання, документація та те, чого навчився від вашої команди.

Відкрити панель керування Налаштування ШІ

Початок роботи

01Відкрийте панель, вкладку ШІ, і створіть ключ у розділі AgencyMod API. Скопіюйте його одразу, він показується лише раз.
02Зберігайте ключ на своєму сервері. Ніколи не вставляйте його на вебсайт, в застосунок чи будь-куди, що можуть відкрити інші.
03Надішліть розмову з тікета до API із заголовком Authorization: Bearer і вашим ключем.
04Покажіть відповідь у своєму тікеті. Якщо needs_team дорівнює true, повідомте свою команду.

Приклад

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: true, якщо людина має перейняти розмову, наприклад для платежів, банів або проблем, які бот не може вирішити.
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.

Щось незрозуміло? Відкрийте тікет на help.agencyg.de у категорії AgencyMod або запитайте в нашому Discord. Політика конфіденційності та умови