Agency Docs

API di AgencyMod

Usa il tuo AgencyMod con AgencyAI nel tuo sistema di ticket, sul tuo sito o nel tuo helpdesk. Risponde con tutto ciò che hai impostato nella dashboard: nome, tono, livello, istruzioni, conoscenze, documentazione e ciò che ha imparato dal tuo team.

Per iniziare

  1. 01Apri la dashboard, scheda IA, e crea una chiave sotto API di AgencyMod. Copiala subito, viene mostrata una sola volta.
  2. 02Conserva la chiave sul tuo server. Non metterla mai in un sito, in un'app o in qualsiasi cosa che altri possono aprire.
  3. 03Invia la conversazione di un ticket all'API con l'header Authorization: Bearer e la tua chiave.
  4. 04Mostra la risposta nel tuo ticket. Se needs_team è true, avvisa il tuo team.

Esempio

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

Richiesta

POST con un corpo JSON. Vengono letti questi campi: POST https://bot.agencyscripts.dev/api/v1/chat

messages
La conversazione, dal più vecchio al più recente, fino a 20 messaggi. role è user per il cliente e assistant per le risposte precedenti del bot, content è il testo. L'ultimo messaggio deve provenire dall'utente. Obbligatorio.
customer
Il nome del cliente, così il bot può rivolgersi a lui. Facoltativo.
messages[].name
Dentro un messaggio: il nome di chi l'ha scritto, utile quando più persone scrivono nello stesso ticket. Facoltativo.

Risposta

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 risposta come testo semplice con markdown essenziale.
needs_team
true se deve intervenire una persona, per esempio per pagamenti, ban o problemi che il bot non riesce a risolvere.
bot
Nome e avatar dal tuo branding, per mostrare la risposta come su Discord.
level
Il livello di AgencyAI che ha risposto: V1, V1.5 o V2.
usage
La quota rimanente in percentuale, il tuo credito di ricarica e i tuoi limiti di richieste.
ai_notice
Una breve nota che indica che la risposta è stata scritta da un'IA. Mostrala ai tuoi clienti, così sanno sempre che ha risposto un'IA.

Controlla la tua quota

Una richiesta GET a /api/v1/status con lo stesso header restituisce il nome e l'avatar del bot e la tua quota rimanente, senza consumarne nulla.

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

Limiti e quota

  1. 01Con Premium l'API può usare fino alla metà della tua quota IA settimanale, così resta sempre quota per Discord. La quota si azzera ogni lunedì.
  2. 02Quando la quota dell'API è esaurita, continua con il tuo credito di ricarica. Le ricariche si trovano nella dashboard, scheda IA, e non scadono mai.
  3. 03Senza Premium ottieni una piccola quota di prova sul livello V1. Servono almeno 20 membri e AgencyMod sul tuo server da 7 giorni.
  4. 0420 richieste al minuto per chiave, 1,000 richieste al giorno con Premium e 150 senza. Fino a 5 chiavi per server.

Errori

400
messages manca, oppure l'ultimo messaggio non è dell'utente.
401
La chiave manca, è sbagliata o è stata revocata.
402
La quota è esaurita. Ricarica o ottieni Premium.
403
Il server non soddisfa ancora i requisiti per l'API senza Premium.
429
Troppe richieste. Attendi un momento e riprova.
503
AgencyAI non ha risposto. Riprova.
SicurezzaChiunque abbia la tua chiave usa la tua quota IA. Se una chiave finisce in mano altrui, revocala nella dashboard e creane una nuova. L'API è pensata per le chiamate dal tuo server: i browser non possono chiamarla direttamente.
Risposte miglioriL'API usa le stesse conoscenze del tuo bot su Discord. Compila le conoscenze e i link alla documentazione nella scheda IA, e approva i suggerimenti di addestramento dai ticket risolti. Ogni voce approvata migliora Discord e l'API insieme.

Qualcosa non è chiaro? Apri un ticket su help.agencyg.de nella categoria AgencyMod oppure chiedi nel nostro Discord. Informativa sulla privacy e termini

Sei ancora bloccato dopo questa pagina? Il nostro supporto prende il testimone.