Agency Docs

AgencyMod-API

Nutze deinen AgencyMod mit AgencyAI in deinem eigenen Ticketsystem, auf deiner Webseite oder im Helpdesk. Er antwortet mit allem, was du im Dashboard eingestellt hast: Name, Ton, Stufe, Anweisungen, Wissen, Doku und dem, was er von deinem Team gelernt hat.

So legst du los

  1. 01Öffne das Dashboard, Reiter KI, und lege unter AgencyMod-API einen Schlüssel an. Kopiere ihn sofort, er wird nur einmal angezeigt.
  2. 02Speichere den Schlüssel auf deinem Server. Pack ihn nie in eine Webseite, eine App oder irgendetwas, das andere öffnen können.
  3. 03Schick den Verlauf eines Tickets an die API, mit dem Header Authorization: Bearer und deinem Schlüssel.
  4. 04Zeig die Antwort im Ticket. Ist needs_team true, benachrichtige dein Team.

Beispiel

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

Anfrage

POST mit einem JSON-Körper. Diese Felder werden gelesen: POST https://bot.agencyscripts.dev/api/v1/chat

messages
Der Verlauf, älteste Nachricht zuerst, bis zu 20 Nachrichten. role ist user für den Kunden und assistant für frühere Antworten des Bots, content ist der Text. Die letzte Nachricht muss vom user kommen. Pflicht.
customer
Der Name des Kunden, damit der Bot ihn ansprechen kann. Optional.
messages[].name
In einer Nachricht: der Name der Person, die sie geschrieben hat, praktisch wenn mehrere Leute in einem Ticket schreiben. Optional.

Antwort

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
Die Antwort als Text mit einfachem Markdown.
needs_team
true, wenn ein Mensch übernehmen sollte, zum Beispiel bei Zahlungen, Banns oder Problemen, die der Bot nicht lösen kann.
bot
Name und Bild aus deinem Branding, um die Antwort genau wie in Discord zu zeigen.
level
Die AgencyAI-Stufe, die geantwortet hat: V1, V1.5 oder V2.
usage
Das restliche Kontingent in Prozent, dein aufgeladenes Guthaben und deine Anfragegrenzen.
ai_notice
Ein kurzer Hinweis, dass die Antwort von einer KI stammt. Zeig ihn deinen Kunden, damit sie immer wissen, dass eine KI geantwortet hat.

Kontingent abfragen

Eine GET-Anfrage an /api/v1/status mit demselben Header liefert Name und Bild des Bots und dein restliches Kontingent, ohne etwas davon zu verbrauchen.

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

Grenzen und Kontingent

  1. 01Mit Premium darf die API bis zur Hälfte deines wöchentlichen KI-Kontingents nutzen, damit Discord nie leer läuft. Das Kontingent beginnt jeden Montag neu.
  2. 02Ist das API-Kontingent leer, geht es mit deinem aufgeladenen Guthaben weiter. Aufladungen gibt es im Dashboard im Reiter KI, sie verfallen nie.
  3. 03Ohne Premium gibt es ein kleines Probe-Kontingent auf Stufe V1. Dafür braucht dein Server mindestens 20 Mitglieder und AgencyMod seit 7 Tagen.
  4. 0420 Anfragen pro Minute je Schlüssel, 1.000 Anfragen am Tag mit Premium und 150 ohne. Bis zu 5 Schlüssel je Server.

Fehler

400
messages fehlt, oder die letzte Nachricht ist nicht vom user.
401
Der Schlüssel fehlt, ist falsch oder wurde widerrufen.
402
Das Kontingent ist aufgebraucht. Lade auf oder hol dir Premium.
403
Der Server erfüllt die Voraussetzungen für die API ohne Premium noch nicht.
429
Zu viele Anfragen. Warte kurz und versuch es nochmal.
503
AgencyAI hat nicht geantwortet. Versuch es nochmal.
SicherheitWer deinen Schlüssel hat, nutzt dein KI-Kontingent. Ist ein Schlüssel nach außen gelangt, widerrufe ihn im Dashboard und lege einen neuen an. Die API ist für Aufrufe von deinem Server gedacht, Browser können sie nicht direkt aufrufen.
Bessere AntwortenDie API nutzt dasselbe Wissen wie dein Bot in Discord. Füll im Reiter KI das Wissen und die Doku-Links aus und gib die Trainingsvorschläge aus gelösten Tickets frei. Jeder freigegebene Eintrag verbessert Discord und die API gleichzeitig.

Etwas unklar? Öffne auf help.agencyg.de ein Ticket in der Kategorie AgencyMod oder frag in unserem Discord. Datenschutz und Nutzungsbedingungen

Kommst du nach dieser Seite nicht weiter? Dann übernimmt unser Support.