Pular para o conteúdo principal
POST
Criar uma nova chave de API
Este endpoint requer uma chave de API de gerenciamento. Chaves de API padrão do Gateway não são aceitas.
A chave de API em texto simples é retornada uma única vez, durante a criação. Os campos de compatibilidade limit, limit_reset e include_byok_in_limit são aceitos; atualmente, o Phaseo trata include_byok_in_limit apenas para compatibilidade e sempre exclui BYOK do limite dessa chave.

Autorizações

Authorization
string
header
obrigatório

Autenticação com token Bearer

Corpo

application/json
name
string
obrigatório
Minimum string length: 1
Exemplo:

"Analytics Service Key"

workspace_id
string<uuid>

Substituição opcional do espaço de trabalho para chamadas internas.

scopes
Exemplo:

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

limit
number | null

Limite de gastos opcional em USD para esta chave.

Intervalo obrigatório: x >= 0
limit_reset
enum<string>

Período usado para a janela do limite de gastos.

Opções disponíveis:
daily,
weekly,
monthly
include_byok_in_limit
boolean

Aceito por compatibilidade. O comportamento atual do Phaseo sempre exclui o BYOK deste limite.

expires_at
string<date-time> | null
disabled
boolean
padrão:false
soft_blocked
boolean
padrão:false
limits
object
department_id
string<uuid> | null

Departamento ao qual esta chave pertence para os limites de taxa e os orçamentos do departamento. Null significa que a chave conta apenas para os limites de todo o espaço de trabalho.

storage_locations
string[]

Onde você guarda esta chave, como a plataforma de hospedagem cujas variáveis de ambiente a contêm. Opcional. Se um desses lugares relatar um vazamento, você pode encontrar e revogar todas as chaves armazenadas lá. IDs conhecidos: 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}$
Exemplo:

Resposta

Chave de API criada

key
string
obrigatório

Chave de API em texto simples, o mesmo valor de data.key. Retornada apenas uma vez, no momento da criação.

Exemplo:

"phaseo_v1_sk_abcd1234_supersecretvalue"

data
object
obrigatório
Última modificação em 16 de novembro de 2026