Chuyển đến nội dung chính
Khi bạn tạo hoặc đọc một API key qua console hoặc REST API, gateway trả về một đối tượng token — bản ghi JSON giữ danh tính của một key, các giới hạn của nó, và hai phần đính kèm chính sách chi phối traffic của nó. Trang này là tham chiếu từng trường cho đối tượng đó: mỗi trường nghĩa là gì, kiểu của nó, và các giá trị sentinel (0, -1) mang ý nghĩa đặc biệt. Để biết tại sao đằng sau các trường này — mô hình least-agency — hãy bắt đầu ở Tổng quan key có phạm vi. Trang này là bảng tra cứu bạn để mở trong khi viết script tạo key.

​
1. Tham chiếu đối tượng token trong nháy mắt

Một key vừa tạo cho một agent tóm tắt theo lịch trông như thế này: 
{
  "id": 4812,
  "name": "support-summarizer-prod",
  "status": 1,
  "key": "sk-orca-a1b2****yz90",
  "created_time": 1733616000,
  "accessed_time": 1733702400,
  "expired_time": -1,
  "unlimited_quota": false,
  "remain_quota": 500000,
  "used_quota": 12340,
  "model_limits_enabled": true,
  "model_limits": "openai/gpt-4o-mini",
  "credit_limit_usd": 25,
  "allow_ips": "203.0.113.7",
  "environment": "prod",
  "guardrail_id": 17,
  "firewall_policy_id": 9,
  "is_firewall_gateway": false,
  "group": "default"
}
Trường key bị che trên mọi lần đọc — bạn thấy tiền tố thương hiệu và bốn ký tự cuối, không bao giờ là secret đầy đủ. Plaintext hiển thị một lần, lúc tạo. Xem Che key.

​
2. Trường danh tính & vòng đời

Những cái này mô tả key nào là cái này và nó đang ở đâu trong vòng đời của nó.
Định danh số ổn định của key. Dùng nó để chỉ định key trong các cuộc gọi update và delete. Chỉ-đọc.
Một nhãn dành cho con người cho key, hiển thị trong console và trong log. Đặt tên key theo agent giữ chúng — một key, một agent.
Trạng thái bật / tắt. 1 nghĩa là đang hoạt động; một key bị vô hiệu hóa bị từ chối ở auth mà không bị xóa, nên bạn có thể tạm dừng một key và bật lại nó.
Secret bearer, trả về đã che (sk-orca-…****…). Giá trị đầy đủ chỉ hiển thị một lần, lúc tạo. Coi nó như một mật khẩu.
Unix timestamp (giây) cho khi key được đúc và khi nó phục vụ một request lần cuối. accessed_time là tín hiệu của bạn cho một key cũ kỹ hoặc không dùng đáng thu hồi.
Mốc hết hạn tuyệt đối như một Unix timestamp. Giá trị sentinel -1 nghĩa là key không bao giờ hết hạn. Đặt một timestamp thực để cho một key tự động hết hạn — mặc định đúng cho các lần chạy CI và agent tạm thời. Xem Key hết hạn.

​
3. Trường chi tiêu & quota

Những cái này ràng buộc bao nhiêu một key có thể tiêu thụ trước khi nó ngừng hoạt động.
TrườngKiểuÝ nghĩa
credit_limit_usdnumberMức trần chi tiêu trọn đời bằng USD. 0 = không giới hạn.
unlimited_quotabooleanKhi true, key không được đo lường đối với một số dư quota.
remain_quotanumberQuota còn lại trên key.
used_quotanumberQuota đã tiêu thụ cho đến nay.
Một key với credit_limit_usd: 0 và unlimited_quota: true và expired_time: -1 không có mức trần chi tiêu và không bao giờ hết hạn — bán kính ảnh hưởng tệ nhất nếu nó rò rỉ. Xem không giới hạn vs bị giới hạn để biết khi nào một key không giới hạn được biện minh.

​
4. Trường tầm với & phạm vi

Những cái này giới hạn cái gì key có thể vươn tới — những mô hình nào, từ những địa chỉ nào.
model_limits là danh sách các mô hình mà key có thể gọi; model_limits_enabled là công tắc bật/tắt. Với giới hạn được bật, một cuộc gọi tới bất kỳ mô hình nào ngoài danh sách bị từ chối trước khi nó rời gateway — agent không thể chuyển sang một mô hình đắt hơn hoặc mạnh hơn. Xem Giới hạn mô hình.
Một danh sách IP / CIDR cho phép, một mục mỗi dòng. Một request trình key từ bất kỳ địa chỉ nào không được liệt kê bị từ chối ở tầng auth; một giá trị rỗng nghĩa là mọi địa chỉ được phép. Xem Danh sách IP cho phép.
Một nhãn triển khai tự do (prod, staging, dev, hoặc bất cứ gì bạn chọn) để tổ chức các key và lọc log. Thuần túy tổ chức — nó không thay đổi việc thực thi. Xem Môi trường.
Routing group mà key phân giải các mô hình qua đó. Để nó ở mặc định workspace trừ khi bạn đã được trao một group cụ thể.

​
5. Trường phần đính kèm chính sách

Hai trường mạnh nhất trên một key. Mỗi cái gắn key vào một chính sách theo phạm vi workspace chi phối traffic của nó — thay đổi chính sách và mọi key gắn vào nó tiếp nhận thay đổi ở request kế tiếp, không triển khai lại.
TrườngKiểuGắn key vào
guardrail_idnumberMột guardrail nội dung sàng lọc văn bản request và response.
firewall_policy_idnumberMột chính sách firewall chi phối các cuộc gọi tool mà key phát ra.
is_firewall_gatewaybooleanĐánh dấu key là một token có phạm vi gateway cho các route Firewall MCP / evaluate (không phải cho inference).
Giá trị sentinel cho cả hai phần đính kèm là 0 (không gắn). Nhưng hai mặt phẳng phân giải một phần đính kèm bị tắt khác nhau:
  • Một guardrail_id bị tắt là công tắc tắt — key không nhận được guardrail, không fallback về mặc định của workspace.
  • Một firewall_policy_id bị tắt fallback về chính sách firewall mặc định của workspace.
Thứ tự phân giải đầy đủ nằm ở Gắn chính sách và Phạm vi & key.
is_firewall_gateway: true đúc một key có phạm vi gateway chỉ cho các route /api/v1/firewall/* — không bao giờ đặt nó trên một key inference. Bật cờ, và đọc plaintext của một gateway key, đều yêu cầu Admin+.

​
6. Đặt các trường này

Mọi trường ở trên được cấu hình trong trình chỉnh sửa key của console (/console/token) — không qua một relay key. Tạo hoặc chỉnh sửa một key yêu cầu vai trò Developer trở lên; cờ is_firewall_gateway yêu cầu Admin+.
Đối tượng token là bề mặt cấu hình. Plaintext của key (sk-orca-…) là cái mà agent của bạn trình trên các cuộc gọi relay /v1/*. Cấu hình key trong console; agent chỉ bao giờ thấy secret.
Một key least-agency cụ thể — được đặt trong trình chỉnh sửa, đọc lại như đối tượng ở trên — giới hạn một mô hình, một dải IP nguồn, một mức trần USD hằng tuần, một mốc hết hạn, và một guardrail cộng một chính sách firewall. Nếu agent giữ nó bị chiếm quyền qua prompt injection, bán kính ảnh hưởng dừng đúng tại các ràng buộc đó.

​
7. Tham chiếu liên quan

Tổng quan key có phạm vi

Mô hình least-agency và trung tâm cho mọi trường key.

Gắn chính sách

Cách guardrail_id và firewall_policy_id phân giải về một chính sách đang hoạt động.

Quota, mức trần & hết hạn

credit_limit_usd, expired_time, và các trường quota một cách chuyên sâu.

Checklist least-agency

Cho mọi key đi qua cùng một lượt làm cứng.
Mới với mô hình? Đọc Phạm vi, key, chính sách & workspace để biết đối tượng token khớp vào phân cấp workspace → chính sách → key ra sao.