CreateApiKeyReq

  • expiration
    Type: stringenum
    required

    How long the key remains valid. After this period elapses the key transitions to status Expired. Use "never" for keys without an expiry (no expiresAt will be returned in subsequent reads).

    values
    • 7d
    • 30d
    • 90d
    • 1y
    • never
  • name
    Type: string
    required

    Human-readable label for this key. Shown in ApiKeySummary.name and in Studio's key list.

  • scopes
    Type: array string[] 1…
    required

    Permission scopes the key (and any access tokens derived from it) will carry. Must be non-empty. Examples: ["resource:read", "resource:create", "resource:update"] for primitive management; ["workflow:read", "workflow:create", "workflow:execute"] for running workflows; ["webhook:*"] for full webhook control. See the Scopes reference for the full catalog and recommended scope sets. Scopes are immutable after creation — to change them, mint a new key.