List Workspace Rate Limits

RateLimitListPage beta().organization().workspaces().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())

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

List a workspace's rate limits.

By default, returns only the groups and limiter types that have a workspace-level override. With include_inherited=true, returns every group with organization-level limits the workspace can see, listing for each the values it inherits from the organization as well as its own overrides. Each value's source says which it is.

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.

Parameters

RateLimitListParams params

Optional<String> workspaceId⁠Path

The ID of the workspace.

Optional<GroupType> groupType⁠Query

Filter by group type.

BATCH("batch")

FILES("files")

MODEL_GROUP("model_group")

SKILLS("skills")

TOKEN_COUNT("token_count")

WEB_SEARCH("web_search")

Optional<Boolean> includeInherited⁠Query

Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override.

Optional<Long> limit⁠Query

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.

minimum1

maximum1000

Optional<String> page⁠Query

Opaque cursor from a previous response's next_page.

Returns

class BetaWorkspaceRateLimit { type = "workspace_rate_limit"; group; groupType; /* 4 more */ }

List Workspace Rate Limits

package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.beta.organization.workspaces.ratelimits.RateLimitListPage;
import com.anthropic.models.beta.organization.workspaces.ratelimits.RateLimitListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        RateLimitListPage page = client.beta().organization().workspaces().rateLimits().list("workspace_id");
    }
}

Response 200

{
  "data": [
    {
      "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"
    }
  ],
  "next_page": "next_page"
}

Returns Examples

Response 200

{
  "data": [
    {
      "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"
    }
  ],
  "next_page": "next_page"
}