跳转到主要内容
POST
创建新的 API 密钥
此端点需要管理 API 密钥。不接受标准 Gateway API 密钥。
创建时仅返回一次明文 API 密钥。请求可以包含兼容字段 limit、limit_reset 和 include_byok_in_limit;Phaseo 目前仅为兼容性保留 include_byok_in_limit,并始终将 BYOK 排除在此密钥的限额之外。

授权

Authorization
string
header
必填

Bearer 令牌身份验证

请求体

application/json
name
string
必填
Minimum string length: 1
示例:

"Analytics Service Key"

workspace_id
string<uuid>

供内部调用方使用的可选工作区覆盖项。

scopes
示例:

"[\"chat.completions\",\"responses\"]"

limit
number | null

此密钥的可选支出上限(USD)。

必填范围: x >= 0
limit_reset
enum<string>

支出上限窗口所使用的周期。

可用选项:
daily,
weekly,
monthly
include_byok_in_limit
boolean

为保持兼容性而接受。Phaseo 当前始终将 BYOK 排除在此限制之外。

expires_at
string<date-time> | null
disabled
boolean
默认值:false
soft_blocked
boolean
默认值:false
limits
object
department_id
string<uuid> | null

此密钥所属的部门,用于部门速率限制和预算。Null 表示该密钥仅计入整个工作区的限制。

storage_locations
string[]

你存放此密钥的位置,例如在环境变量中保存它的托管平台。可选。如果其中某个位置报告数据泄露,你可以找到并撤销存储在那里的所有密钥。已知 ID:railway, vercel, netlify, render, fly, heroku, cloudflare, supabase, firebase, digitalocean, replit, modal, convex, koyeb, coolify, northflank, expo, deno-deploy, aws, google-cloud, azure, hetzner, vultr, linode, ovhcloud, scaleway, kubernetes, github, gitlab, circleci, bitbucket, 1password, bitwarden, hashicorp-vault, doppler, infisical, local-machine, own-server, other。

Maximum array length: 8
Pattern: ^[a-z0-9][a-z0-9-]{0,39}$
示例:

响应

API 密钥已创建

key
string
必填

API 密钥的明文,与 data.key 的值相同。仅在创建时返回一次。

示例:

"phaseo_v1_sk_abcd1234_supersecretvalue"

data
object
必填
最后修改于 2026年11月16日