Saltar al contenido principal
POST
Crear una nueva clave de API
Este endpoint requiere una clave de API de gestión. No se aceptan las claves de API estándar de Gateway.
La clave de API en texto sin formato se devuelve una sola vez, al crearla. Se aceptan los campos de compatibilidad limit, limit_reset e include_byok_in_limit; actualmente, Phaseo trata include_byok_in_limit solo por compatibilidad y siempre excluye BYOK del límite de esta clave.

Autorizaciones

Authorization
string
header
requerido

Autenticación con token Bearer

Cuerpo

application/json
name
string
requerido
Minimum string length: 1
Ejemplo:

"Analytics Service Key"

workspace_id
string<uuid>

Anulación opcional del espacio de trabajo para llamadas internas.

scopes
Ejemplo:

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

limit
number | null

Límite de gasto opcional en USD para esta clave.

Rango requerido: x >= 0
limit_reset
enum<string>

Período usado para la ventana del límite de gasto.

Opciones disponibles:
daily,
weekly,
monthly
include_byok_in_limit
boolean

Se acepta por compatibilidad. El comportamiento actual de Phaseo siempre excluye BYOK de este límite.

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

Departamento al que pertenece esta clave para los límites de frecuencia y los presupuestos del departamento. Null significa que la clave solo cuenta para los límites de todo el espacio de trabajo.

storage_locations
string[]

Dónde guardas esta clave, por ejemplo la plataforma de alojamiento cuyas variables de entorno la contienen. Opcional. Si uno de estos lugares informa de una brecha, puedes encontrar y revocar todas las claves guardadas allí. Identificadores conocidos: 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}$
Ejemplo:

Respuesta

Clave de API creada

key
string
requerido

Clave de API en texto sin formato, el mismo valor que data.key. Solo se devuelve una vez, al crearla.

Ejemplo:

"phaseo_v1_sk_abcd1234_supersecretvalue"

data
object
requerido
Última modificación el 16 de noviembre de 2026