Agency Docs

AgencyMod API

Používej svůj AgencyMod s AgencyAI ve svém vlastním ticket systému, na webu nebo helpdesku. Odpovídá podle všeho, co jsi nastavil v dashboardu: jméno, tón, úroveň, instrukce, znalosti, dokumentace a to, co se naučil od tvého týmu.

Jak začít

  1. 01Otevři dashboard, záložku AI, a vytvoř klíč v sekci AgencyMod API. Zkopíruj ho hned, zobrazí se jen jednou.
  2. 02Ulož klíč na svůj server. Nikdy ho nevkládej na web, do aplikace nebo kamkoli, co mohou otevřít jiní.
  3. 03Pošli konverzaci z ticketu do API s hlavičkou Authorization: Bearer a svým klíčem.
  4. 04Zobraz odpověď ve svém ticketu. Pokud je needs_team true, upozorni svůj tým.

Příklad

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

Požadavek

POST s tělem JSON. Čtou se tato pole: POST https://bot.agencyscripts.dev/api/v1/chat

messages
Konverzace, nejstarší jako první, až 20 zpráv. role je user pro zákazníka a assistant pro dřívější odpovědi bota, content je text. Poslední zpráva musí být od uživatele. Povinné.
customer
Jméno zákazníka, aby mu bot mohl říkat jménem. Volitelné.
messages[].name
Uvnitř zprávy: jméno člověka, který ji napsal. Hodí se, když ve ticketu píše více lidí. Volitelné.

Odpověď

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
Odpověď jako prostý text s jednoduchým markdownem.
needs_team
true, pokud má převzít člověk, například u plateb, banů nebo problémů, které bot nevyřeší.
bot
Jméno a avatar z tvého brandingu, aby odpověď vypadala stejně jako v Discordu.
level
Úroveň AgencyAI, která odpověděla: V1, V1.5 nebo V2.
usage
Zbývající kvóta v procentech, tvůj dobíjecí kredit a tvé limity požadavků.
ai_notice
Krátká poznámka, že odpověď napsala AI. Ukaž ji svým zákazníkům, ať vždy vědí, že odpovídala AI.

Zkontroluj svou kvótu

GET požadavek na /api/v1/status se stejnou hlavičkou vrátí jméno a avatar bota a tvou zbývající kvótu, aniž by se cokoli spotřebovalo.

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

Limity a kvóta

  1. 01S Premium může API využít až polovinu tvé týdenní kvóty AI, takže pro Discord vždy něco zbyde. Kvóta se obnovuje každé pondělí.
  2. 02Když je kvóta API vyčerpaná, pokračuje se z tvého dobíjecího kreditu. Dobíjení najdeš v dashboardu, v záložce AI, a nikdy nevyprší.
  3. 03Bez Premium dostaneš malou zkušební kvótu na úrovni V1. Potřebuje aspoň 20 členů a AgencyMod na tvém serveru 7 dní.
  4. 0420 požadavků za minutu na klíč, 1 000 požadavků za den s Premium a 150 bez něj. Až 5 klíčů na server.

Chyby

400
Chybí messages, nebo poslední zpráva není od uživatele.
401
Klíč chybí, je špatný nebo zrušený.
402
Kvóta je vyčerpaná. Dobij ji nebo si pořiď Premium.
403
Server zatím nesplňuje požadavky na API bez Premium.
429
Příliš mnoho požadavků. Počkej chvíli a zkus to znovu.
503
AgencyAI neodpověděla. Zkus to znovu.
BezpečnostKaždý, kdo má tvůj klíč, využívá tvou kvótu AI. Pokud klíč unikne, zruš ho v dashboardu a vytvoř nový. API je určené pro volání z tvého serveru, prohlížeče ho nemohou volat přímo.
Lepší odpovědiAPI používá stejné znalosti jako tvůj bot v Discordu. Vyplň znalosti a odkazy na dokumentaci v záložce AI a schval návrhy tréninku z vyřešených ticketů. Každý schválený záznam zlepší najednou Discord i API.

Něco není jasné? Otevři tiket na help.agencyg.de v kategorii AgencyMod nebo se zeptej na našem Discordu. Zásady ochrany osobních údajů a podmínky

Po této stránce stále nevíte, jak dál? Přebírá to naše podpora.