AgencyMod API

Gebruik je AgencyMod met AgencyAI in je eigen ticketsysteem, website of helpdesk. Het antwoordt met alles wat je in het dashboard hebt ingesteld: naam, toon, niveau, instructies, kennis, documentatie en wat het van je team heeft geleerd.

Dashboard openen AI-instellingen

Aan de slag

01Open het dashboard, tabblad AI, en maak een sleutel aan onder AgencyMod API. Kopieer hem meteen, want hij wordt maar één keer getoond.
02Bewaar de sleutel op je server. Plaats hem nooit op een website, in een app of ergens waar anderen bij kunnen.
03Stuur het gesprek van een ticket naar de API met de header Authorization: Bearer en je sleutel.
04Toon het antwoord in je ticket. Als needs_team true is, breng dan je team op de hoogte.

Voorbeeld

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

Verzoek

POST met een JSON-body. Deze velden worden gelezen: POST https://bot.agencyscripts.dev/api/v1/chat

messages: Het gesprek, oudste eerst, tot 20 berichten. role is user voor de klant en assistant voor eerdere antwoorden van de bot, content is de tekst. Het laatste bericht moet van user komen. Verplicht.
customer: De naam van de klant, zodat de bot die kan aanspreken. Optioneel.
messages[].name: Binnen een bericht: de naam van de persoon die het schreef, handig als meerdere mensen in één ticket schrijven. Optioneel.

Antwoord

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: Het antwoord als gewone tekst met eenvoudige markdown.
needs_team: true als een mens het moet overnemen, bijvoorbeeld bij betalingen, bans of problemen die de bot niet kan oplossen.
bot: Naam en avatar uit je branding, om het antwoord precies zo te tonen als in Discord.
level: Het AgencyAI-niveau dat heeft geantwoord: V1, V1.5 of V2.
usage: Het resterende tegoed in procent, je aanvultegoed en je verzoeklimieten.
ai_notice: Een korte melding dat het antwoord door een AI is geschreven. Toon die aan je klanten, zodat ze altijd weten dat een AI heeft geantwoord.

Controleer je tegoed

Een GET-verzoek naar /api/v1/status met dezelfde header geeft de naam en avatar van de bot en je resterende tegoed terug, zonder er iets van te gebruiken.

cURL

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

Limieten en tegoed

01Met Premium kan de API tot de helft van je wekelijkse AI-tegoed gebruiken, zodat er altijd tegoed overblijft voor Discord. Het tegoed wordt elke maandag gereset.
02Als het API-tegoed op is, gaat het verder met je aanvultegoed. Aanvullen kan in het dashboard, tabblad AI, en verloopt nooit.
03Zonder Premium krijg je een klein proeftegoed op niveau V1. Daarvoor zijn minstens 20 leden en AgencyMod op je server gedurende 7 dagen nodig.
0420 verzoeken per minuut per sleutel, 1.000 verzoeken per dag met Premium en 150 zonder. Tot 5 sleutels per server.

Fouten

400: messages ontbreekt, of het laatste bericht komt niet van user.
401: De sleutel ontbreekt, is fout of ingetrokken.
402: Het tegoed is op. Vul aan of krijg Premium.
403: De server voldoet nog niet aan de eisen voor de API zonder Premium.
429: Te veel verzoeken. Wacht even en probeer het opnieuw.
503: AgencyAI heeft niet geantwoord. Probeer het opnieuw.

VeiligheidIedereen met je sleutel gebruikt je AI-tegoed. Als een sleutel lekt, trek hem in het dashboard in en maak een nieuwe aan. De API is gemaakt voor aanroepen vanaf je server, browsers kunnen er niet rechtstreeks mee werken.

Betere antwoordenDe API gebruikt dezelfde kennis als je bot in Discord. Vul de kennis en de documentatielinks in op het tabblad AI, en keur de trainingsvoorstellen uit opgeloste tickets goed. Elk goedgekeurd item verbetert Discord en de API tegelijk.

Iets onduidelijk? Open een ticket op help.agencyg.de in de categorie AgencyMod of stel je vraag in onze Discord. Privacybeleid en voorwaarden