--- title: Rate Limits url: https://platform.claude.com/docs/en/api/go/beta/organization/workspaces/rate_limits --- # Rate Limits ## List Workspace Rate Limits `client.Beta.Organization.Workspaces.RateLimits.List(ctx, workspaceID, query) (*PageCursor[BetaWorkspaceRateLimit], error)` **GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` List a workspace's rate limits. By default, returns only the groups and limiter types that have a workspace-level override. With `include_inherited=true`, returns every group with organization-level limits the workspace can see, listing for each the values it inherits from the organization as well as its own overrides. Each value's `source` says which it is. When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries. ### Parameters - `workspaceID string` (path parameter) The ID of the workspace. - `query BetaOrganizationWorkspaceRateLimitListParams` - `GroupType BetaOrganizationWorkspaceRateLimitListParamsGroupType Optional` (query parameter) Filter by group type. - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeBatch BetaOrganizationWorkspaceRateLimitListParamsGroupType = "batch"` - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeFiles BetaOrganizationWorkspaceRateLimitListParamsGroupType = "files"` - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeModelGroup BetaOrganizationWorkspaceRateLimitListParamsGroupType = "model_group"` - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeSkills BetaOrganizationWorkspaceRateLimitListParamsGroupType = "skills"` - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeTokenCount BetaOrganizationWorkspaceRateLimitListParamsGroupType = "token_count"` - `const BetaOrganizationWorkspaceRateLimitListParamsGroupTypeWebSearch BetaOrganizationWorkspaceRateLimitListParamsGroupType = "web_search"` - `IncludeInherited param.Opt[bool] Optional` (query parameter) Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override. - `Limit param.Opt[int64] Optional` (query parameter) Maximum number of items to return per page. Ranges from `1` to `1000`. When omitted, every remaining entry is returned in a single page and `next_page` is `null`. minimum: 1, maximum: 1000 - `Page param.Opt[string] Optional` (query parameter) Opaque cursor from a previous response's `next_page`. ### Returns - `type BetaWorkspaceRateLimit` - `Type WorkspaceRateLimit` Object type. Always `workspace_rate_limit` for workspace rate-limit entries. default: workspace_rate_limit - `Group BetaWorkspaceRateLimitGroupUnion` The rate-limit group this entry's limits apply to. Its `type` equals `group_type`. - `type BetaOrganizationRateLimitModelGroup` - `Type ModelGroup` Always `model_group`: a family of models. default: model_group - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `DisplayName string` Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change. - `type BetaOrganizationRateLimitBatchGroup` - `Type Batch` Always `batch`: the Message Batches API. default: batch - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `type BetaOrganizationRateLimitTokenCountGroup` - `Type TokenCount` Always `token_count`: the Token Count API. default: token_count - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `type BetaOrganizationRateLimitFilesGroup` - `Type Files` Always `files`: the Files API. default: files - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `type BetaOrganizationRateLimitSkillsGroup` - `Type Skills` Always `skills`: the Skills API. default: skills - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `type BetaOrganizationRateLimitWebSearchGroup` - `Type WebSearch` Always `web_search`: the Messages API web search tool. default: web_search - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `Limits []BetaWorkspaceRateLimitValue` 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`. - `Type string` The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - `OrgLimit int64` The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. - `Source BetaWorkspaceRateLimitValueSourceUnion` Where `value` comes from. `organization` values are listed only when `include_inherited` is `true`, and then `value` equals `org_limit`. - `type BetaWorkspaceRateLimitWorkspaceSource` - `Type Workspace` Always `workspace`: a workspace-level override is stored. default: workspace - `type BetaWorkspaceRateLimitOrganizationSource` - `Type Organization` Always `organization`: no workspace-level override is stored, so the organization's value applies. default: organization - `Value int64` The workspace's value for this limiter type: the workspace-level override when `source.type` is `workspace`, otherwise the organization's value. - `Models []string` Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. - `RateLimitID string` The `id` of the organization's RateLimit entry this entry applies to. - `WorkspaceID string` ID of the Workspace this entry applies to. - `GroupType BetaWorkspaceRateLimitGroupType` **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`. Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`. - `const BetaWorkspaceRateLimitGroupTypeBatch BetaWorkspaceRateLimitGroupType = "batch"` - `const BetaWorkspaceRateLimitGroupTypeFiles BetaWorkspaceRateLimitGroupType = "files"` - `const BetaWorkspaceRateLimitGroupTypeModelGroup BetaWorkspaceRateLimitGroupType = "model_group"` - `const BetaWorkspaceRateLimitGroupTypeSkills BetaWorkspaceRateLimitGroupType = "skills"` - `const BetaWorkspaceRateLimitGroupTypeTokenCount BetaWorkspaceRateLimitGroupType = "token_count"` - `const BetaWorkspaceRateLimitGroupTypeWebSearch BetaWorkspaceRateLimitGroupType = "web_search"` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Organization.Workspaces.RateLimits.List( context.TODO(), "workspace_id", anthropic.BetaOrganizationWorkspaceRateLimitListParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response (200) ```json { "data": [ { "group": { "id": "id", "display_name": "display_name", "type": "model_group" }, "group_type": "batch", "limits": [ { "org_limit": 0, "source": { "type": "workspace" }, "type": "type", "value": 0 } ], "models": [ "string" ], "rate_limit_id": "rate_limit_id", "type": "workspace_rate_limit", "workspace_id": "workspace_id" } ], "next_page": "next_page" } ``` ## Domain types ### Beta Workspace Rate Limit - `type BetaWorkspaceRateLimit` - `Type WorkspaceRateLimit` Object type. Always `workspace_rate_limit` for workspace rate-limit entries. default: workspace_rate_limit - `Group BetaWorkspaceRateLimitGroupUnion` The rate-limit group this entry's limits apply to. Its `type` equals `group_type`. - `type BetaOrganizationRateLimitModelGroup` - `Type ModelGroup` Always `model_group`: a family of models. default: model_group - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `DisplayName string` Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change. - `type BetaOrganizationRateLimitBatchGroup` - `Type Batch` Always `batch`: the Message Batches API. default: batch - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `type BetaOrganizationRateLimitTokenCountGroup` - `Type TokenCount` Always `token_count`: the Token Count API. default: token_count - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `type BetaOrganizationRateLimitFilesGroup` - `Type Files` Always `files`: the Files API. default: files - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `type BetaOrganizationRateLimitSkillsGroup` - `Type Skills` Always `skills`: the Skills API. default: skills - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `type BetaOrganizationRateLimitWebSearchGroup` - `Type WebSearch` Always `web_search`: the Messages API web search tool. default: web_search - `ID string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `Limits []BetaWorkspaceRateLimitValue` 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`. - `Type string` The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - `OrgLimit int64` The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. - `Source BetaWorkspaceRateLimitValueSourceUnion` Where `value` comes from. `organization` values are listed only when `include_inherited` is `true`, and then `value` equals `org_limit`. - `type BetaWorkspaceRateLimitWorkspaceSource` - `Type Workspace` Always `workspace`: a workspace-level override is stored. default: workspace - `type BetaWorkspaceRateLimitOrganizationSource` - `Type Organization` Always `organization`: no workspace-level override is stored, so the organization's value applies. default: organization - `Value int64` The workspace's value for this limiter type: the workspace-level override when `source.type` is `workspace`, otherwise the organization's value. - `Models []string` Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. - `RateLimitID string` The `id` of the organization's RateLimit entry this entry applies to. - `WorkspaceID string` ID of the Workspace this entry applies to. - `GroupType BetaWorkspaceRateLimitGroupType` **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`. Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`. - `const BetaWorkspaceRateLimitGroupTypeBatch BetaWorkspaceRateLimitGroupType = "batch"` - `const BetaWorkspaceRateLimitGroupTypeFiles BetaWorkspaceRateLimitGroupType = "files"` - `const BetaWorkspaceRateLimitGroupTypeModelGroup BetaWorkspaceRateLimitGroupType = "model_group"` - `const BetaWorkspaceRateLimitGroupTypeSkills BetaWorkspaceRateLimitGroupType = "skills"` - `const BetaWorkspaceRateLimitGroupTypeTokenCount BetaWorkspaceRateLimitGroupType = "token_count"` - `const BetaWorkspaceRateLimitGroupTypeWebSearch BetaWorkspaceRateLimitGroupType = "web_search"` ### Beta Workspace Rate Limit Organization Source - `type BetaWorkspaceRateLimitOrganizationSource` - `Type Organization` Always `organization`: no workspace-level override is stored, so the organization's value applies. default: organization ### Beta Workspace Rate Limit Value - `type BetaWorkspaceRateLimitValue` - `Type string` The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - `OrgLimit int64` The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. - `Source BetaWorkspaceRateLimitValueSourceUnion` Where `value` comes from. `organization` values are listed only when `include_inherited` is `true`, and then `value` equals `org_limit`. - `type BetaWorkspaceRateLimitWorkspaceSource` - `Type Workspace` Always `workspace`: a workspace-level override is stored. default: workspace - `type BetaWorkspaceRateLimitOrganizationSource` - `Type Organization` Always `organization`: no workspace-level override is stored, so the organization's value applies. default: organization - `Value int64` The workspace's value for this limiter type: the workspace-level override when `source.type` is `workspace`, otherwise the organization's value. ### Beta Workspace Rate Limit Workspace Source - `type BetaWorkspaceRateLimitWorkspaceSource` - `Type Workspace` Always `workspace`: a workspace-level override is stored. default: workspace