AgencyMod API

Używaj swojego AgencyMod z AgencyAI w swoim systemie ticketów, na stronie lub w helpdesku. Odpowiada według wszystkiego, co ustawisz w panelu: nazwy, tonu, poziomu, instrukcji, wiedzy, dokumentacji i tego, czego nauczył się od Twojego zespołu.

Otwórz panel Ustawienia AI

Zacznij

01Otwórz panel, zakładkę AI, i utwórz klucz w sekcji AgencyMod API. Skopiuj go od razu, bo jest pokazywany tylko raz.
02Przechowuj klucz na swoim serwerze. Nigdy nie wstawiaj go na stronę, do aplikacji ani niczego, do czego mogą zajrzeć inni.
03Wyślij rozmowę z ticketu do API z nagłówkiem Authorization: Bearer i swoim kluczem.
04Pokaż odpowiedź w swoim tickecie. Jeśli needs_team ma wartość true, powiadom swój zespół.

Przykład

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);

Zapytanie

POST z treścią JSON. Odczytywane są te pola: POST https://bot.agencyscripts.dev/api/v1/chat

messages: Rozmowa, od najstarszej, do 20 wiadomości. role to user dla klienta i assistant dla wcześniejszych odpowiedzi bota, content to tekst. Ostatnia wiadomość musi pochodzić od user. Wymagane.
customer: Imię klienta, żeby bot mógł się do niego zwrócić. Opcjonalne.
messages[].name: W wiadomości: imię osoby, która ją napisała, przydatne, gdy w jednym tickecie pisze kilka osób. Opcjonalne.

Odpowiedź

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: Odpowiedź jako zwykły tekst z prostym markdownem.
needs_team: true, jeśli powinien przejąć człowiek, np. przy płatnościach, banach lub problemach, których bot nie rozwiąże.
bot: Nazwa i awatar z Twojego brandingu, żeby odpowiedź wyglądała tak jak na Discordzie.
level: Poziom AgencyAI, który odpowiedział: V1, V1.5 lub V2.
usage: Pozostały limit w procentach, Twój kredyt doładowania i limity zapytań.
ai_notice: Krótka informacja, że odpowiedź napisała AI. Pokaż ją swoim klientom, żeby zawsze wiedzieli, że odpowiadała AI.

Sprawdź swój limit

Zapytanie GET na /api/v1/status z tym samym nagłówkiem zwraca nazwę i awatar bota oraz Twój pozostały limit, bez zużywania go.

cURL

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

Limity i kwota

01Z Premium API może używać do połowy Twojego tygodniowego limitu AI, więc dla Discorda zawsze zostaje limit. Limit resetuje się w każdy poniedziałek.
02Gdy limit API się wyczerpie, działa dalej na Twoim kredycie doładowania. Doładowania są w panelu, w zakładce AI, i nigdy nie wygasają.
03Bez Premium dostajesz mały limit próbny na poziomie V1. Wymaga co najmniej 20 członków i AgencyMod na Twoim serwerze przez 7 dni.
0420 zapytań na minutę na klucz, 1000 zapytań dziennie z Premium i 150 bez. Do 5 kluczy na serwer.

Błędy

400: Brak messages lub ostatnia wiadomość nie pochodzi od user.
401: Klucz jest brakujący, błędny lub unieważniony.
402: Limit się wyczerpał. Doładuj go lub kup Premium.
403: Serwer jeszcze nie spełnia wymagań API bez Premium.
429: Zbyt wiele zapytań. Poczekaj chwilę i spróbuj ponownie.
503: AgencyAI nie odpowiedział. Spróbuj ponownie.

BezpieczeństwoKażdy, kto ma Twój klucz, zużywa Twój limit AI. Jeśli klucz wycieknie, unieważnij go w panelu i utwórz nowy. API jest stworzone do wywołań z Twojego serwera, przeglądarki nie mogą go wywoływać bezpośrednio.

Lepsze odpowiedziAPI korzysta z tej samej wiedzy co Twój bot na Discordzie. Uzupełnij wiedzę i linki do dokumentacji w zakładce AI i zatwierdzaj sugestie treningu z rozwiązanych ticketów. Każdy zatwierdzony wpis od razu ulepsza Discord i API.

Coś niejasne? Otwórz ticket na help.agencyg.de w kategorii AgencyMod albo zapytaj na naszym Discordzie. Polityka prywatności i regulamin