Workspace - TypeScript SDK

Workspace type definition

Example Usage

1 import { Workspace } from "@openrouter/sdk/models";
2 
3 let value: Workspace = {
4   createdAt: "2025-08-24T10:30:00Z",
5   createdBy: "user_abc123",
6   defaultImageModel: "openai/dall-e-3",
7   defaultProviderSort: "price",
8   defaultTextModel: "openai/gpt-4o",
9   description: "Production environment workspace",
10   id: "550e8400-e29b-41d4-a716-446655440000",
11   ioLoggingApiKeyIds: null,
12   ioLoggingSamplingRate: 1,
13   isDataDiscountLoggingEnabled: true,
14   isObservabilityBroadcastEnabled: false,
15   isObservabilityIoLoggingEnabled: false,
16   name: "Production",
17   slug: "production",
18   updatedAt: "2025-08-24T15:45:00Z",
19 };

Fields

Field	Type	Required	Description	Example
`createdAt`	string	✔️	ISO 8601 timestamp of when the workspace was created	2025-08-24T10:30:00Z
`createdBy`	string	✔️	User ID of the workspace creator	user_abc123
`defaultImageModel`	string	✔️	Default image model for this workspace	openai/dall-e-3
`defaultProviderSort`	string	✔️	Default provider sort preference (price, throughput, latency, exacto)	price
`defaultTextModel`	string	✔️	Default text model for this workspace	openai/gpt-4o
`description`	string	✔️	Description of the workspace	Production environment workspace
`id`	string	✔️	Unique identifier for the workspace	550e8400-e29b-41d4-a716-446655440000
`ioLoggingApiKeyIds`	number[]	✔️	Optional array of API key IDs to filter I/O logging. Null means all keys are logged.	`<nil>`
`ioLoggingSamplingRate`	number	✔️	Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged.	1
`isDataDiscountLoggingEnabled`	boolean	✔️	Whether data discount logging is enabled for this workspace	true
`isObservabilityBroadcastEnabled`	boolean	✔️	Whether broadcast is enabled for this workspace	false
`isObservabilityIoLoggingEnabled`	boolean	✔️	Whether private logging is enabled for this workspace	false
`name`	string	✔️	Name of the workspace	Production
`slug`	string	✔️	URL-friendly slug for the workspace	production
`updatedAt`	string	✔️	ISO 8601 timestamp of when the workspace was last updated	2025-08-24T15:45:00Z

Example Usage

1 import { Workspace } from "@openrouter/sdk/models";
2 
3 let value: Workspace = {
4   createdAt: "2025-08-24T10:30:00Z",
5   createdBy: "user_abc123",
6   defaultImageModel: "openai/dall-e-3",
7   defaultProviderSort: "price",
8   defaultTextModel: "openai/gpt-4o",
9   description: "Production environment workspace",
10   id: "550e8400-e29b-41d4-a716-446655440000",
11   ioLoggingApiKeyIds: null,
12   ioLoggingSamplingRate: 1,
13   isDataDiscountLoggingEnabled: true,
14   isObservabilityBroadcastEnabled: false,
15   isObservabilityIoLoggingEnabled: false,
16   name: "Production",
17   slug: "production",
18   updatedAt: "2025-08-24T15:45:00Z",
19 };

Fields

Field	Type	Required	Description	Example
`createdAt`	string	✔️	ISO 8601 timestamp of when the workspace was created	2025-08-24T10:30:00Z
`createdBy`	string	✔️	User ID of the workspace creator	user_abc123
`defaultImageModel`	string	✔️	Default image model for this workspace	openai/dall-e-3
`defaultProviderSort`	string	✔️	Default provider sort preference (price, throughput, latency, exacto)	price
`defaultTextModel`	string	✔️	Default text model for this workspace	openai/gpt-4o
`description`	string	✔️	Description of the workspace	Production environment workspace
`id`	string	✔️	Unique identifier for the workspace	550e8400-e29b-41d4-a716-446655440000
`ioLoggingApiKeyIds`	number[]	✔️	Optional array of API key IDs to filter I/O logging. Null means all keys are logged.	`<nil>`
`ioLoggingSamplingRate`	number	✔️	Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged.	1
`isDataDiscountLoggingEnabled`	boolean	✔️	Whether data discount logging is enabled for this workspace	true
`isObservabilityBroadcastEnabled`	boolean	✔️	Whether broadcast is enabled for this workspace	false
`isObservabilityIoLoggingEnabled`	boolean	✔️	Whether private logging is enabled for this workspace	false
`name`	string	✔️	Name of the workspace	Production
`slug`	string	✔️	URL-friendly slug for the workspace	production
`updatedAt`	string	✔️	ISO 8601 timestamp of when the workspace was last updated	2025-08-24T15:45:00Z

1	import { Workspace } from "@openrouter/sdk/models";
2
3	let value: Workspace = {
4	createdAt: "2025-08-24T10:30:00Z",
5	createdBy: "user_abc123",
6	defaultImageModel: "openai/dall-e-3",
7	defaultProviderSort: "price",
8	defaultTextModel: "openai/gpt-4o",
9	description: "Production environment workspace",
10	id: "550e8400-e29b-41d4-a716-446655440000",
11	ioLoggingApiKeyIds: null,
12	ioLoggingSamplingRate: 1,
13	isDataDiscountLoggingEnabled: true,
14	isObservabilityBroadcastEnabled: false,
15	isObservabilityIoLoggingEnabled: false,
16	name: "Production",
17	slug: "production",
18	updatedAt: "2025-08-24T15:45:00Z",
19	};