AgencyMod API

Använd din AgencyMod med AgencyAI i ditt eget ärendesystem, din webbplats eller ditt helpdesk. Den svarar med allt du har ställt in i instrumentpanelen: namn, ton, nivå, instruktioner, kunskap, dokumentation och det som den har lärt sig från ditt team.

Öppna instrumentpanelen AI-inställningar

Kom igång

01Öppna instrumentpanelen, fliken AI, och skapa en nyckel under AgencyMod API. Kopiera den direkt, den visas bara en gång.
02Spara nyckeln på din server. Lägg den aldrig på en webbplats, i en app eller på något som andra kan öppna.
03Skicka konversationen för ett ärende till API:t med headern Authorization: Bearer och din nyckel.
04Visa svaret i ditt ärende. Om needs_team är true, meddela ditt team.

Exempel

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

Förfrågan

POST med en JSON-body. Dessa fält läses: POST https://bot.agencyscripts.dev/api/v1/chat

messages: Konversationen, äldst först, upp till 20 meddelanden. role är user för kunden och assistant för tidigare botsvar, content är texten. Det sista meddelandet måste komma från user. Obligatoriskt.
customer: Kundens namn, så att boten kan tilltala kunden. Valfritt.
messages[].name: Inuti ett meddelande: namnet på personen som skrev det, användbart när flera personer skriver i samma ärende. Valfritt.

Svar

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: Svaret som vanlig text med enkel markdown.
needs_team: true om en människa ska ta över, till exempel för betalningar, bans eller problem som boten inte kan lösa.
bot: Namn och avatar från din varumärkesprofil, för att visa svaret precis som i Discord.
level: Den AgencyAI-nivå som svarade: V1, V1.5 eller V2.
usage: Den återstående kvoten i procent, din påfyllningskredit och dina förfrågningsgränser.
ai_notice: En kort notis om att svaret skrevs av en AI. Visa den för dina kunder, så att de alltid vet att en AI har svarat.

Kontrollera din kvot

En GET-förfrågan till /api/v1/status med samma header returnerar bottens namn och avatar samt din återstående kvot, utan att använda något av den.

cURL

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

Gränser och kvot

01Med Premium kan API:t använda upp till hälften av din veckovisa AI-kvot, så det finns alltid kvot kvar för Discord. Kvoten återställs varje måndag.
02När API-kvoten är slut fortsätter det med din påfyllningskredit. Påfyllningar finns i instrumentpanelen, fliken AI, och upphör aldrig.
03Utan Premium får du en liten provkvot på nivå V1. Den kräver minst 20 medlemmar och AgencyMod på din server i 7 dagar.
0420 förfrågningar per minut och nyckel, 1,000 förfrågningar per dag med Premium och 150 utan. Upp till 5 nycklar per server.

Fel

400: messages saknas, eller det sista meddelandet är inte från user.
401: Nyckeln saknas, är fel eller återkallad.
402: Kvoten är slut. Fyll på eller skaffa Premium.
403: Servern uppfyller ännu inte kraven för API:t utan Premium.
429: För många förfrågningar. Vänta en stund och försök igen.
503: AgencyAI svarade inte. Försök igen.

SäkerhetDen som har din nyckel använder din AI-kvot. Om en nyckel läcker, återkalla den i instrumentpanelen och skapa en ny. API:t är gjort för anrop från din server, webbläsare kan inte anropa det direkt.

Bättre svarAPI:t använder samma kunskap som din bot i Discord. Fyll i kunskapen och dokumentationslänkarna i fliken AI, och godkänn träningsförslagen från lösta ärenden. Varje godkänd post förbättrar Discord och API:t på en gång.

Något oklart? Öppna en ticket på help.agencyg.de i kategorin AgencyMod eller fråga på vår Discord. Integritetspolicy och villkor