SPB Git

Repository Public

rate_limits.md 4.4 KB


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

# Rate Limits

# List Organization Rate Limits

GET /v1/organizations/rate_limits

List Messages API rate limits for your organization.

Each entry corresponds to one rate-limit group (either a model family or an API-surface category such as the Files API or Message Batches) and contains the set of limiter values that apply to it.

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.

# 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

  • model: optional string

    Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization.

  • page: optional string

    Opaque cursor from a previous response's next_page.

# Returns

  • data: array of BetaOrganizationRateLimit

    Rate-limit entries for the organization, one per group.

    • type: "rate_limit"

      Object type. Always rate_limit for organization rate-limit entries.

      default: rate_limit

    • id: string

      Stable identifier for this rate-limit group within the organization.

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

      The limiter values that apply to this group.

      • type: string

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

      • value: number

        The configured limit 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".

  • 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/rate_limits \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "data": [
    {
      "id": "id",
      "group_type": "batch",
      "limits": [
        {
          "type": "type",
          "value": 0
        }
      ],
      "models": [
        "string"
      ],
      "type": "rate_limit"
    }
  ],
  "next_page": "next_page"
}

# Domain types

# Beta Organization Rate Limit

  • BetaOrganizationRateLimit object

    • type: "rate_limit"

      Object type. Always rate_limit for organization rate-limit entries.

      default: rate_limit

    • id: string

      Stable identifier for this rate-limit group within the organization.

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

      The limiter values that apply to this group.

      • type: string

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

      • value: number

        The configured limit 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".

# Beta Organization Rate Limit Value

  • BetaOrganizationRateLimitValue object

    • type: string

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

    • value: number

      The configured limit value for this limiter type.

Files main
Menu

Theme