API de AgencyMod

Usa tu AgencyMod con AgencyAI en tu propio sistema de tickets, sitio web o servicio de asistencia. Responde con todo lo que configures en el panel: nombre, tono, nivel, instrucciones, conocimiento, documentación y lo que ha aprendido de tu equipo.

Abrir panel de control Configuración de IA

Cómo empezar

01Abre el panel, pestaña IA, y crea una clave bajo API de AgencyMod. Cópiala ya, se muestra solo una vez.
02Guarda la clave en tu servidor. Nunca la pongas en un sitio web, una app o algo que pueda abrir otra gente.
03Envía la conversación de un ticket a la API con la cabecera Authorization: Bearer y tu clave.
04Muestra la respuesta en tu ticket. Si needs_team es true, notifica a tu equipo.

Ejemplo

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

Solicitud

POST con un cuerpo JSON. Se leen estos campos: POST https://bot.agencyscripts.dev/api/v1/chat

messages: La conversación, mensaje más antiguo primero, hasta 20 mensajes. role es user para el cliente y assistant para respuestas anteriores del bot, content es el texto. El último mensaje debe ser del user. Obligatorio.
customer: El nombre del cliente, para que el bot pueda dirigirse a él. Opcional.
messages[].name: Dentro de un mensaje: el nombre de quien lo escribió, útil cuando varios escriben en un ticket. Opcional.

Respuesta

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 respuesta como texto plano con markdown sencillo.
needs_team: true si un humano debe tomar el relevo, por ejemplo en pagos, expulsiones o problemas que el bot no puede resolver.
bot: Nombre e imagen de tu marca, para mostrar la respuesta igual que en Discord.
level: El nivel de AgencyAI que respondió: V1, V1.5 o V2.
usage: El contingente restante en porcentaje, tu crédito de carga y tus límites de solicitud.
ai_notice: Una breve nota de que la respuesta la escribió una IA. Muéstrasela a tus clientes, así siempre saben que respondió una IA.

Comprueba tu contingente

Una solicitud GET a /api/v1/status con la misma cabecera devuelve el nombre e imagen del bot y tu contingente restante, sin usar nada de él.

cURL

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

Límites y contingente

01Con Premium la API puede usar hasta la mitad de tu contingente semanal de IA, así siempre queda contingente para Discord. El contingente se reinicia cada lunes.
02Si el contingente de la API se acaba, sigue con tu crédito de carga. Las cargas están en el panel, pestaña IA, y nunca vencen.
03Sin Premium tienes un pequeño contingente de prueba en nivel V1. Para eso tu servidor necesita mínimo 20 miembros y AgencyMod desde hace 7 días.
0420 solicitudes por minuto por clave, 1.000 solicitudes al día con Premium y 150 sin. Hasta 5 claves por servidor.

Errores

400: Falta messages, o el último mensaje no es del user.
401: La clave no está, es incorrecta o fue revocada.
402: El contingente se agotó. Carga o consigue Premium.
403: El servidor no cumple los requisitos para la API sin Premium todavía.
429: Demasiadas solicitudes. Espera un momento e intenta de nuevo.
503: AgencyAI no respondió. Intenta de nuevo.

SeguridadQuienquiera que tenga tu clave usa tu contingente de IA. Si una clave se filtra, revócala en el panel y crea una nueva. La API es para llamadas desde tu servidor, los navegadores no pueden llamarla directamente.

Mejores respuestasLa API usa el mismo conocimiento que tu bot en Discord. Rellena el conocimiento y los enlaces de documentación en la pestaña IA, y aprueba las sugerencias de entrenamiento de tickets resueltos. Cada entrada aprobada mejora Discord y la API a la vez.

¿Tienes alguna duda? Abre un ticket en help.agencyg.de, en la categoría AgencyMod, o pregunta en nuestro Discord. Política de privacidad y condiciones de uso