AgencyMod API

Dùng AgencyMod của bạn với AgencyAI trong hệ thống ticket, trang web hoặc helpdesk riêng. Nó trả lời với mọi thứ bạn đã thiết lập trong bảng điều khiển: tên, giọng điệu, cấp độ, hướng dẫn, kiến thức, tài liệu và những gì nó đã học từ đội của bạn.

Mở bảng điều khiển Cài đặt AI

Bắt đầu

01Mở bảng điều khiển, tab AI, và tạo khóa dưới AgencyMod API. Sao chép ngay, khóa chỉ được hiện một lần.
02Lưu khóa trên máy chủ của bạn. Không bao giờ đặt nó vào trang web, ứng dụng hay bất cứ thứ gì người khác có thể mở.
03Gửi cuộc trò chuyện của một ticket đến API với header Authorization: Bearer và khóa của bạn.
04Hiển thị câu trả lời trong ticket. Nếu needs_team là true, hãy thông báo cho đội của bạn.

Ví dụ

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

Yêu cầu

POST với nội dung JSON. Các trường sau được đọc: POST https://bot.agencyscripts.dev/api/v1/chat

messages: Cuộc trò chuyện, cũ nhất trước, tối đa 20 tin nhắn. role là user cho khách hàng và assistant cho các câu trả lời trước của bot, content là văn bản. Tin nhắn cuối phải đến từ user. Bắt buộc.
customer: Tên khách hàng, để bot có thể xưng hô. Tùy chọn.
messages[].name: Bên trong một tin nhắn: tên người đã viết, hữu ích khi nhiều người viết trong cùng một ticket. Tùy chọn.

Phản hồi

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: Câu trả lời dạng văn bản thuần với markdown đơn giản.
needs_team: true nếu cần người thật tiếp nhận, ví dụ với thanh toán, lệnh cấm hoặc những vấn đề bot không giải quyết được.
bot: Tên và avatar từ thương hiệu của bạn, để hiển thị câu trả lời giống hệt trong Discord.
level: Cấp độ AgencyAI đã trả lời: V1, V1.5 hoặc V2.
usage: Hạn mức còn lại theo phần trăm, số dư nạp và giới hạn yêu cầu của bạn.
ai_notice: Một ghi chú ngắn cho biết câu trả lời do AI viết. Hiển thị nó cho khách hàng để họ luôn biết có AI trả lời.

Kiểm tra hạn mức

Một yêu cầu GET đến /api/v1/status với cùng header sẽ trả về tên và avatar của bot cùng hạn mức còn lại của bạn, mà không dùng bất kỳ phần nào.

cURL

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

Giới hạn và hạn mức

01Với Premium, API có thể dùng tối đa một nửa hạn mức AI hằng tuần của bạn, nên luôn còn hạn mức cho Discord. Hạn mức được đặt lại mỗi thứ Hai.
02Khi hạn mức API hết, API tiếp tục dùng số dư nạp của bạn. Nạp tiền nằm trong bảng điều khiển, tab AI, và không bao giờ hết hạn.
03Không có Premium, bạn nhận một hạn mức dùng thử nhỏ ở cấp V1. Cần ít nhất 20 thành viên và AgencyMod trên máy chủ của bạn trong 7 ngày.
0420 yêu cầu mỗi phút cho mỗi khóa, 1,000 yêu cầu mỗi ngày với Premium và 150 khi không có. Tối đa 5 khóa cho mỗi máy chủ.

Lỗi

400: Thiếu messages, hoặc tin nhắn cuối không đến từ user.
401: Khóa bị thiếu, sai hoặc đã bị thu hồi.
402: Hạn mức đã dùng hết. Nạp thêm hoặc lấy Premium.
403: Máy chủ chưa đáp ứng yêu cầu dùng API khi không có Premium.
429: Quá nhiều yêu cầu. Hãy chờ một chút rồi thử lại.
503: AgencyAI không trả lời. Hãy thử lại.

Bảo mậtAi có khóa của bạn đều dùng hạn mức AI của bạn. Nếu khóa bị lộ, hãy thu hồi nó trong bảng điều khiển và tạo khóa mới. API được thiết kế để gọi từ máy chủ của bạn, trình duyệt không thể gọi trực tiếp.

Câu trả lời tốt hơnAPI dùng cùng kiến thức với bot của bạn trong Discord. Hãy điền kiến thức và liên kết tài liệu trong tab AI, và duyệt các gợi ý huấn luyện từ ticket đã giải quyết. Mỗi mục được duyệt sẽ cải thiện Discord và API cùng lúc.

Có điều gì chưa rõ? Mở ticket tại help.agencyg.de trong danh mục AgencyMod hoặc hỏi trên Discord của chúng tôi. Chính sách bảo mật và điều khoản