SPB Git

Repository Public

rate_limits.md 5.5 KB


# title: Rate Limits url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits

# Rate Limits

# List Workspace Rate Limits

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

List rate-limit overrides configured for a workspace.

Returns only the groups and limiter types that have a workspace-level override. Groups without overrides inherit the organization limits and are not listed; use GET /v1/organizations/rate_limits to see those.

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.

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

    • "batch"

    • "files"

    • "model_group"

    • "skills"

    • "token_count"

    • "web_search"

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

    maximum: 1000, minimum: 1

  • page: optional string

    Opaque cursor from a previous response's next_page.

# Returns

  • data: array of BetaWorkspaceRateLimit

    Rate-limit entries for the workspace, one per group that has at least one override.

    • type: "workspace_rate_limit"

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

      default: workspace_rate_limit

    • group_type: "batch" or "files" or "model_group" or 3 more

      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.

      • "batch"

      • "files"

      • "model_group"

      • "skills"

      • "token_count"

      • "web_search"

    • limits: array of BetaWorkspaceRateLimitValue

      The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.

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

      • value: number

        The workspace-level override value for this limiter type.

    • 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 RateLimit group this override applies to.

    • workspace_id: string

      ID of the Workspace this override applies to.

  • next_page: string or null

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

# Example

bash
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"

# Response (200)

json
{
  "data": [
    {
      "group_type": "batch",
      "limits": [
        {
          "org_limit": 0,
          "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

  • BetaWorkspaceRateLimit object

    • type: "workspace_rate_limit"

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

      default: workspace_rate_limit

    • group_type: "batch" or "files" or "model_group" or 3 more

      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.

      • "batch"

      • "files"

      • "model_group"

      • "skills"

      • "token_count"

      • "web_search"

    • limits: array of BetaWorkspaceRateLimitValue

      The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.

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

      • value: number

        The workspace-level override value for this limiter type.

    • 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 RateLimit group this override applies to.

    • workspace_id: string

      ID of the Workspace this override applies to.

# Beta Workspace Rate Limit Value

  • BetaWorkspaceRateLimitValue object

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

    • value: number

      The workspace-level override value for this limiter type.

Files main
Menu

Theme