Liệt kê API Key
GET /api/open/v1/keysTham số yêu cầu
Phần tiêu đề “Tham số yêu cầu”| Tham số | Vị trí | Kiểu | Bắt buộc | Mặc định | Mô tả |
|---|---|---|---|---|---|
p | query | integer | Không | 1 | Số trang, từ 1 đến 1000000 |
page_size | query | integer | Không | 10 | Số mục mỗi trang, từ 1 đến 1000 |
name | query | string | Không | — | Lọc theo tên Key chính xác; lặp lại tham số cho nhiều giá trị (?name=a&name=b). Không hỗ trợ dấu phẩy vì tên có thể chứa dấu phẩy |
Mỗi tham số đa giá trị nhận tối đa 50 giá trị; vượt quá sẽ trả về 400 invalid_request. Khi đặt name, total phản ánh kết quả sau lọc. p / page_size được truyền rõ ràng nhưng không hợp lệ sẽ trả về 400; xem Phân trang.
Ví dụ yêu cầu
Phần tiêu đề “Ví dụ yêu cầu”curl "https://www.routeapi.ai/api/open/v1/keys?p=1&page_size=20&name=bot" \ -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"Ví dụ phản hồi
Phần tiêu đề “Ví dụ phản hồi”{ "success": true, "message": "", "data": { "items": [ { "id": 12, "name": "bot", "key": "sk-abcd**********wxyz", "status": 1, "created_time": 1729000000, "accessed_time": 1729000000, "expired_time": -1, "remain_amount": 10.00, "unlimited": false, "used_amount": 0.00, "model_limits_enabled": true, "model_limits": "gpt-4o,gpt-4o-mini", "allow_ips": "" } ], "total": 1, "page": 1, "page_size": 20 }}Trường phản hồi
Phần tiêu đề “Trường phản hồi”| Trường | Kiểu | Mô tả |
|---|---|---|
items | array | Các đối tượng Key, sắp xếp theo ID giảm dần (mới nhất trước) |
total | integer | Tổng số Key khớp với bộ lọc |
page | integer | Số trang hiện tại |
page_size | integer | Số mục thực tế mỗi trang |
Đối tượng Key
Phần tiêu đề “Đối tượng Key”Mọi endpoint API nền tảng trả về Key đều dùng cùng một cấu trúc:
| Trường | Kiểu | Mô tả |
|---|---|---|
id | integer | ID của Key, dùng làm :id trong các endpoint khác |
name | string | Tên |
key | string | Giá trị Key có tiền tố sk-; bị che ở mọi nơi trừ endpoint tạo và Xem API Key đầy đủ |
status | integer | 1 bật, 2 đã tắt (tắt thủ công; có thể bật lại), 3 đã hết hạn, 4 đã hết hạn mức; bật/tắt qua endpoint cập nhật (chỉ nhận 1 / 2) |
created_time | integer | Thời gian tạo, giây unix |
accessed_time | integer | Thời gian sử dụng gần nhất, giây unix |
expired_time | integer | Thời gian hết hạn, giây unix; -1 nghĩa là không bao giờ hết hạn |
remain_amount | number | Số tiền khả dụng còn lại, hai chữ số thập phân; không có ý nghĩa khi unlimited là true |
unlimited | boolean | Có phải Key không giới hạn hạn mức hay không |
used_amount | number | Số tiền đã dùng, hai chữ số thập phân |
model_limits_enabled | boolean | Danh sách cho phép mô hình có được bật hay không |
model_limits | string | Các mô hình được phép, phân tách bằng dấu phẩy |
allow_ips | string | Các IP được phép, mỗi IP một dòng; chuỗi rỗng nghĩa là không giới hạn |
Lưu ý
Phần tiêu đề “Lưu ý”- Số tiền dùng tiền tệ hiển thị của trang, xem Lấy số dư.
- Mã lỗi chung xem tại Lỗi API nền tảng.