Skip to main content

Interface: GatewayWorkspaceCreateRequest

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

Request body for AIGatewayWorkspacesClient.create.

Properties​

name​

name: string;

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

Display name. Required.

scope_name​

scope_name: string;

Defined in: src/ai-gateway/workspaces-client.ts:34

SCM role scope granting data-plane access to the new workspace, e.g. ws_production_bx7qw0. Required, and specific to Prisma AIRS — upstream Portkey has no such field.

It is not derived from name. A workspace created with a scope nobody holds is invisible to list() on the data plane, though it still appears via list({ plane: 'admin' }).

description?​

optional description?: string;

Defined in: src/ai-gateway/workspaces-client.ts:35

icon?​

optional icon?: string;

Defined in: src/ai-gateway/workspaces-client.ts:36

defaults?​

optional defaults?: Record<string, unknown>;

Defined in: src/ai-gateway/workspaces-client.ts:38

Workspace defaults; metadata is a flat string map applied to every request.

users?​

optional users?: string[];

Defined in: src/ai-gateway/workspaces-client.ts:40

User ids to seed the workspace with.

usage_limits?​

optional usage_limits?: Record<string, unknown>[];

Defined in: src/ai-gateway/workspaces-client.ts:42

Usage-limit policies. An array, not a single object.

rate_limits?​

optional rate_limits?: Record<string, unknown>[];

Defined in: src/ai-gateway/workspaces-client.ts:44

Rate-limit policies. An array, not a single object.