Type Alias: CreateApiKey
Properties
| Property | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Human-readable name for the key (example: "Aiba Webhook") |
scopes | ApiKeyScope[] | Yes | Scopes to grant to this key (at least one). A plain scope (sanctions) covers reads and writes of its resource family, a .read scope (sanctions.read) only its read routes, and a capability scope (participants.token, rooms.push) one narrow capability the family scope does not include. GET /api-keys/scopes describes every scope. (example: ["participants.token","sanctions.read"]) |
projectId | string | No | Optional project ID to scope this key to (example: "my-project-id") |
expiresAt | string | No | Optional expiration date (ISO string) (example: "2025-12-31T23:59:59Z") |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/api-keys.ts:9