AgencyMod API

Brug din AgencyMod med AgencyAI i dit eget ticketsystem, på din hjemmeside eller i dit helpdesk. Den svarer med alt, du har sat op i dashboardet: navn, tone, niveau, instruktioner, viden, dokumentation og det, den har lært af dit team.

Åbn dashboard AI-indstillinger

Kom i gang

01Åbn dashboardet, fanen AI, og opret en nøgle under AgencyMod API. Kopiér den med det samme, den vises kun én gang.
02Gem nøglen på din server. Læg den aldrig på en hjemmeside, i en app eller noget andet, som andre kan åbne.
03Send samtalen i en ticket til API'et med headeren Authorization: Bearer og din nøgle.
04Vis svaret i din ticket. Hvis needs_team er true, skal du give dit team besked.

Eksempel

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

Forespørgsel

POST med en JSON-body. Disse felter læses: POST https://bot.agencyscripts.dev/api/v1/chat

messages: Samtalen, ældste først, op til 20 beskeder. role er user for kunden og assistant for tidligere botsvar, content er teksten. Den sidste besked skal komme fra user. Påkrævet.
customer: Kundens navn, så botten kan tiltale dem. Valgfrit.
messages[].name: Inde i en besked: navnet på den, der skrev den, nyttigt når flere skriver i samme ticket. Valgfrit.

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 ren tekst med simpel markdown.
needs_team: true hvis et menneske skal overtage, for eksempel ved betalinger, bans eller problemer, botten ikke kan løse.
bot: Navn og avatar fra din branding, så svaret vises ligesom i Discord.
level: Det AgencyAI-niveau, der svarede: V1, V1.5 eller V2.
usage: Den resterende kvote i procent, din påfyldningskredit og dine forespørgselsgrænser.
ai_notice: En kort note om, at svaret er skrevet af en AI. Vis den til dine kunder, så de altid ved, at en AI svarede.

Tjek din kvote

En GET-forespørgsel til /api/v1/status med samme header returnerer botens navn og avatar samt din resterende kvote, uden at bruge noget af den.

cURL

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

Grænser og kvote

01Med Premium kan API'et bruge op til halvdelen af din ugentlige AI-kvote, så der altid er kvote tilbage til Discord. Kvoten nulstilles hver mandag.
02Når API-kvoten er tom, fortsætter det med din påfyldningskredit. Påfyldninger ligger i dashboardet, fanen AI, og udløber aldrig.
03Uden Premium får du en lille prøvekvote på niveau V1. Den kræver mindst 20 medlemmer og AgencyMod på din server i 7 dage.
0420 forespørgsler i minuttet pr. nøgle, 1.000 forespørgsler om dagen med Premium og 150 uden. Op til 5 nøgler pr. server.

Fejl

400: messages mangler, eller den sidste besked er ikke fra user.
401: Nøglen mangler, er forkert eller tilbagekaldt.
402: Kvoten er brugt op. Fyld op eller få Premium.
403: Serveren opfylder endnu ikke kravene til API'et uden Premium.
429: For mange forespørgsler. Vent lidt og prøv igen.
503: AgencyAI svarede ikke. Prøv igen.

SikkerhedEnhver med din nøgle bruger din AI-kvote. Hvis en nøgle lækker, tilbagekald den i dashboardet og opret en ny. API'et er lavet til kald fra din server, og browsere kan ikke kalde det direkte.

Bedre svarAPI'et bruger den samme viden som din bot i Discord. Udfyld viden og dokumentationslinks i fanen AI, og godkend træningsforslagene fra løste tickets. Hver godkendt post forbedrer Discord og API'et på én gang.

Er noget uklart? Åbn et ticket på help.agencyg.de i kategorien AgencyMod, eller spørg på vores Discord. Privatlivspolitik og vilkår