Skip to main content

Interface: GatewayApiKeyCreateRequest

Defined in: src/ai-gateway/api-keys-client.ts:14

Request body for creating a service or user API key.

Properties​

name​

name: string;

Defined in: src/ai-gateway/api-keys-client.ts:15

description?​

optional description?: string;

Defined in: src/ai-gateway/api-keys-client.ts:16

scopes​

scopes: string[];

Defined in: src/ai-gateway/api-keys-client.ts:18

e.g. completions.write, mcp.invoke, prompts.render, agents.invoke, logs.write.

organisation_id​

organisation_id: string;

Defined in: src/ai-gateway/api-keys-client.ts:20

The TSG as a numeric string — NOT the organisation UUID returned on reads.

workspace_id​

workspace_id: string;

Defined in: src/ai-gateway/api-keys-client.ts:21

type​

type: string;

Defined in: src/ai-gateway/api-keys-client.ts:23

Usually workspace.

expires_at?​

optional expires_at?: string | null;

Defined in: src/ai-gateway/api-keys-client.ts:24

defaults?​

optional defaults?: Record<string, unknown> | null;

Defined in: src/ai-gateway/api-keys-client.ts:25

rotation_policy?​

optional rotation_policy?: Record<string, unknown> | null;

Defined in: src/ai-gateway/api-keys-client.ts:26

user_id?​

optional user_id?: string;

Defined in: src/ai-gateway/api-keys-client.ts:28

Required for user keys only.