Bỏ qua để đến nội dung

Quản lý AI Actions của AI Agent qua API.

  • Xem trước kết quả khớp JSONPath. Kiểm tra đường dẫn gốc, trường, chỉ mục mảng và ký tự đại diện trên JSON được cung cấp. Không chạy Action hoặc lưu bộ nhớ cuộc trò chuyện.

  • Kiểm tra kết nối MCP mẫu. Chỉ khởi tạo và liệt kê công cụ tại endpoint tài liệu Cloudflare hoặc Microsoft Learn. Không đăng nhập hoặc thực thi công cụ.

Trong trình duyệt tương thích, các phép kiểm tra này cũng có dưới dạng công cụ website. Liên kết mở biểu mẫu tiêu chuẩn.

AI Actions mở rộng khả năng AI Agent ngoài việc trả lời từ Cơ sở kiến thức. Bạn có thể định nghĩa hành vi được kích hoạt, tức những việc AI nên làm khi phát hiện tình huống cụ thể trong cuộc trò chuyện.

AI Actions làm gì:

  • HTTP Request Actions: gọi API bên ngoài khi được kích hoạt. Ví dụ kiểm tra đơn hàng trong backend, tạo phiếu hỗ trợ hoặc tra cứu tài khoản, ngay trong cuộc trò chuyện.
  • MCP Actions: kết nối máy chủ Model Context Protocol để tích hợp công cụ nâng cao (ví dụ tra cứu sản phẩm Shopify, truy vấn cơ sở dữ liệu tùy chỉnh).

Trường hợp sử dụng phổ biến:

  • Tra cứu thông tin thời gian thực (đơn hàng, tài khoản, tồn kho) từ hệ thống backend trong cuộc trò chuyện
  • Tạo phiếu, cập nhật bản ghi CRM hoặc kích hoạt quy trình trong hệ thống ngoài dựa trên ngữ cảnh trò chuyện
  • Đưa ra gợi ý cá nhân hóa bằng cách truy vấn danh mục sản phẩm

Mỗi Action có name, description (với HTTP Request Actions, mô tả cho AI biết khi nào kích hoạt) và cấu hình riêng theo loại. Có thể bật/tắt từng Action qua API. Actions được tạo và cấu hình đầy đủ trong bảng điều khiển Quickchat; API cung cấp thao tác liệt kê, cập nhật (bật/tắt), xóa và các endpoint riêng để tạo, cấu hình MCP Actions.

Phạm vi: read_all

GET https://app.quickchat.ai/v1/api/ai_actions

Terminal window
curl https://app.quickchat.ai/v1/api/ai_actions \
-H 'Authorization: Bearer <API_TOKEN>'

Phản hồi 200 OK

[
{
"id": 1,
"name": "Check Order Status",
"description": "Look up order status when customer asks about their order.",
"is_active": true,
"type": "http_request",
"icon": null,
"icon_color": null,
"is_valid": true
}
]
TrườngMô tả
id
số nguyên
Định danh AI Action
name
chuỗi
Tên hiển thị
description
chuỗi
Khi nào Action kích hoạt
is_active
boolean
Có đang bật không
type
chuỗi
"http_request", "remote_mcp", "shopify_remote_mcp" hoặc "knowledge_base"
icon
chuỗi hoặc null
Định danh biểu tượng
icon_color
chuỗi hoặc null
Màu biểu tượng
is_valid
boolean
Có được cấu hình đúng không
Phạm vi: write_all

PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}

Nội dung yêu cầu

Tham sốMô tả
is_active
boolean
Bật/tắt Action
icon
chuỗi
Định danh biểu tượng (tối đa 200 ký tự)
icon_color
chuỗi
Màu biểu tượng (tối đa 50 ký tự)
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/1 \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{"is_active": false}'

Phản hồi 200 OK: trả về ảnh chụp AI Action đã cập nhật.

Phạm vi: write_all

DELETE https://app.quickchat.ai/v1/api/ai_actions/{action_id}

Terminal window
curl -X DELETE https://app.quickchat.ai/v1/api/ai_actions/1 \
-H 'Authorization: Bearer <API_TOKEN>'

Phản hồi 200 OK (nội dung rỗng)

Phạm vi: write_all

POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp

Kết nối máy chủ MCP từ xa với AI Agent dưới dạng MCP Action. Yêu cầu token API có phạm vi write_all (token API yêu cầu gói Business trở lên).

Nội dung yêu cầu

Tham sốMô tả
remote_mcp_url
chuỗi, bắt buộc
URL máy chủ MCP. Phải dùng https://; URL phân giải thành địa chỉ mạng riêng hoặc nội bộ bị từ chối
headers
mảng, bắt buộc
Tiêu đề kết nối gửi tới máy chủ, ví dụ token Authorization tĩnh. Mỗi mục là {"id", "name", "value"}; chọn chuỗi duy nhất bất kỳ làm id. Gửi [] nếu máy chủ không cần
allowed_tools
mảng, bắt buộc
Công tắc từng công cụ, mỗi mục {"name", "is_active"}. Gửi [] để default_tool_is_active quyết định công cụ khả dụng
name
chuỗi
Tên hiển thị trong danh sách Actions (tối đa 100 ký tự). Mặc định lấy nhãn từ hostname máy chủ
description
chuỗi
Mô tả trong danh sách Actions (tối đa 2.500 ký tự)
icon
chuỗi
Định danh biểu tượng (tối đa 200 ký tự)
icon_color
chuỗi
Màu biểu tượng (tối đa 50 ký tự)

name và description là nhãn cho người vận hành: nhận diện Action trong bảng điều khiển và AI không bao giờ đọc chúng. AI làm việc từ mô tả công cụ do máy chủ MCP công bố.

Terminal window
curl -X POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"remote_mcp_url": "https://mcp.example.com/mcp",
"headers": [
{"id": "h-1", "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"}
],
"allowed_tools": [],
"name": "Example MCP"
}'

Phản hồi 201 Created

{
"id": 2,
"name": "Example MCP",
"description": "Connected MCP server",
"is_active": false,
"type": "remote_mcp",
"icon": "FaMixcloud",
"icon_color": "#EF4444",
"is_valid": true,
"validation_issues": [],
"remote_mcp_url": "https://mcp.example.com/mcp",
"remote_mcp_auth_token": "",
"default_tool_is_active": true,
"allowed_tools": [],
"headers": [
{"id": 10, "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"}
],
"oauth": null,
"recommended_tools": []
}
TrườngMô tả
remote_mcp_url
chuỗi
URL máy chủ MCP đã kết nối
default_tool_is_active
boolean
Có cho phép công cụ không được liệt kê trong allowed_tools không
allowed_tools
mảng
Công tắc từng công cụ, {"name", "is_active"}
headers
mảng
Tiêu đề kết nối đã lưu
remote_mcp_auth_token
chuỗi hoặc null
Trường token tĩnh cũ. Không thể đặt qua API này; truyền thông tin xác thực qua headers
oauth
đối tượng hoặc null
Trạng thái ủy quyền của máy chủ kết nối bằng đăng nhập OAuth (nếu không là null)
recommended_tools
mảng
Tên công cụ Quickchat đề xuất cho máy chủ có hồ sơ tuyển chọn (chỉ đọc)
validation_issues
mảng
Tên phép kiểm tra cấu hình thất bại; rỗng khi is_valid là true

Các trường còn lại khớp với Liệt kê tất cả AI Actions.

Action được tạo với is_active: false. Với máy chủ không có hồ sơ Quickchat tuyển chọn, ban đầu cũng có default_tool_is_active: true, nên mọi công cụ phát hiện lúc trả lời đều được phép cho đến khi bạn giới hạn. Để bật Action, dùng endpoint Cập nhật AI Action ở trên: PATCH /v1/api/ai_actions/{action_id} với {"is_active": true}.

Phạm vi: read_all

GET https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp

Terminal window
curl https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>'

Phản hồi 200 OK: trả về cấu hình riêng MCP, cùng cấu trúc với phản hồi tạo ở trên.

Phạm vi: write_all

PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp

Mọi trường đều tùy chọn; chỉ trường bạn gửi mới thay đổi.

Nội dung yêu cầu

Tham sốMô tả
remote_mcp_url
chuỗi
URL máy chủ mới (xác thực giống khi tạo). Đổi URL máy chủ kết nối OAuth sẽ xóa ủy quyền đã lưu và tắt Action
headers
mảng
Thay thế tiêu đề kết nối
allowed_tools
mảng
Thay thế công tắc từng công cụ, mỗi mục {"name", "is_active"}
default_tool_is_active
boolean
Có cho phép công cụ không liệt kê trong allowed_tools không
name
chuỗi
Tên hiển thị (tối đa 100 ký tự)
description
chuỗi
Mô tả trong danh sách Actions (tối đa 2.500 ký tự)
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"allowed_tools": [
{"name": "search_docs", "is_active": true},
{"name": "delete_page", "is_active": false}
],
"default_tool_is_active": false
}'

Phản hồi 200 OK: trả về MCP Action đã cập nhật, cùng cấu trúc với phản hồi tạo.

Kiểm tra kết nối và khám phá công cụ, tức phép thử Kết nối của bảng điều khiển, không có trên API công khai. Bảng điều khiển tự chạy phép thử khi bạn kết nối hoặc kết nối lại máy chủ. Máy chủ bảo vệ bằng OAuth phải hoàn tất ủy quyền trong bảng điều khiển; trường oauth trong phản hồi trên báo trạng thái đó.