Claude Platform Docs

列出工作区速率限制

$client->organization->workspaces->rateLimits->list(string workspaceID, ?GroupType groupType, ?bool includeInherited, ?int limit, ?string page): PageCursor<WorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

列出工作区的速率限制(rate limit)。

默认情况下,仅返回具有工作区级覆盖设置的组和限制器类型。设置 include_inherited=true 时,将返回工作区可见的所有具有组织级限制的组,并为每个组列出其从组织继承的值以及其自身的覆盖值。每个值的 source 表明其属于哪一种。

省略 limit 时,所有匹配的条目都将在单个页面中返回;当 limit 截断结果时,请跟随 next_page 获取其余条目。

Parameters
workspaceID: string⁠Path parameter

The ID of the workspace.

groupType?: optional GroupType⁠Query parameter

Filter by group type.

includeInherited?: optional bool⁠Query parameter

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

defaultfalse
limit?: optional int⁠Query parameter

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.

page?: optional string⁠Query parameter

Opaque cursor from a previous response's next_page.

Returns
class WorkspaceRateLimit { $type = 'workspace_rate_limit'; $group; $limits; /* 3 more */ }
"workspace_rate_limit" type

Object type. Always workspace_rate_limit for workspace rate-limit entries.

Group group

The rate-limit group this entry's limits apply to.

list<WorkspaceRateLimitValue> limits

The workspace's limiter values for this group. By default only the limiter types with a workspace-level override are listed. With include_inherited set to true, the limiter types the workspace inherits from the organization are listed too, each marked by source.

?list<string> models

Model names this entry's limits apply to, including aliases. null when group.type is not "model_group". The list covers the models this workspace has access to, so it can differ between workspaces.

string rateLimitID

The id of the organization's RateLimit entry this entry applies to.

string workspaceID

ID of the Workspace this entry applies to.

列出工作区速率限制
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Anthropic\Client;

$client = new Client(apiKey: 'my-anthropic-api-key');

$page = $client->organization->workspaces->rateLimits->list(
  'workspace_id',
  groupType: 'batch',
  includeInherited: true,
  limit: 1,
  page: 'page',
);

var_dump($page);
Returns Examples
Response 200
{
  "data": [
    {
      "group": {
        "id": "id",
        "display_name": "display_name",
        "type": "model_group"
      },
      "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"
}