SPB Git

Repository Public

rate_limits.md 4.4 KB 199 lines markdown

1---2title: Rate Limits3url: https://platform.claude.com/docs/en/api/beta/organization/rate_limits4---56# Rate Limits78## List Organization Rate Limits910**GET** `/v1/organizations/rate_limits`1112List Messages API rate limits for your organization.1314Each entry corresponds to one rate-limit group (either a model family15or an API-surface category such as the Files API or Message Batches)16and contains the set of limiter values that apply to it.1718When `limit` is omitted, every matching entry is returned in a single19page; when `limit` truncates the result, follow `next_page` to fetch20the remaining entries.2122### Query parameters2324- `group_type: optional "batch" or "files" or "model_group" or 3 more`2526  Filter by group type.2728  - `"batch"`2930  - `"files"`3132  - `"model_group"`3334  - `"skills"`3536  - `"token_count"`3738  - `"web_search"`3940- `limit: optional number`4142  Maximum number of items to return per page. Ranges from `1` to `1000`.4344  When omitted, every remaining entry is returned in a single page and `next_page` is `null`.4546  maximum: 1000, minimum: 14748- `model: optional string`4950  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.5152- `page: optional string`5354  Opaque cursor from a previous response's `next_page`.5556### Returns5758- `data: array of BetaOrganizationRateLimit`5960  Rate-limit entries for the organization, one per group.6162  - `type: "rate_limit"`6364    Object type. Always `rate_limit` for organization rate-limit entries.6566    default: rate_limit6768  - `id: string`6970    Stable identifier for this rate-limit group within the organization.7172  - `group_type: "batch" or "files" or "model_group" or 3 more`7374    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`.7576    - `"batch"`7778    - `"files"`7980    - `"model_group"`8182    - `"skills"`8384    - `"token_count"`8586    - `"web_search"`8788  - `limits: array of BetaOrganizationRateLimitValue`8990    The limiter values that apply to this group.9192    - `type: string`9394      The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).9596    - `value: number`9798      The configured limit value for this limiter type.99100  - `models: array of string or null`101102    Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.103104- `next_page: string or null`105106  Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.107108### Example109110```bash111curl https://api.anthropic.com/v1/organizations/rate_limits \112    -H 'anthropic-version: 2023-06-01' \113    -H "X-Api-Key: $ANTHROPIC_API_KEY"114```115116#### Response (200)117118```json119{120  "data": [121    {122      "id": "id",123      "group_type": "batch",124      "limits": [125        {126          "type": "type",127          "value": 0128        }129      ],130      "models": [131        "string"132      ],133      "type": "rate_limit"134    }135  ],136  "next_page": "next_page"137}138```139140## Domain types141142### Beta Organization Rate Limit143144- `BetaOrganizationRateLimit object`145146  - `type: "rate_limit"`147148    Object type. Always `rate_limit` for organization rate-limit entries.149150    default: rate_limit151152  - `id: string`153154    Stable identifier for this rate-limit group within the organization.155156  - `group_type: "batch" or "files" or "model_group" or 3 more`157158    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`.159160    - `"batch"`161162    - `"files"`163164    - `"model_group"`165166    - `"skills"`167168    - `"token_count"`169170    - `"web_search"`171172  - `limits: array of BetaOrganizationRateLimitValue`173174    The limiter values that apply to this group.175176    - `type: string`177178      The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).179180    - `value: number`181182      The configured limit value for this limiter type.183184  - `models: array of string or null`185186    Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.187188### Beta Organization Rate Limit Value189190- `BetaOrganizationRateLimitValue object`191192  - `type: string`193194    The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).195196  - `value: number`197198    The configured limit value for this limiter type.199
Files main
Menu

Theme