AgencyMod API

在你自己的工单系统、网站或帮助台中使用你的 AgencyMod 与 AgencyAI。它使用你在控制面板中设置的一切进行回复：名称、语气、等级、指令、知识、文档以及从你的团队那里学到的内容。

开始使用

01打开控制面板，进入 AI 选项卡，并在 AgencyMod API 下创建密钥。立即复制它，因为它只显示一次。
02在你的服务器上保存密钥。永远不要将其放在网站、应用或其他人可以打开的地方。
03使用 Authorization: Bearer 标头和你的密钥，将工单的对话发送到 API。
04在你的工单中显示答案。如果 needs_team 为 true，通知你的团队。

示例

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

请求

POST 请求，包含 JSON 正文。这些字段会被读取： POST https://bot.agencyscripts.dev/api/v1/chat

messages: 对话，从最旧到最新，最多 20 条消息。role 对客户是 user，对之前的机器人回复是 assistant，content 是文本。最后一条消息必须来自 user。必需。
customer: 客户的名称，这样机器人可以称呼他们。可选。
messages[].name: 在消息中：写该消息的人的名称，当多个人在一个工单中写消息时很有用。可选。

响应

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: 纯文本回复，带简单的 markdown 格式。
needs_team: 如果需要人类接手，则为 true，例如付款、封禁或机器人无法解决的问题。
bot: 你的品牌名称和头像，以便像在 Discord 中那样显示答案。
level: 回答的 AgencyAI 等级：V1、V1.5 或 V2。
usage: 剩余配额百分比、你的充值余额和请求限制。
ai_notice: 指出答案由 AI 编写的简短说明。向你的客户显示它，这样他们总是知道是 AI 在回答。

检查你的配额

向 /api/v1/status 发送 GET 请求，使用相同的标头，会返回机器人的名称和头像以及你的剩余配额，而不消耗配额。

cURL

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

限制和配额

01使用 Premium，API 可以使用你每周 AI 配额的最多一半，这样 Discord 始终有可用配额。配额每周一重置。
02API 配额用完后，会继续使用你的充值余额。充值可以在控制面板的 AI 选项卡中进行，永不过期。
03不使用 Premium，你会在 V1 等级获得小额试用配额。这需要你的服务器至少有 20 个成员，并且已安装 AgencyMod 满 7 天。
04每个密钥每分钟 20 个请求，使用 Premium 时每天 1000 个请求，不使用时 150 个。每个服务器最多 5 个密钥。

错误

400: 缺少 messages，或最后一条消息不是来自 user。
401: 密钥缺失、错误或已被撤销。
402: 配额已用完。充值或获取 Premium。
403: 不使用 Premium 的服务器还不满足 API 的要求。
429: 请求过多。等一下再试一次。
503: AgencyAI 未回答。请重试。

安全任何拥有你的密钥的人都可以使用你的 AI 配额。如果密钥泄露，在控制面板中撤销它并创建新密钥。API 是为来自你服务器的调用而设计的，浏览器无法直接调用它。

更好的答案API 使用与你在 Discord 中机器人相同的知识。填写 AI 选项卡中的知识和文档链接，并批准已解决工单中的训练建议。每个批准的条目同时改进 Discord 和 API。

有疑问？请在 help.agencyg.de 的 AgencyMod 分类中创建工单，或在我们的 Discord 中提问。隐私政策与服务条款