Passer au contenu principal
POST
Créer une nouvelle clé API
Ce point de terminaison nécessite une clé API de gestion. Les clés API Gateway standard ne sont pas acceptées.
La clé API en clair n’est renvoyée qu’une seule fois, lors de sa création. Les champs de compatibilité limit, limit_reset et include_byok_in_limit sont acceptés ; Phaseo traite actuellement include_byok_in_limit uniquement pour la compatibilité et exclut toujours BYOK de la limite de cette clé.

Autorisations

Authorization
string
header
requis

Authentification par jeton Bearer

Corps

application/json
name
string
requis
Minimum string length: 1
Exemple:

"Analytics Service Key"

workspace_id
string<uuid>

Remplacement facultatif de l’espace de travail pour les appels internes.

scopes
Exemple:

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

limit
number | null

Plafond de dépenses facultatif en USD pour cette clé.

Plage requise: x >= 0
limit_reset
enum<string>

Période utilisée pour la fenêtre du plafond de dépenses.

Options disponibles:
daily,
weekly,
monthly
include_byok_in_limit
boolean

Accepté pour des raisons de compatibilité. Le comportement actuel de Phaseo exclut toujours BYOK de cette limite.

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

Service auquel cette clé appartient pour les limites de débit et les budgets du service. Null signifie que la clé ne compte que pour les limites de l’ensemble de l’espace de travail.

storage_locations
string[]

Où vous stockez cette clé, par exemple la plateforme d’hébergement dont les variables d’environnement la contiennent. Facultatif. Si l’un de ces services signale une fuite, vous pouvez retrouver et révoquer toutes les clés qui y sont stockées. Identifiants connus : 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}$
Exemple:

Réponse

Clé API créée

key
string
requis

Clé API en texte brut, même valeur que data.key. Renvoyée une seule fois, lors de sa création.

Exemple:

"phaseo_v1_sk_abcd1234_supersecretvalue"

data
object
requis
Dernière modification le 16 novembre 2026