Rate Limits

List Workspace Rate Limits

$client->organization->workspaces->rateLimits->list(string workspaceID, ?GroupType groupType, ?bool includeInherited, ?int limit, ?string page): PageCursor<WorkspaceRateLimit>

GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

Set Workspace Rate Limits

$client->organization->workspaces->rateLimits->update(string rateLimitID, string workspaceID, list<WorkspaceRateLimitUpdateValue> limits): WorkspaceRateLimit

POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

Set or clear rate-limit overrides for one rate-limit group in a workspace.

Models

class WorkspaceRateLimit { $type = 'workspace_rate_limit'; $group; $limits; /* 3 more */ }

"workspace_rate_limit" type

Object type. Always workspace_rate_limit for workspace rate-limit entries.

Group group

The rate-limit group this entry's limits apply to.

list<WorkspaceRateLimitValue> limits

The workspace's limiter values for this group. By default only the limiter types with a workspace-level override are listed. With include_inherited set to true, the limiter types the workspace inherits from the organization are listed too, each marked by source.

?list<string> models

Model names this entry's limits apply to, including aliases. null when group.type is not "model_group". The list covers the models this workspace has access to, so it can differ between workspaces.

string rateLimitID

The id of the organization's RateLimit entry this entry applies to.

string workspaceID

ID of the Workspace this entry applies to.

class WorkspaceRateLimitOrganizationSource { $type = 'organization'; }

"organization" type

Always organization: no workspace-level override is stored, so the organization's value applies.

enum WorkspaceRateLimitType

One of the following:

"fast_itpmca"

"fast_otpm"

"input_tokens_per_minute"

"input_tokens_per_minute_cache_aware"

"output_tokens_per_minute"

"requests_per_minute"

"tokens_per_day"

"tokens_per_minute"

"tool_uses_per_second"

class WorkspaceRateLimitUpdateValue { $type; $value; }

WorkspaceRateLimitType type

Rate limiter type.

?int value

New limit value. Set to null to clear the workspace override and fall back to the organization limit.

class WorkspaceRateLimitValue { $type; $orgLimit; $source; $value; }

string type

The limiter type (for example, requests_per_minute or input_tokens_per_minute).

?int orgLimit

The organization-level value for the same limiter type, for reference. null when the organization has no limit configured for this limiter type.

Source source

Where value comes from. organization values are listed only when include_inherited is true, and then value equals org_limit.

int value

The workspace's value for this limiter type: the workspace-level override when source.type is workspace, otherwise the organization's value.

class WorkspaceRateLimitWorkspaceSource { $type = 'workspace'; }

"workspace" type

Always workspace: a workspace-level override is stored.