API AgencyMod

Use o seu AgencyMod com AgencyAI no seu próprio sistema de tickets, site ou helpdesk. Responde com tudo o que configurou no painel: nome, tom, nível, instruções, conhecimento, documentação e o que aprendeu da sua equipa.

Abrir painel Definições de IA

Como começar

01Abra o painel, separador IA, e crie uma chave em API AgencyMod. Copie-a imediatamente, é mostrada apenas uma vez.
02Guarde a chave no seu servidor. Nunca a coloque numa página, numa aplicação ou noutro local que outras pessoas possam abrir.
03Envie a conversa de um ticket para a API com o cabeçalho Authorization: Bearer e a sua chave.
04Mostre a resposta no seu ticket. Se needs_team for verdadeiro, notifique a sua equipa.

Exemplo

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

Pedido

POST com um corpo JSON. Estes campos são lidos: POST https://bot.agencyscripts.dev/api/v1/chat

messages: A conversa, mais antiga primeiro, até 20 mensagens. role é user para o cliente e assistant para respostas anteriores do bot, content é o texto. A última mensagem tem de vir do utilizador. Obrigatório.
customer: O nome do cliente, para que o bot possa addressá-lo. Opcional.
messages[].name: Dentro de uma mensagem: o nome da pessoa que a escreveu, útil quando várias pessoas escrevem num ticket. Opcional.

Resposta

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: A resposta como texto simples com markdown simples.
needs_team: verdadeiro se um humano deve assumir, por exemplo para pagamentos, banimentos ou problemas que o bot não consegue resolver.
bot: Nome e avatar do seu branding, para mostrar a resposta como no Discord.
level: O nível AgencyAI que respondeu: V1, V1.5 ou V2.
usage: O contingente restante em percentagem, o seu crédito carregado e os seus limites de pedido.
ai_notice: Uma nota curta de que a resposta foi escrita por uma IA. Mostre-a aos seus clientes, para que saibam sempre que uma IA respondeu.

Verifique o seu contingente

Um pedido GET para /api/v1/status com o mesmo cabeçalho devolve o nome e avatar do bot e o seu contingente restante, sem usar nenhum dele.

cURL

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

Limites e contingente

01Com Premium, a API pode usar até metade do seu contingente semanal de IA, para que haja sempre contingente disponível para Discord. O contingente retoma todas as segundas-feiras.
02Quando o contingente da API está cheio, continua com o seu crédito carregado. Os carregamentos estão no painel, separador IA, e nunca expiram.
03Sem Premium obtém um pequeno contingente de teste no nível V1. Precisa pelo menos de 20 membros e de AgencyMod no seu servidor há 7 dias.
0420 pedidos por minuto por chave, 1.000 pedidos por dia com Premium e 150 sem. Até 5 chaves por servidor.

Erros

400: messages está em falta, ou a última mensagem não é do utilizador.
401: A chave está em falta, está errada ou foi revogada.
402: O contingente foi usado. Carregue ou obtenha Premium.
403: O servidor ainda não cumpre os requisitos para a API sem Premium.
429: Demasiados pedidos. Aguarde um momento e tente novamente.
503: A AgencyAI não respondeu. Tente novamente.

SegurançaQualquer pessoa com a sua chave usa o seu contingente de IA. Se uma chave vazar, revogue-a no painel e crie uma nova. A API é feita para chamadas do seu servidor, navegadores não conseguem chamá-la diretamente.

Respostas melhoresA API usa o mesmo conhecimento que o seu bot no Discord. Preencha o conhecimento e as ligações de documentação no separador IA, e aprove as sugestões de treino de tickets resolvidos. Cada entrada aprovada melhora Discord e a API ao mesmo tempo.

Tem alguma dúvida? Abra um ticket na categoria AgencyMod em help.agencyg.de ou pergunte no nosso Discord. Política de privacidade e termos de utilização