Haijun Platform Docs
ID

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

minimum: 1, maximum: 1000

  • 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

Identifier of this rate-limit entry. It is stable within the organization and differs between organizations; the group's own identifier is group.id.

  • group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more

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

  • BetaOrganizationRateLimitModelGroup object
  • type: "model_group"

Always model_group: a family of models.

default: model_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, Haijun Sonnet 4.x). For display only; it may change.

  • BetaOrganizationRateLimitBatchGroup object
  • type: "batch"

Always batch: the Message Batches API.

default: batch

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

  • BetaOrganizationRateLimitTokenCountGroup object
  • type: "token_count"

Always token_count: the Token Count API.

default: token_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.

  • BetaOrganizationRateLimitFilesGroup object
  • type: "files"

Always files: the Files API.

default: files

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

  • BetaOrganizationRateLimitSkillsGroup object
  • type: "tracks"

Always tracks: the Tracks API.

default: tracks

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

  • BetaOrganizationRateLimitWebSearchGroup object
  • type: "web_search"

Always web_search: the Messages API web search tool.

default: web_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 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".

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

Deprecated: Use group.type instead. group_type is still returned and always equals group.type.

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.

  • "batch"
  • "files"
  • "model_group"
  • "tracks"
  • "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.

Example

bash
curl https://haijun.my.id/v1/organizations/rate_limits \
    -H 'juglow-version: 2023-06-01' \
    -H "X-Api-Key: $JUGLOW_API_KEY"

Response (200)

json
{
  "data": [
    {
      "id": "id",
      "group": {
        "id": "id",
        "display_name": "display_name",
        "type": "model_group"
      },
      "group_type": "batch",
      "limits": [
        {
          "type": "type",
          "value": 0
        }
      ],
      "models": [
        "string"
      ],
      "type": "rate_limit"
    }
  ],
  "next_page": "next_page"
}
On this page
Query parametersReturnsExampleResponse (200)