Tài liệu BasicRouter
Bắt đầu nhanh
BasicRouter mang đến cho các đội ngũ sản xuất một API ổn định duy nhất để truy cập mô hình, định tuyến, dự phòng, theo dõi mức sử dụng và thanh toán dựa trên tín dụng. Nguồn cung cấp token LLM được lấy từ các tài khoản nhà cung cấp gốc đám mây doanh nghiệp đáng tin cậy, với bảo vệ quyền riêng tư, độ ổn định cao và khả năng truy vết yêu cầu được tích hợp sẵn trong cổng kết nối.
https://api.basicrouter.ai/apihttps://api.basicrouter.ai/api/v1https://api.basicrouter.ai/api/v1Authorization: Bearer <key>Tạo khóa API
Tạo khóa API BasicRouter trong bảng điều khiển. Giữ khóa trên máy chủ của bạn và không bao giờ tiết lộ trong mã trình duyệt hoặc ứng dụng khách di động.
Chiến lược khóa được khuyến nghị:
| Loại khóa | Cách sử dụng khuyến nghị |
|---|---|
| Khóa phát triển | Phát triển cục bộ, môi trường staging, kiểm thử và nguyên mẫu. |
| Khóa sản xuất | Chỉ dành cho khối lượng công việc sản xuất backend. |
| Khóa tích hợp | Khóa dành riêng cho các công cụ như Cursor, Claude Code, Codex, Hermes hoặc OpenClaw. |
| Khóa khách hàng / đối tượng thuê | Cách ly khóa tùy chọn cho khách hàng doanh nghiệp, lưu lượng đối tượng thuê hoặc các đơn vị kinh doanh. |
Xoay vòng khóa khi quyền truy cập nhóm thay đổi. Thu hồi các khóa không còn được sử dụng.
Trỏ SDK của bạn tới BasicRouter
Hầu hết các ứng dụng khách tương thích OpenAI chỉ cần một URL cơ sở và khóa API mới.
import OpenAI from "openai";
const client = new OpenAI({
apiKey: process.env.BASICROUTER_API_KEY,
baseURL: "https://api.basicrouter.ai/api/v1"
});Gửi một yêu cầu hoàn thành trò chuyện
curl --request POST \
--url https://api.basicrouter.ai/api/v1/chat/completions \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"model": "claude-sonnet-5",
"messages": [
{ "role": "user", "content": "Explain BasicRouter in one sentence." }
]
}'Kiểm tra mức sử dụng và số dư
curl --request GET \
--url https://api.basicrouter.ai/api/v1/billing/balance \
--header "Authorization: Bearer $BASICROUTER_API_KEY"Khám phá mô hình
Sử dụng trang Mô hình hoặc API Mô hình để kiểm tra các mô hình văn bản có sẵn. Siêu dữ liệu mô hình bao gồm nhà cung cấp, nhà cung cấp dịch vụ, phương thức, độ dài ngữ cảnh, họ API được hỗ trợ, khả năng được hỗ trợ, tình trạng sẵn có, giới hạn cấp tài khoản và giá tín dụng.
Điểm cuối: GET /v1/models Mục đích: Liệt kê các mô hình sẵn có cho tài khoản hiện tại.
curl --request GET \
--url https://api.basicrouter.ai/api/v1/models \
--header "Authorization: Bearer $BASICROUTER_API_KEY"Ma trận khả năng
| Khả năng | Mô tả | Thường được sử dụng bởi |
|---|---|---|
streaming | Hỗ trợ phát trực tuyến sự kiện do máy chủ gửi. | Ứng dụng trò chuyện, tác nhân lập trình, UX thời gian thực. |
tool_calling | Hỗ trợ gọi công cụ hoặc hàm. | Tác nhân, tự động hóa quy trình, trợ lý lập trình. |
structured_outputs | Hỗ trợ đầu ra ràng buộc theo lược đồ hoặc JSON. | Trích xuất dữ liệu, tự động hóa quy trình, ứng dụng doanh nghiệp. |
json_mode | Có thể trả về đầu ra định dạng JSON. | Phản hồi có cấu trúc nhẹ. |
vision | Chấp nhận đầu vào hình ảnh. | Trò chuyện đa phương thức, phân tích UI, ảnh chụp tài liệu. |
prompt_caching | Hỗ trợ đầu vào được lưu vào bộ nhớ đệm hoặc tái sử dụng ngữ cảnh. | Tác nhân ngữ cảnh dài, lời nhắc hệ thống lặp lại. |
reasoning | Hỗ trợ điều khiển suy luận rõ ràng khi có sẵn. | Quy hoạch phức tạp, lập trình, quy trình phân tích. |
logprobs | Hỗ trợ đầu ra xác suất token. | Đánh giá, xếp hạng, quy trình NLP nâng cao. |
Ma trận tương thích họ API
| Họ API | Văn bản | Đầu vào hình ảnh | Gọi công cụ | Đầu ra có cấu trúc | Phát trực tuyến | Ghi chú |
|---|---|---|---|---|---|---|
| OpenAI Chat Completions | Có | Tùy thuộc mô hình | Tùy thuộc mô hình | Tùy thuộc mô hình | Có | Lựa chọn mặc định tốt nhất cho các tác nhân và SDK tương thích OpenAI. |
| OpenAI Responses | Có | Tùy thuộc mô hình | Tùy thuộc mô hình | Tùy thuộc mô hình | Có | Được khuyến nghị cho quy trình tác nhân kiểu OpenAI mới hơn. |
| Anthropic Messages | Có | Tùy thuộc mô hình | Tùy thuộc mô hình | Tùy thuộc mô hình | Có | Tốt nhất cho ứng dụng khách tương thích Claude và Claude Code. |
| Tạo hình ảnh BasicRouter | Không | Tùy thuộc mô hình | Không | Không | Không | Sử dụng thăm dò tác vụ không đồng bộ hoặc webhook. |
| Tạo video BasicRouter | Không | Tùy thuộc mô hình | Không | Không | Không | Sử dụng thăm dò tác vụ không đồng bộ hoặc webhook. |
Xác thực
Mọi yêu cầu API đều sử dụng bearer token. Lưu khóa trong biến môi trường phía máy chủ, xoay vòng khi quyền truy cập nhóm thay đổi và ghi lại ID yêu cầu để gỡ lỗi.
| Header | Giá trị | Ghi chú |
|---|---|---|
Authorization | Bearer YOUR_API_KEY | Bắt buộc cho mọi yêu cầu. |
Content-Type | application/json | Bắt buộc cho phần thân yêu cầu JSON. |
Khuyến nghị bảo mật khóa
- Giữ khóa API trên máy chủ. Không tiết lộ khóa trong mã trình duyệt hoặc ứng dụng khách di động.
- Sử dụng các khóa riêng biệt cho phát triển, staging, sản xuất và tích hợp bên thứ ba.
- Phạm vi hóa khóa theo môi trường, dịch vụ, khách hàng hoặc đối tượng thuê khi có sẵn.
- Xoay vòng khóa sau khi nhân viên nghỉ việc, quyền truy cập nhà cung cấp thay đổi hoặc nghi ngờ rò rỉ.
- Lưu khóa trong trình quản lý bí mật hoặc biến môi trường, không phải mã nguồn.
Sử dụng bảng điều khiển
Bảng điều khiển BasicRouter là mặt phẳng điều khiển vận hành cho truy cập API, tính khả dụng của mô hình, chính sách định tuyến, hiển thị mức sử dụng và quản lý thanh toán. Nó cung cấp cho quản trị viên tài khoản một chế độ xem tập trung về các khóa, mô hình, yêu cầu, tín dụng và điều khiển cấp tài khoản cho lưu lượng mô hình sản xuất.
Quản lý khóa API
Tạo, xoay vòng, thu hồi và gắn nhãn khóa API từ bảng điều khiển. Sử dụng các khóa riêng biệt cho phát triển, dàn dựng, sản xuất và các dịch vụ riêng lẻ để mức sử dụng có thể được kiểm toán và cô lập theo môi trường hoặc ứng dụng.
| Thực hành | Mô tả |
|---|---|
| Môi trường riêng biệt | Sử dụng các khóa API khác nhau cho lưu lượng phát triển, dàn dựng và sản xuất. |
| Sử dụng nhãn mô tả | Gắn nhãn khóa theo ứng dụng, dịch vụ, môi trường hoặc tích hợp. |
| Xoay vòng thường xuyên | Xoay vòng khóa khi quyền truy cập thay đổi hoặc thông tin đăng nhập có thể đã bị lộ. |
| Tránh lộ ở phía máy khách | Chỉ giữ khóa API trên các hệ thống phía máy chủ. Không để lộ khóa trong mã máy khách trình duyệt hoặc di động. |
| Theo dõi mức sử dụng khóa | Xem xét khối lượng yêu cầu, mức tiêu thụ tín dụng và các mẫu lỗi theo khóa. |
Danh sách mô hình
Sử dụng trang Mô hình để xem xét các mô hình sẵn có cho tài khoản. Mỗi mục mô hình có thể bao gồm nhà cung cấp, nhà cung cấp dịch vụ, phương thức, họ API được hỗ trợ, độ dài ngữ cảnh, cờ khả năng, tình trạng sẵn có và thông tin giá.
| Bộ lọc | Mục đích |
|---|---|
| Nhà cung cấp | Lọc theo nhà cung cấp mô hình như OpenAI, Anthropic, Google, Qwen, DeepSeek hoặc các nhà cung cấp khác. |
| Nhà cung cấp dịch vụ | Lọc theo nhà cung cấp dịch vụ hoặc nhà cung cấp đám mây. |
| Phương thức | Lọc theo hỗ trợ văn bản, hình ảnh, video, nhúng, âm thanh hoặc đa phương thức. |
| Khả năng | Lọc theo hỗ trợ phát trực tuyến, gọi công cụ, đầu ra có cấu trúc, thị giác, bộ nhớ đệm prompt, hoặc suy luận. |
| Tình trạng sẵn có | Xác định các mô hình hiện có sẵn cho tài khoản. |
Cho các ứng dụng sản xuất, xác minh khả năng mô hình trước khi bật lưu lượng. Một số tham số và tính năng phụ thuộc vào mô hình và có thể không được hỗ trợ trên tất cả các họ API.
Sử dụng & nhật ký
Chế độ xem Sử dụng & Nhật ký cung cấp hiển thị vận hành cho lưu lượng API. Các nhóm có thể kiểm tra khối lượng yêu cầu, mô hình đã chọn, mục tiêu định tuyến đã giải quyết, mức tiêu thụ tín dụng, độ trễ, mã lỗi và ID yêu cầu.
- Khắc phục sự cố yêu cầu thất bại.
- Nhận diện các tải công việc chi phí cao.
- So sánh mức sử dụng mô hình giữa các ứng dụng và môi trường.
- Xác thực hành vi định tuyến và dự phòng.
- Điều tra vấn đề độ trễ hoặc tính khả dụng của nhà cung cấp.
- Cung cấp ID yêu cầu khi liên hệ hỗ trợ.
Mỗi phản hồi API bao gồm hoặc tiết lộ một ID yêu cầu BasicRouter. Lưu ID này trong nhật ký ứng dụng của bạn để làm cho việc gỡ lỗi sản xuất và leo thang hỗ trợ hiệu quả hơn.
Dự phòng
Dự phòng là cơ chế khả năng phục hồi của BasicRouter. Khi mô hình chính hoặc chính sách định tuyến thất bại, hệ thống tự động chuyển sang mô hình dự phòng để tiếp tục xử lý yêu cầu. Điều này giữ cho ứng dụng của bạn phản hồi tốt và giảm thiểu rủi ro gián đoạn dịch vụ.
Dự phòng hoạt động như một lưới an toàn, giữ cho ứng dụng của bạn chạy trơn tru ngay cả khi xảy ra lỗi mô hình, giới hạn hạn ngạch hoặc biến động mạng.
Tại sao dự phòng quan trọng
Trong sản xuất, các dịch vụ mô hình có thể gặp một số vấn đề không thể đoán trước:
- Lỗi dịch vụ mô hình: API thượng nguồn tạm thời không khả dụng hoặc hết thời gian chờ.
- Biến động hiệu suất: tải mô hình cao dẫn đến phản hồi chậm hoặc thất bại.
- Lỗi định tuyến: tất cả các mô hình ứng viên được chọn bằng định tuyến thông minh đều không khả dụng.
Dự phòng giữ cho ứng dụng của bạn sẵn có bằng cách cung cấp một đường dẫn dự phòng đáng tin cậy.
Ưu điểm cốt lõi
| Ưu điểm | Mô tả |
|---|---|
| Tính khả dụng cao | Chuyển đổi dự phòng tự động giữ cho dịch vụ chạy và giảm thiểu tác động của gián đoạn. |
| Chuyển đổi minh bạch | Hệ thống chuyển đổi mô hình tự động — không cần thay đổi mã ứng dụng. |
| Cấu hình linh hoạt | Hỗ trợ cả cấu hình theo yêu cầu và cấp tài khoản cho các trường hợp sử dụng khác nhau. |
| Tối ưu chi phí | Chọn một mô hình tiết kiệm chi phí hơn làm dự phòng để kiểm soát chi phí khẩn cấp. |
| Quản lý tập trung | Cấu hình một lần ở cấp tài khoản và nó tự động áp dụng cho mọi yêu cầu. |
Cấu hình mô hình dự phòng toàn cục
BasicRouter hỗ trợ thiết lập mô hình dự phòng toàn cục từ backend bảng điều khiển. Tất cả các yêu cầu tự động sử dụng mô hình này làm dự phòng khi thất bại.
Cách cấu hình:
- Đi đến trang cài đặt chiến lược BasicRouter.
- Tìm cài đặt Mô hình dự phòng mặc định.
- Chọn mô hình dự phòng toàn cục của bạn từ danh sách thả xuống.
- Lưu cài đặt để áp dụng ngay lập tức.
Ưu điểm của cấu hình toàn cục:
- Không cần thay đổi mã: cấu hình một lần và áp dụng toàn cục, không cần lặp lại cài đặt trên mỗi yêu cầu.
- Quản lý tập trung: quản lý chính sách dự phòng tại một nơi để dễ điều chỉnh và theo dõi hơn.
- Bảo trì đơn giản: giảm độ phức tạp của mã và khả năng xảy ra lỗi cấu hình.
- Ghi đè linh hoạt: cấu hình dự phòng cấp yêu cầu có ưu tiên và có thể ghi đè cài đặt toàn cục cho các kịch bản cụ thể.
Cấu hình dự phòng cấp yêu cầu
Cho các kịch bản kinh doanh cụ thể, bạn có thể chỉ định một mô hình dự phòng trên từng yêu cầu để ghi đè cấu hình toàn cục.
Chỉ định mô hình dự phòng với tham số router.fallBackModels:
{
"model": "claude-sonnet-4",
"messages": [
{
"role": "user",
"content": "Explain what quantum computing is"
}
],
"router": {
"fallBackModels": ["glm-5.2"]
}
}Quy tắc ưu tiên
Khi có nhiều cấu hình dự phòng, ưu tiên chạy từ cao nhất đến thấp nhất:
router.fallBackModelscấp yêu cầu: mô hình dự phòng được chỉ định trên một yêu cầu riêng lẻ.- Mô hình dự phòng mặc định toàn cục: mô hình dự phòng toàn cục được cấu hình trong bảng điều khiển.
- Không có dự phòng: nếu không cấu hình cái nào, yêu cầu trả về lỗi khi thất bại.
- Nếu tất cả các mô hình dự phòng thất bại, hệ thống trả về lý do thất bại từ mô hình cuối cùng được thử.
- Khi xảy ra dự phòng, phản hồi chỉ ra mô hình thực sự được sử dụng, giúp dễ theo dõi và phân tích.
Quản trị tài khoản
Tùy thuộc vào loại tài khoản, bảng điều khiển có thể bao gồm kích hoạt mô hình cấp tài khoản, điều khiển đại lý phân phối hoặc nhà phân phối, cấu hình thanh toán và cài đặt truy cập. Quản trị viên có thể sử dụng các điều khiển này để căn chỉnh quyền truy cập mô hình, hiển thị mức sử dụng và trách nhiệm thanh toán với các ứng dụng, tài khoản khách hàng hoặc đơn vị kinh doanh.
Danh sách kiểm tra vận hành sản xuất
| Mục | Khuyến nghị |
|---|---|
| Khóa API | Sử dụng khóa sản xuất chuyên dụng với nhãn rõ ràng. |
| Mô hình | Xác nhận tình trạng sẵn có, giá, độ dài ngữ cảnh và các khả năng yêu cầu của mô hình. |
| Định tuyến | Cấu hình bí danh định tuyến hoặc chính sách dự phòng cho các tải công việc quan trọng. |
| Nhật ký | Đảm bảo ID yêu cầu được ghi lại trong nhật ký ứng dụng. |
| Thanh toán | Xác nhận số dư ví, tình trạng gói và quy tắc khấu trừ tín dụng. |
| Giới hạn tỷ lệ | Xem xét RPM, TPM, đồng thời và giới hạn tác vụ phương tiện cấp tài khoản. |
| Cảnh báo | Theo dõi tăng trưởng sử dụng, số dư tín dụng, lỗi và tính khả dụng của nhà cung cấp. |
Thanh toán & tín dụng
BasicRouter sử dụng mô hình thanh toán dựa trên tín dụng cho các tải công việc mô hình văn bản, hình ảnh, video và các loại khác được hỗ trợ. Tín dụng cung cấp một đơn vị thống nhất cho việc sử dụng đa mô hình và đa nhà cung cấp để các nhóm có thể quản lý mức tiêu thụ một cách nhất quán trên các phương thức và họ API.
Giá mô hình chi tiết có sẵn trên trang Mô hình hoặc qua các API siêu dữ liệu mô hình. Giá có thể thay đổi theo mô hình, nhà cung cấp, phương thức, độ phân giải, loại token, độ dài đầu ra, thời gian tác vụ, loại tài khoản và thỏa thuận thương mại.
Nạp tiền & ví
Tài khoản có thể thêm tín dụng ví trả theo mức dùng cho sử dụng linh hoạt. Tín dụng ví được sử dụng sau khi tín dụng gói hàng tháng và gói tài nguyên đã được tiêu thụ, trừ khi một quy tắc thanh toán tùy chỉnh áp dụng cho tài khoản.
Tín dụng ví không hết hạn trừ khi được chỉ định khác trong điều khoản thương mại áp dụng. Phí dịch vụ được tính khi nạp lại ví trả theo mức dùng.
Gói hàng tháng và gói tài nguyên
Mỗi người dùng hoặc tài khoản có thể chọn một gói hàng tháng đang hoạt động. Gói hàng tháng cung cấp một lượng năng lực sử dụng xác định, điều khoản thương mại và cấu hình truy cập cấp tài khoản cho kỳ thanh toán.
Người dùng cũng có thể mua nhiều gói tài nguyên để có thêm năng lực sử dụng. Gói tài nguyên có thể tách biệt mức sử dụng cam kết khỏi số dư ví trả theo mức dùng và hữu ích cho sử dụng khối lượng lớn văn bản, hình ảnh, video hoặc tải công việc chuyên biệt.
Thứ tự khấu trừ
Trừ khi cấu hình quy tắc thanh toán tùy chỉnh, tín dụng được khấu trừ theo thứ tự sau:
| Ưu tiên | Nguồn tín dụng | Mô tả |
|---|---|---|
| 1 | Gói hàng tháng | Năng lực sử dụng hàng tháng đi kèm được tiêu thụ trước tiên. |
| 2 | Gói tài nguyên | Các gói đã mua thêm được tiêu thụ sau tín dụng gói hàng tháng. |
| 3 | Ví trả theo mức dùng | Số dư ví được tiêu thụ sau tín dụng gói và gói tài nguyên. |
Cho các tài khoản có điều khoản thương mại tùy chỉnh, thứ tự khấu trừ, quy tắc hết hạn, mức sử dụng đi kèm và giá có thể khác. Quy tắc cụ thể theo tài khoản được hiển thị trong bảng điều khiển hoặc cung cấp qua thỏa thuận thương mại.
Định giá tùy chỉnh
Giá có thể được tùy chỉnh cho mỗi người dùng hoặc tài khoản. Khách hàng doanh nghiệp, tài khoản đại lý phân phối, tài khoản nhà phân phối và khách hàng khối lượng lớn có thể đủ điều kiện cho giá tùy chỉnh. Liên hệ bộ phận bán hàng để nhận báo giá.
Giá tùy chỉnh có thể được cấu hình theo tài khoản, mô hình, nhà cung cấp, phương thức, khu vực, khối lượng sử dụng hoặc thỏa thuận thương mại. Khi giá tùy chỉnh được bật, bảng điều khiển và API thanh toán phản ánh giá và quy tắc khấu trừ cụ thể theo tài khoản khi có sẵn.
Đơn vị giá
Các phương thức mô hình khác nhau sử dụng các đơn vị đo lường khác nhau. BasicRouter quy đổi các đơn vị này thành tín dụng theo quy tắc giá của mô hình.
| Phương thức | Cơ sở giá phổ biến |
|---|---|
| Văn bản | Token đầu vào, token đầu ra, token đọc bộ nhớ đệm, token ghi bộ nhớ đệm, token suy luận hoặc các danh mục token cụ thể theo mô hình. |
| Hình ảnh | Mô hình, độ phân giải, số hình ảnh đã tạo, mức sử dụng hình ảnh đầu vào, chế độ chỉnh sửa hoặc cài đặt chất lượng. |
| Video | Mô hình, độ phân giải đầu ra, giây đã tạo, tỷ lệ khung hình, mức sử dụng hình ảnh hoặc video đầu vào và loại tác vụ. |
| Nhúng | Token đầu vào hoặc số bản ghi nhúng. |
| Âm thanh | Thời lượng đầu vào, thời lượng đầu ra, độ dài bản chép hoặc các đơn vị âm thanh cụ thể theo mô hình. |
Đơn vị giá có thể thay đổi theo mô hình. Luôn tham khảo trang chi tiết mô hình hoặc siêu dữ liệu giá trước khi bật một mô hình trong sản xuất.
Gán mức sử dụng
Mức sử dụng BasicRouter có thể được xem xét theo tài khoản, khóa API, mô hình, phương thức hoặc phạm vi thời gian. Điều này cho phép các nhóm gán chi phí cho ứng dụng, môi trường, khách hàng hoặc đơn vị kinh doanh nội bộ.
| Chiều | Mô tả |
|---|---|
| Khóa API | Nhóm mức sử dụng theo ứng dụng, dịch vụ hoặc môi trường. |
| Mô hình | So sánh chi phí và khối lượng theo mô hình đã chọn. |
| Mô hình đã giải quyết | Xem xét mô hình thực tế được sử dụng sau định tuyến hoặc dự phòng. |
| Phương thức | Tách biệt mức sử dụng văn bản, hình ảnh, video, nhúng và âm thanh. |
| Phạm vi thời gian | Xem xét các kỳ báo cáo hàng ngày, hàng tháng hoặc tùy chỉnh. |
| Siêu dữ liệu | Nhóm mức sử dụng theo siêu dữ liệu yêu cầu tùy chỉnh như ID khách hàng, ID người thuê, ID người dùng hoặc môi trường. |
Số dư tín dụng
Kiểm tra xem có bao nhiêu tín dụng sẵn có trên tài khoản của bạn. Số dư được chia thành ba ví được khấu trừ theo thứ tự: hạn mức gói hàng tháng, gói tài nguyên đã mua và ví trả theo mức dùng. Tổng tài nguyên kết hợp (gói hàng tháng + gói tài nguyên, không bao gồm trả theo mức dùng) cũng có sẵn để theo dõi mức sử dụng đi kèm tách biệt khỏi chi tiêu nạp tiền.
Để truy xuất theo chương trình, xem GET /v1/billing/balance trong Tài liệu API.
Chi tiết sử dụng
Xem xét danh sách theo trang, theo thời gian của các bản ghi sử dụng riêng lẻ để báo cáo, theo dõi và phân bổ chi phí nội bộ. Mỗi bản ghi hiển thị mô hình, loại mô hình (văn bản, hình ảnh hoặc video), tín dụng đã khấu trừ và phân tích từng ví mà mỗi khoản khấu trừ được rút từ. Kết quả có thể được lọc theo một phạm vi thời gian cụ thể.
Để truy xuất theo chương trình, xem GET /v1/usage trong Tài liệu API.
Lịch sử giao dịch
Sử dụng lịch sử giao dịch để xem xét các biến động tín dụng, bao gồm nạp tiền, phân bổ gói, cấp gói tài nguyên, khấu trừ mức sử dụng, điều chỉnh và hiệu chỉnh hành chính.
Để truy xuất theo chương trình, xem GET /v1/billing/transactions trong Tài liệu API.
Yêu cầu thất bại và hoàn tiền
Lỗi xác thực, lỗi xác thực danh tính và lỗi quyền thường không được tính phí vì không có thực thi mô hình nào xảy ra. Các yêu cầu đến một mô hình thượng nguồn hoặc tạo đầu ra một phần có thể tiêu thụ tín dụng tùy thuộc vào mô hình, nhà cung cấp và trạng thái phản hồi.
Cho các tác vụ hình ảnh và video không đồng bộ, hành vi thanh toán phụ thuộc vào việc tác vụ đã được chấp nhận, bắt đầu, hoàn thành, thất bại hay hủy. Phản hồi chi tiết tác vụ bao gồm thông tin sử dụng khi tín dụng đã được tiêu thụ.
Nạp tiền, gói hàng tháng, gói tài nguyên và tín dụng đã tiêu thụ không thể hoàn lại trừ khi được chỉ định khác trong thỏa thuận thương mại áp dụng hoặc yêu cầu bởi pháp luật.
Vận hành
Lỗi
BasicRouter trả về mã lỗi ổn định để ứng dụng có thể xử lý thử lại, dự phòng, vấn đề thanh toán và gỡ lỗi một cách nhất quán.
Các điểm cuối tương thích nhà cung cấp cố gắng giữ nguyên hình dạng lỗi của họ API gốc khi có thể. Các điểm cuối native BasicRouter sử dụng đối tượng lỗi BasicRouter.
Ánh xạ trạng thái HTTP và mã lỗi
| Trạng thái HTTP | Loại lỗi | Mã ví dụ | Thử lại |
|---|---|---|---|
| 400 | invalid_request_error | invalid_request, unsupported_parameter, invalid_messages, invalid_image_url | Không |
| 401 | authentication_error | missing_api_key, invalid_api_key | Không |
| 402 | billing_error | insufficient_credits, payment_required, quota_exceeded | Không |
| 403 | permission_error | model_access_denied, endpoint_access_denied, key_scope_denied | Không |
| 404 | not_found_error | model_not_found, response_not_found, task_not_found | Không |
| 408 | timeout_error | gateway_timeout, provider_timeout | Có |
| 409 | conflict_error | idempotency_conflict, task_already_cancelled | Tùy thuộc |
| 422 | validation_error | schema_validation_failed, unsupported_modality | Không |
| 429 | rate_limit_error | account_rpm_exceeded, account_tpm_exceeded, provider_rate_limited | Có |
| 500 | internal_error | internal_error | Có |
| 502 | provider_error | provider_bad_gateway, provider_invalid_response | Có |
| 503 | service_unavailable | model_unavailable, provider_unavailable, insufficient_capacity | Có |
| 504 | timeout_error | provider_timeout, gateway_timeout | Có |
Mã lỗi phổ biến
| Mã | Ý nghĩa | Hành động đề xuất |
|---|---|---|
missing_api_key | Không có API key được cung cấp. | Thêm header Authorization. |
invalid_api_key | API key không hợp lệ hoặc đã bị thu hồi. | Tạo hoặc xoay vòng API key. |
model_not_found | ID mô hình không tồn tại hoặc không được bật cho tài khoản. | Kiểm tra trang Mô hình hoặc gọi GET /v1/models. |
model_access_denied | API key hoặc tài khoản không có quyền truy cập mô hình. | Bật mô hình hoặc liên hệ quản trị viên. |
unsupported_parameter | Yêu cầu bao gồm tham số không được hỗ trợ bởi điểm cuối hoặc mô hình đã chọn. | Xóa tham số hoặc chọn mô hình tương thích. |
unsupported_modality | Modal đầu vào hoặc đầu ra không được hỗ trợ bởi mô hình đã chọn. | Chọn mô hình hỗ trợ modal đó. |
account_rpm_exceeded | Đã vượt giới hạn số yêu cầu mỗi phút của tài khoản. | Thử lại với backoff hoặc yêu cầu giới hạn cao hơn. |
account_tpm_exceeded | Đã vượt giới hạn số token mỗi phút của tài khoản. | Thử lại với backoff, giảm token, hoặc yêu cầu giới hạn cao hơn. |
provider_rate_limited | Nhà cung cấp upstream đã giới hạn tốc độ yêu cầu. | Thử lại hoặc bật dự phòng. |
insufficient_credits | Tài khoản không đủ tín dụng. | Nạp ví, mua gói, hoặc nâng cấp gói. |
provider_timeout | Nhà cung cấp upstream không phản hồi kịp thời. | Thử lại hoặc bật dự phòng. |
model_unavailable | Mô hình tạm thời không khả dụng. | Thử lại hoặc dùng bí danh định tuyến. |
content_policy_error | Yêu cầu hoặc đầu ra bị chặn bởi chính sách an toàn. | Sửa đầu vào hoặc chọn luồng phù hợp. |
