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

Liệt kê API Key

GET /api/open/v1/keys
Tham sốVị tríKiểuBắt buộcMặc địnhMô tả
pqueryintegerKhông1Số trang, từ 1 đến 1000000
page_sizequeryintegerKhông10Số mục mỗi trang, từ 1 đến 1000
namequerystringKhô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.

Terminal window
curl "https://www.routeapi.ai/api/open/v1/keys?p=1&page_size=20&name=bot" \
-H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"
{
"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ườngKiểuMô tả
itemsarrayCác đối tượng Key, sắp xếp theo ID giảm dần (mới nhất trước)
totalintegerTổng số Key khớp với bộ lọc
pageintegerSố trang hiện tại
page_sizeintegerSố mục thực tế mỗi trang

Mọi endpoint API nền tảng trả về Key đều dùng cùng một cấu trúc:

TrườngKiểuMô tả
idintegerID của Key, dùng làm :id trong các endpoint khác
namestringTên
keystringGiá trị Key có tiền tố sk-; bị che ở mọi nơi trừ endpoint tạo và Xem API Key đầy đủ
statusinteger1 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_timeintegerThời gian tạo, giây unix
accessed_timeintegerThời gian sử dụng gần nhất, giây unix
expired_timeintegerThời gian hết hạn, giây unix; -1 nghĩa là không bao giờ hết hạn
remain_amountnumberSố 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
unlimitedbooleanCó phải Key không giới hạn hạn mức hay không
used_amountnumberSố tiền đã dùng, hai chữ số thập phân
model_limits_enabledbooleanDanh sách cho phép mô hình có được bật hay không
model_limitsstringCác mô hình được phép, phân tách bằng dấu phẩy
allow_ipsstringCá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