AgencyMod API

Utilisez votre AgencyMod avec AgencyAI dans votre propre système de tickets, site web ou helpdesk. Il répond avec tout ce que vous avez configuré dans le tableau de bord : nom, ton, niveau, instructions, connaissances, documentation et ce qu'il a appris de votre équipe.

Ouvrir le tableau de bord Paramètres IA

Commencer

01Ouvrez le tableau de bord, l'onglet IA, et créez une clé sous AgencyMod API. Copiez-la tout de suite, elle n'est affichée qu'une seule fois.
02Stockez la clé sur votre serveur. Ne la mettez jamais dans un site web, une app ou n'importe quoi que d'autres peuvent ouvrir.
03Envoyez la conversation d'un ticket à l'API avec l'en-tête Authorization: Bearer et votre clé.
04Affichez la réponse dans votre ticket. Si needs_team est vrai, notifiez votre équipe.

Exemple

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

Demande

POST avec un corps JSON. Ces champs sont lus : POST https://bot.agencyscripts.dev/api/v1/chat

messages: La conversation, le plus ancien en premier, jusqu'à 20 messages. role est user pour le client et assistant pour les réponses antérieures du bot, content est le texte. Le dernier message doit venir de l'user. Obligatoire.
customer: Le nom du client, pour que le bot puisse l'adresser. Optionnel.
messages[].name: Dans un message : le nom de la personne qui l'a écrit, utile quand plusieurs personnes écrivent dans un ticket. Optionnel.

Réponse

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: La réponse en texte brut avec du markdown simple.
needs_team: true si un humain devrait prendre le relais, par exemple pour les paiements, les banns ou les problèmes que le bot ne peut pas résoudre.
bot: Nom et avatar de votre branding, pour afficher la réponse exactement comme dans Discord.
level: Le niveau AgencyAI qui a répondu : V1, V1.5 ou V2.
usage: Le contingent restant en pourcentage, votre crédit de recharge et vos limites de demandes.
ai_notice: Un court avis que la réponse a été écrite par une IA. Montrez-le à vos clients, ainsi ils sauront toujours qu'une IA a répondu.

Vérifiez votre contingent

Une demande GET à /api/v1/status avec le même en-tête retourne le nom et avatar du bot et votre contingent restant, sans en utiliser aucun.

cURL

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

Limites et contingent

01Avec Premium l'API peut utiliser jusqu'à la moitié de votre contingent IA hebdomadaire, ainsi il y a toujours du contingent pour Discord. Le contingent recommence chaque lundi.
02Quand le contingent de l'API est épuisé, il continue avec votre crédit de recharge. Les recharges se font dans le tableau de bord, onglet IA, et ne s'expirent jamais.
03Sans Premium vous obtenez un petit contingent d'essai sur le niveau V1. Cela nécessite au minimum 20 membres et AgencyMod sur votre serveur depuis 7 jours.
0420 demandes par minute par clé, 1.000 demandes par jour avec Premium et 150 sans. Jusqu'à 5 clés par serveur.

Erreurs

400: messages manque, ou le dernier message ne vient pas de l'user.
401: La clé manque, est mauvaise ou a été révoquée.
402: Le contingent est épuisé. Rechargez ou obtenez Premium.
403: Le serveur ne remplit pas encore les conditions pour l'API sans Premium.
429: Trop de demandes. Attendez un moment et réessayez.
503: AgencyAI n'a pas répondu. Réessayez.

SécuritéQuiconque a votre clé utilise votre contingent IA. Si une clé s'échappe, révoquez-la dans le tableau de bord et créez une nouvelle. L'API est faite pour les appels de votre serveur, les navigateurs ne peuvent pas l'appeler directement.

Meilleures réponsesL'API utilise les mêmes connaissances que votre bot dans Discord. Remplissez les connaissances et les liens de documentation dans l'onglet IA, et approuvez les suggestions d'entraînement des tickets résolus. Chaque entrée approuvée améliore Discord et l'API à la fois.

Une question ? Ouvrez un ticket dans la catégorie AgencyMod sur help.agencyg.de ou posez-la sur notre Discord. Politique de confidentialité et conditions d’utilisation