Claude Platform Docs

Definir limites de taxa do workspace

$ ant organization:workspaces:rate-limits update
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

Define ou remove substituições de limite de taxa para um grupo de limite de taxa em um workspace.

Apenas os tipos de limitador nomeados em limits mudam: um value inteiro define a substituição desse tipo e null a remove. Os tipos não nomeados mantêm seu valor atual. Um valor acima do próprio limite da organização é armazenado, mas o limite da organização ainda se aplica, portanto o menor dos dois é aplicado.

Retorna a entrada do grupo de destino com esta solicitação aplicada, no formato que GET /v1/organizations/workspaces/{workspace_id}/rate_limits retorna. As alterações entram em vigor em até cerca de uma hora.

Parameters
--workspace-id: string⁠Path parameter

The ID of the workspace.

--rate-limit-id: string⁠Path parameter

The id of the organization's rate-limit entry to set overrides for.

--limit: array of WorkspaceRateLimitUpdateValue { type, value }

Limits to set or clear. Unspecified limit types are unchanged.

minItems1
maxItems16
Returns
workspace_rate_limit: object{ type: "workspace_rate_limit", group, limits, 3 more }
type: "workspace_rate_limit"

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

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:
organization_rate_limit_model_group: object{ type: "model_group", id, display_name }
type: "model_group"

Always model_group: a family of models.

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.

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

Always batch: the Message Batches API.

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.

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

Always token_count: the Token Count API.

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.

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

Always files: the Files API.

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.

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

Always skills: the Skills API.

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.

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

Always web_search: the Messages API web search tool.

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

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:
workspace_rate_limit_workspace_source: object{ type: "workspace" }
type: "workspace"

Always workspace: a workspace-level override is stored.

workspace_rate_limit_organization_source: object{ type: "organization" }
type: "organization"

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

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

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.

Definir limites de taxa do workspace
ant organization:workspaces:rate-limits update \
  --api-key my-anthropic-api-key \
  --workspace-id workspace_id \
  --rate-limit-id rate_limit_id \
  --limit '{type: fast_itpmca, value: 0}'
Returns Examples
Response 200
{
  "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"
}