Chương · Kết nối AI agent
Tra cứu REST API
Dùng REST API trên máy với khoá Bearer, xem tài liệu OpenAPI và theo dõi công việc mà không gửi lại yêu cầu trùng lặp.
Trước khi bắt đầu
- Bật API cho agent và tạo khoá có quyền phù hợp.
- URL gốc mặc định là http://127.0.0.1:47821/v1. Nếu đã đổi cổng, dùng địa chỉ hiện tại trong app.
1Kiểm tra kết nối máy chủ
Mở Cài đặt › API & agent. Giữ kết nối chỉ trên máy này nếu máy khác không cần dùng. Gửi khoá bằng Authorization: Bearer, không đặt trong URL.
2Đọc trạng thái
Chạy lệnh này trong cửa sổ dòng lệnh và thay khoá mẫu bằng khoá của bạn. Trên Windows, curl.exe tránh trùng tên lệnh trong PowerShell.
powershell curl.exe "http://127.0.0.1:47821/v1/status" -H "Authorization: Bearer msk_YOUR_KEY"3Chọn đường dẫn API
Các đường dẫn sau được nối vào URL gốc:
- GET /health — kiểm tra máy chủ; không cần khoá.
- GET /openapi.json — cấu trúc API; không cần khoá.
- GET /status — trạng thái và khả năng hỗ trợ.
- GET hoặc POST /jobs — liệt kê hoặc gửi việc.
- GET /jobs/{id} — chi tiết và kết quả công việc.
- POST /jobs/{id}/cancel — yêu cầu huỷ.
- POST /references — tải dữ liệu tệp tham chiếu lên.
- GET hoặc HEAD /assets/{id}/content — lấy kết quả bằng khoá hoặc chữ ký hợp lệ.
- GET /conversations/{id} — đọc hội thoại.
- POST /assets/{id}/extend hoặc /conversations/{id}/extend — bắt đầu nối video.
- GET /extend-chains/{id} — đọc chuỗi nối video.
- POST /extend-chains/{id}/cancel — huỷ chuỗi.
4Dùng tài liệu từ máy chủ
Máy chủ cung cấp tài liệu OpenAPI tại http://127.0.0.1:47821/v1/openapi.json, không cần khoá. Xem tài liệu để biết trường gửi và dữ liệu trả về. Mỗi lần gửi mới dùng request_id riêng; giữ nguyên khi thử lại chính yêu cầu bị gián đoạn.
5Theo dõi việc đã gửi
Theo dõi bằng ID công việc được trả về. Không gửi lại việc running hoặc needs_review. Tuân theo quy tắc thử lại MCP, vì hai cách kết nối dùng cùng hệ thống công việc.
Kiểm tra thành công
Yêu cầu trạng thái có xác thực thành công và ứng dụng của bạn đọc được cấu trúc API.
Nếu không chạy
Vì sao health chạy được nhưng status lỗi?
Health không yêu cầu khoá. Status cần khoá còn hiệu lực trong header Bearer.
Vì sao nhận lỗi không tìm thấy?
Kiểm tra URL gốc có /v1, rồi đối chiếu đường dẫn và phương thức với tài liệu OpenAPI.