Tạo API Key

POST /api/open/v1/keys

Tham số yêu cầu

Body yêu cầu là JSON với Content-Type: application/json. Quy tắc kiểm tra giống với việc tạo Key trong console.

Trường	Kiểu	Bắt buộc	Mặc định	Mô tả
`name`	string	Có	—	Tên, tối đa 50 ký tự (ký tự, không phải byte); không được để trống
`remain_amount`	number	Không	`0`	Số tiền khả dụng, theo tiền tệ của trang, hai chữ số thập phân; áp dụng khi `unlimited` là `false`; không được âm và không được vượt mức tối đa
`unlimited`	boolean	Không	`false`	Có phải Key không giới hạn hạn mức hay không
`expired_time`	integer	Không	`-1`	Thời gian hết hạn, giây unix; bỏ trống, `0` và `-1` đều nghĩa là không bao giờ hết hạn; nếu không phải thì phải ở tương lai và không muộn hơn 9999-12-31
`model_limits_enabled`	boolean	Không	`false`	Có bật danh sách cho phép mô hình hay không
`model_limits`	string	Không	`""`	Các mô hình được phép, phân tách bằng dấu phẩy
`allow_ips`	string	Không	—	Các IP được phép, mỗi IP một dòng; bỏ trống hoặc chuỗi rỗng nghĩa là không giới hạn

Ví dụ yêu cầu

curl -X POST https://www.routeapi.ai/api/open/v1/keys \
  -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "bot",
    "remain_amount": 5.00,
    "unlimited": false,
    "expired_time": -1,
    "model_limits_enabled": true,
    "model_limits": "gpt-4o"
  }'

Ví dụ phản hồi

{
  "success": true,
  "message": "",
  "data": {
    "id": 13,
    "name": "bot",
    "key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": 1,
    "created_time": 1729000000,
    "accessed_time": 1729000000,
    "expired_time": -1,
    "remain_amount": 5.00,
    "unlimited": false,
    "used_amount": 0.00,
    "model_limits_enabled": true,
    "model_limits": "gpt-4o",
    "allow_ips": ""
  }
}

Mô tả các trường xem tại Đối tượng Key.

Lỗi

HTTP	code	Tình huống
400	`invalid_request`	Body yêu cầu không phải JSON hợp lệ, hoặc rỗng / `null`
400	`invalid_request`	`name` bị thiếu, chỉ có khoảng trắng, hoặc dài hơn 50 ký tự
400	`invalid_request`	`expired_time` không ở tương lai (và không phải `0` / `-1`), hoặc muộn hơn 9999-12-31 (ví dụ timestamp mili giây)
400	`invalid_request`	Đã đạt giới hạn số Key mỗi người dùng
400	`invalid_request`	`remain_amount` âm hoặc vượt mức tối đa khi `unlimited` là `false`

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

Lưu ý

remain_amount bị bỏ qua khi unlimited là true.
Việc tạo Key qua API nền tảng được ghi vào nhật ký kiểm toán.