ワークスペースのレート制限一覧を取得

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

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

ワークスペースのレート制限を一覧表示します。

デフォルトでは、ワークスペースレベルのオーバーライドを持つグループとリミッタータイプのみを返します。include_inherited=trueを指定すると、ワークスペースから参照可能な組織レベルの制限を持つすべてのグループを返し、それぞれについて組織から継承した値とワークスペース独自のオーバーライドを一覧表示します。各値のsourceは、どちらであるかを示します。

limitを省略すると、一致するすべてのエントリが単一のページで返されます。limitによって結果が切り詰められた場合は、next_pageをたどって残りのエントリを取得してください。

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 WorkspaceRateLimit { type = "workspace_rate_limit"; group; limits; /* 3 more */ }

ワークスペースのレート制限一覧を取得

package com.anthropic.example;

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

public final class Main {
    private Main() {}

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

        RateLimitListPage page = client.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"
}