Zum Hauptinhalt springen
POST
Neuen API-Schlüssel erstellen
Für diesen Endpunkt ist ein Management-API-Schlüssel erforderlich. Standard-Gateway-API-Schlüssel werden nicht akzeptiert.
Der API-Schlüssel im Klartext wird nur bei der Erstellung einmal zurückgegeben. Die Kompatibilitätsfelder limit, limit_reset und include_byok_in_limit werden akzeptiert; Phaseo behandelt include_byok_in_limit derzeit ausschließlich aus Kompatibilitätsgründen und rechnet BYOK nie auf dieses Schlüssellimit an.

Autorisierungen

Authorization
string
header
erforderlich

Authentifizierung mit Bearer-Token

Body

application/json
name
string
erforderlich
Minimum string length: 1
Beispiel:

"Analytics Service Key"

workspace_id
string<uuid>

Optionale Arbeitsbereichsüberschreibung für interne Aufrufer.

scopes
Beispiel:

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

limit
number | null

Optionales Ausgabenlimit in USD für diesen Schlüssel.

Erforderlicher Bereich: x >= 0
limit_reset
enum<string>

Zeitraum für das Ausgabenlimit-Fenster.

Verfügbare Optionen:
daily,
weekly,
monthly
include_byok_in_limit
boolean

Wird aus Kompatibilitätsgründen akzeptiert. Das aktuelle Phaseo-Verhalten schließt BYOK immer von diesem Limit aus.

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

Abteilung, zu der dieser Schlüssel für Ratenlimits und Budgets der Abteilung gehört. Null bedeutet, dass der Schlüssel nur auf die Limits des gesamten Workspace angerechnet wird.

storage_locations
string[]

Wo du diesen Schlüssel aufbewahrst, zum Beispiel die Hosting-Plattform, in deren Umgebungsvariablen er liegt. Optional. Wenn einer dieser Orte ein Datenleck meldet, kannst du alle dort gespeicherten Schlüssel finden und widerrufen. Bekannte IDs: 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}$
Beispiel:

Antwort

API-Schlüssel erstellt

key
string
erforderlich

API-Schlüssel im Klartext, derselbe Wert wie data.key. Wird nur einmal bei der Erstellung zurückgegeben.

Beispiel:

"phaseo_v1_sk_abcd1234_supersecretvalue"

data
object
erforderlich
Zuletzt geändert am 16. November 2026