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

Xem API Key đầy đủ

GET /api/open/v1/keys/:id/key

Trả về cùng đối tượng Key như Lấy một API Key, nhưng key là giá trị sk-... đầy đủ thay vì dạng đã che. Dùng endpoint này khi một tích hợp bên thứ ba cần lưu hoặc xoay vòng Key mà không bắt người dùng sao chép giá trị từ console.

Tham sốVị tríKiểuBắt buộcMô tả
idpathintegerCóID của Key, số nguyên dương
Terminal window
curl https://www.routeapi.ai/api/open/v1/keys/12/key \
-H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"
{
"success": true,
"message": "",
"data": {
"id": 12,
"name": "bot",
"key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": 1,
"created_time": 1729000000,
"accessed_time": 1729000000,
"expired_time": -1,
"remain_amount": 10.00,
"unlimited": false,
"used_amount": 0.00,
"model_limits_enabled": false,
"model_limits": "",
"allow_ips": ""
}
}

Phản hồi mang tiêu đề Cache-Control: no-store để trình duyệt và proxy không lưu bộ nhớ đệm Key dạng rõ. Mô tả các trường xem tại Đối tượng Key.

HTTPcodeTình huống
400invalid_requestid không phải số nguyên dương
403insufficient_scopeManagement Key không có quyền mà endpoint này yêu cầu
404not_foundKey không tồn tại hoặc không thuộc về bạn
429rate_limitedVượt giới hạn tần suất theo Management Key
429—Vượt giới hạn tần suất theo IP client (mặc định 100 yêu cầu/20 phút cho các endpoint nhạy cảm); body có thể trống

Các mã lỗi chung khác xem tại Lỗi API nền tảng.

  • Mỗi lần gọi thành công đều ghi một sự kiện kiểm toán (open_api.key.reveal) lưu ID và tên Key cùng Management Key đã dùng. Key dạng rõ không bao giờ được ghi vào kiểm toán hay log.
  • Endpoint này chịu giới hạn tần suất chặt hơn các endpoint đọc thông thường vì nó trả về thông tin bí mật.
  • Key đầy đủ cũng được trả về một lần khi tạo API Key. Nên lưu lại ngay khi tạo và chỉ gọi endpoint này khi giá trị đã lưu bị mất hoặc cần xoay vòng.
  • Lấy một API Key và Liệt kê API Key vẫn trả về giá trị đã che.