Claude Platform Docs

Listar limites de taxa do workspace

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

Lista os "rate limits" (limites de taxa) de um workspace.

Por padrão, retorna apenas os grupos e tipos de limitador que têm uma substituição no nível do workspace. Com include_inherited=true, retorna todos os grupos com limites no nível da organização que o workspace pode ver, listando para cada um os valores herdados da organização, bem como suas próprias substituições. O campo source de cada valor indica qual é o caso.

Quando limit é omitido, todas as entradas correspondentes são retornadas em uma única página; quando limit trunca o resultado, siga next_page para obter as entradas restantes.

Path parameters
workspace_id: string

The ID of the workspace.

Query parameters
group_type: optional "batch" or "files" or "model_group" or 3 more

Filter by group type.

One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
include_inherited: optional boolean

Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override.

defaultfalse
limit: optional number

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.

minimum1
maximum1000
page: optional string

Opaque cursor from a previous response's next_page.

Returns
data: array of WorkspaceRateLimit { type: "workspace_rate_limit", group, group_type, 4 more }

Rate-limit entries for the workspace: one per group with at least one override, or, with include_inherited set to true, one per group the workspace can see that has organization-level limits.

type: "workspace_rate_limit"

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

defaultworkspace_rate_limit
group: OrganizationRateLimitModelGroup or OrganizationRateLimitBatchGroup or OrganizationRateLimitTokenCountGroup or 3 more

The rate-limit group this entry's limits apply to. Its type equals group_type.

One of the following:
OrganizationRateLimitModelGroup object{ type: "model_group", id, display_name }
type: "model_group"

Always model_group: a family of models.

defaultmodel_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.

display_name: string

Human-readable name of the model group (for example, Claude Sonnet 4.x). For display only; it may change.

OrganizationRateLimitBatchGroup object{ type: "batch", id }
type: "batch"

Always batch: the Message Batches API.

defaultbatch
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.

OrganizationRateLimitTokenCountGroup object{ type: "token_count", id }
type: "token_count"

Always token_count: the Token Count API.

defaulttoken_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.

OrganizationRateLimitFilesGroup object{ type: "files", id }
type: "files"

Always files: the Files API.

defaultfiles
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.

OrganizationRateLimitSkillsGroup object{ type: "skills", id }
type: "skills"

Always skills: the Skills API.

defaultskills
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.

OrganizationRateLimitWebSearchGroup object{ type: "web_search", id }
type: "web_search"

Always web_search: the Messages API web search tool.

defaultweb_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: array of WorkspaceRateLimitValue { type, org_limit, source, value }

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).

org_limit: number or null

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

source: WorkspaceRateLimitWorkspaceSource or WorkspaceRateLimitOrganizationSource

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

One of the following:
WorkspaceRateLimitWorkspaceSource object{ type: "workspace" }
type: "workspace"

Always workspace: a workspace-level override is stored.

defaultworkspace
WorkspaceRateLimitOrganizationSource object{ type: "organization" }
type: "organization"

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

defaultorganization
value: number

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

models: array of string or null

Model names this entry's limits apply to, including aliases. null when group_type is not "model_group".

rate_limit_id: string

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

workspace_id: string

ID of the Workspace this entry applies to.

group_type: "batch" or "files" or "model_group" or 3 more⁠Deprecated

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.

Use `group.type` instead. `group_type` is still returned and always equals `group.type`.
One of the following:
"batch"
"files"
"model_group"
"skills"
"token_count"
"web_search"
next_page: string or null

Opaque cursor for the next page of results, or null when no entries remain beyond this response.

Listar limites de taxa do workspace
curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"
Returns Examples
Response 200
{
  "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"
}