English ← MyDocs

管理

组织

获取当前组织

get /v1/organizations/me

检索与已认证 API 密钥关联的组织信息。

返回值

  • Organization object { id, name, type }

    • id: string

      组织的 ID。

    • name: string

      组织的名称。

    • type: "organization"

      对象类型。

      对于组织，此值始终为 "organization"。

      • "organization"

示例

curl https://api.anthropic.com/v1/organizations/me \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "id": "12345678-1234-5678-1234-567812345678",
  "name": "Organization Name",
  "type": "organization"
}

域类型

Organization

  • Organization object { id, name, type }

    • id: string

      组织的 ID。

    • name: string

      组织的名称。

    • type: "organization"

      对象类型。

      对于组织，此值始终为 "organization"。

      • "organization"

邀请

创建邀请

post /v1/organizations/invites

创建邀请

请求体参数

  • email: string

    用户的电子邮件。

  • role: "user" or "developer" or "billing" or "claude_code_user"

    被邀请用户的角色。不能为 "admin"。

    • "user"

    • "developer"

    • "billing"

    • "claude_code_user"

返回值

  • Invite object { id, email, expires_at, 4 more }

    • id: string

      邀请的 ID。

    • email: string

      被邀请用户的电子邮件。

    • expires_at: string

      RFC 3339 日期时间字符串，指示邀请的过期时间。

    • invited_at: string

      RFC 3339 日期时间字符串，指示邀请的创建时间。

    • role: "user" or "developer" or "billing" or 2 more

      用户的组织角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • status: "accepted" or "expired" or "deleted" or "pending"

      邀请的状态。

      • "accepted"

      • "expired"

      • "deleted"

      • "pending"

    • type: "invite"

      对象类型。

      对于邀请，此值始终为 "invite"。

      • "invite"

示例

curl https://api.anthropic.com/v1/organizations/invites \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "email": "user@emaildomain.com",
          "role": "user"
        }'

响应

{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "email": "user@emaildomain.com",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "role": "user",
  "status": "pending",
  "type": "invite"
}

获取邀请

get /v1/organizations/invites/{invite_id}

获取邀请

路径参数

  • invite_id: string

    邀请的 ID。

返回值

  • Invite object { id, email, expires_at, 4 more }

    • id: string

      邀请的 ID。

    • email: string

      被邀请用户的电子邮件。

    • expires_at: string

      RFC 3339 日期时间字符串，指示邀请的过期时间。

    • invited_at: string

      RFC 3339 日期时间字符串，指示邀请的创建时间。

    • role: "user" or "developer" or "billing" or 2 more

      用户的组织角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • status: "accepted" or "expired" or "deleted" or "pending"

      邀请的状态。

      • "accepted"

      • "expired"

      • "deleted"

      • "pending"

    • type: "invite"

      对象类型。

      对于邀请，此值始终为 "invite"。

      • "invite"

示例

curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "email": "user@emaildomain.com",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "role": "user",
  "status": "pending",
  "type": "invite"
}

列出邀请

get /v1/organizations/invites

列出邀请

查询参数

  • after_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之后的结果页。

  • before_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之前的结果页。

  • limit: optional number

    每页返回的项目数。

    默认为 20。范围为 1 到 1000。

返回值

  • data: array of Invite

    • id: string

      邀请的 ID。

    • email: string

      被邀请用户的电子邮件。

    • expires_at: string

      RFC 3339 日期时间字符串，指示邀请的过期时间。

    • invited_at: string

      RFC 3339 日期时间字符串，指示邀请的创建时间。

    • role: "user" or "developer" or "billing" or 2 more

      用户的组织角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • status: "accepted" or "expired" or "deleted" or "pending"

      邀请的状态。

      • "accepted"

      • "expired"

      • "deleted"

      • "pending"

    • type: "invite"

      对象类型。

      对于邀请，此值始终为 "invite"。

      • "invite"

  • first_id: string

    data 列表中的第一个 ID。可用作上一页的 before_id。

  • has_more: boolean

    指示在请求的页面方向上是否有更多结果。

  • last_id: string

    data 列表中的最后一个 ID。可用作下一页的 after_id。

示例

curl https://api.anthropic.com/v1/organizations/invites \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
      "email": "user@emaildomain.com",
      "expires_at": "2024-11-20T23:58:27.427722Z",
      "invited_at": "2024-10-30T23:58:27.427722Z",
      "role": "user",
      "status": "pending",
      "type": "invite"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

删除邀请

delete /v1/organizations/invites/{invite_id}

删除邀请

路径参数

  • invite_id: string

    邀请的 ID。

返回值

  • id: string

    邀请的 ID。

  • type: "invite_deleted"

    已删除的对象类型。

    对于邀请，此值始终为 "invite_deleted"。

    • "invite_deleted"

示例

curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \
    -X DELETE \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "type": "invite_deleted"
}

域类型

Invite

  • Invite object { id, email, expires_at, 4 more }

    • id: string

      邀请的 ID。

    • email: string

      被邀请用户的电子邮件。

    • expires_at: string

      RFC 3339 日期时间字符串，指示邀请的过期时间。

    • invited_at: string

      RFC 3339 日期时间字符串，指示邀请的创建时间。

    • role: "user" or "developer" or "billing" or 2 more

      用户的组织角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • status: "accepted" or "expired" or "deleted" or "pending"

      邀请的状态。

      • "accepted"

      • "expired"

      • "deleted"

      • "pending"

    • type: "invite"

      对象类型。

      对于邀请，此值始终为 "invite"。

      • "invite"

邀请删除响应

  • InviteDeleteResponse object { id, type }

    • id: string

      邀请的 ID。

    • type: "invite_deleted"

      已删除的对象类型。

      对于邀请，此值始终为 "invite_deleted"。

      • "invite_deleted"

用户

获取用户

get /v1/organizations/users/{user_id}

获取用户

路径参数

  • user_id: string

    用户的 ID。

返回值

  • User object { id, added_at, email, 3 more }

    • id: string

      用户的 ID。

    • added_at: string

      RFC 3339 日期时间字符串，指示用户加入组织的时间。

    • email: string

      用户的电子邮件。

    • name: string

      用户的名称。

    • role: "user" or "developer" or "billing" or 2 more

      用户的组织角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • type: "user"

      对象类型。

      对于用户，此值始终为 "user"。

      • "user"

示例

curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "added_at": "2024-10-30T23:58:27.427722Z",
  "email": "user@emaildomain.com",
  "name": "Jane Doe",
  "role": "user",
  "type": "user"
}

列出用户

get /v1/organizations/users

列出用户

查询参数

  • after_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之后的结果页。

  • before_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之前的结果页。

  • email: optional string

    按用户电子邮件筛选。

  • limit: optional number

    每页返回的项目数。

    默认为 20。范围为 1 到 1000。

返回值

  • data: array of User

    • id: string

      用户的 ID。

    • added_at: string

      RFC 3339 日期时间字符串，指示用户加入组织的时间。

    • email: string

      用户的电子邮件。

    • name: string

      用户的名称。

    • role: "user" or "developer" or "billing" or 2 more

      用户的组织角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • type: "user"

      对象类型。

      对于用户，此值始终为 "user"。

      • "user"

  • first_id: string

    data 列表中的第一个 ID。可用作上一页的 before_id。

  • has_more: boolean

    指示在请求的页面方向上是否有更多结果。

  • last_id: string

    data 列表中的最后一个 ID。可用作下一页的 after_id。

示例

curl https://api.anthropic.com/v1/organizations/users \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
      "added_at": "2024-10-30T23:58:27.427722Z",
      "email": "user@emaildomain.com",
      "name": "Jane Doe",
      "role": "user",
      "type": "user"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

更新用户

post /v1/organizations/users/{user_id}

更新用户

路径参数

  • user_id: string

    用户的 ID。

请求体参数

  • role: "user" or "developer" or "billing" or "claude_code_user"

    用户的新角色。不能为 "admin"。

    • "user"

    • "developer"

    • "billing"

    • "claude_code_user"

返回值

  • User object { id, added_at, email, 3 more }

    • id: string

      用户的 ID。

    • added_at: string

      RFC 3339 日期时间字符串，指示用户加入组织的时间。

    • email: string

      用户的电子邮件。

    • name: string

      用户的名称。

    • role: "user" or "developer" or "billing" or 2 more

      用户的组织角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • type: "user"

      对象类型。

      对于用户，此值始终为 "user"。

      • "user"

示例

curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "role": "user"
        }'

响应

{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "added_at": "2024-10-30T23:58:27.427722Z",
  "email": "user@emaildomain.com",
  "name": "Jane Doe",
  "role": "user",
  "type": "user"
}

移除用户

delete /v1/organizations/users/{user_id}

移除用户

路径参数

  • user_id: string

    用户的 ID。

返回值

  • id: string

    用户的 ID。

  • type: "user_deleted"

    已删除的对象类型。

    对于用户，此值始终为 "user_deleted"。

    • "user_deleted"

示例

curl https://api.anthropic.com/v1/organizations/users/$USER_ID \
    -X DELETE \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "type": "user_deleted"
}

域类型

User

  • User object { id, added_at, email, 3 more }

    • id: string

      用户的 ID。

    • added_at: string

      RFC 3339 日期时间字符串，指示用户加入组织的时间。

    • email: string

      用户的电子邮件。

    • name: string

      用户的名称。

    • role: "user" or "developer" or "billing" or 2 more

      用户的组织角色。

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • type: "user"

      对象类型。

      对于用户，此值始终为 "user"。

      • "user"

用户删除响应

  • UserDeleteResponse object { id, type }

    • id: string

      用户的 ID。

    • type: "user_deleted"

      已删除的对象类型。

      对于用户，此值始终为 "user_deleted"。

      • "user_deleted"

工作区

创建工作区

post /v1/organizations/workspaces

创建工作区

请求头参数

  • "anthropic-beta": optional array of string

    可选请求头，用于指定要使用的 beta 版本。

    要使用多个 beta，请使用逗号分隔的列表（如 beta1,beta2）或为每个 beta 多次指定请求头。

请求体参数

  • name: string

    工作区的名称。

  • data_residency: optional object { allowed_inference_geos, default_inference_geo, workspace_geo }

    工作区的数据驻留配置。 If omitted, defaults to workspace_geo="us", allowed_inference_geos="unrestricted", and default_inference_geo="global".

    • allowed_inference_geos: optional array of string or "unrestricted"

      允许的推理地理位置值。如果省略则默认为 'unrestricted'，允许所有地理位置。使用字符串 'unrestricted' 允许所有地理位置，或使用特定地理位置列表。

      • array of string

      • "unrestricted"

        • "unrestricted"

    • default_inference_geo: optional string

      当请求省略参数时应用的默认推理地理位置。如果省略则默认为 'global'。必须是 allowed_inference_geos 的成员，除非 allowed_inference_geos 为 "unrestricted"。

    • workspace_geo: optional string

      工作区数据存储的地理位置。创建后不可变。 Defaults to 'us' if omitted.

  • tags: optional map[string]

    用户定义的标签，为字符串键值对。键不能以 anthropic 开头。

返回值

  • Workspace object { id, archived_at, created_at, 5 more }

    • id: string

      工作区的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示工作区的归档时间，如果工作区未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示工作区的创建时间。

    • data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }

      数据驻留配置。

      • allowed_inference_geos: array of string or "unrestricted"

        允许的推理地理位置值。'unrestricted' 表示允许所有地理位置。

        • array of string

        • "unrestricted"

          • "unrestricted"

      • default_inference_geo: string

        当请求省略参数时应用的默认推理地理位置。

      • workspace_geo: string

        工作区数据存储的地理位置。创建后不可变。

    • display_color: string

      在 Anthropic 控制台中表示工作区的十六进制颜色代码。

    • name: string

      工作区的名称。

    • tags: map[string]

      用户定义的标签，为字符串键值对。键不能以 anthropic 开头。

    • type: "workspace"

      对象类型。

      对于工作区，此值始终为 "workspace"。

      • "workspace"

示例

curl https://api.anthropic.com/v1/organizations/workspaces \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "name": "x",
          "tags": {
            "env": "prod",
            "team": "platform"
          }
        }'

响应

{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "data_residency": {
    "allowed_inference_geos": "unrestricted",
    "default_inference_geo": "default_inference_geo",
    "workspace_geo": "workspace_geo"
  },
  "display_color": "#6C5BB9",
  "name": "Workspace Name",
  "tags": {
    "env": "prod",
    "team": "platform"
  },
  "type": "workspace"
}

获取工作区

get /v1/organizations/workspaces/{workspace_id}

获取工作区

路径参数

  • workspace_id: string

    工作区的 ID。

返回值

  • Workspace object { id, archived_at, created_at, 5 more }

    • id: string

      工作区的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示工作区的归档时间，如果工作区未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示工作区的创建时间。

    • data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }

      数据驻留配置。

      • allowed_inference_geos: array of string or "unrestricted"

        允许的推理地理位置值。'unrestricted' 表示允许所有地理位置。

        • array of string

        • "unrestricted"

          • "unrestricted"

      • default_inference_geo: string

        当请求省略参数时应用的默认推理地理位置。

      • workspace_geo: string

        工作区数据存储的地理位置。创建后不可变。

    • display_color: string

      在 Anthropic 控制台中表示工作区的十六进制颜色代码。

    • name: string

      工作区的名称。

    • tags: map[string]

      用户定义的标签，为字符串键值对。键不能以 anthropic 开头。

    • type: "workspace"

      对象类型。

      对于工作区，此值始终为 "workspace"。

      • "workspace"

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "data_residency": {
    "allowed_inference_geos": "unrestricted",
    "default_inference_geo": "default_inference_geo",
    "workspace_geo": "workspace_geo"
  },
  "display_color": "#6C5BB9",
  "name": "Workspace Name",
  "tags": {
    "env": "prod",
    "team": "platform"
  },
  "type": "workspace"
}

列出工作区

get /v1/organizations/workspaces

列出工作区

查询参数

  • after_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之后的结果页。

  • before_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之前的结果页。

  • include_archived: optional boolean

    是否在响应中包含已归档的工作区

  • limit: optional number

    每页返回的项目数。

    默认为 20。范围为 1 到 1000。

返回值

  • data: array of Workspace

    • id: string

      工作区的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示工作区的归档时间，如果工作区未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示工作区的创建时间。

    • data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }

      数据驻留配置。

      • allowed_inference_geos: array of string or "unrestricted"

        允许的推理地理位置值。'unrestricted' 表示允许所有地理位置。

        • array of string

        • "unrestricted"

          • "unrestricted"

      • default_inference_geo: string

        当请求省略参数时应用的默认推理地理位置。

      • workspace_geo: string

        工作区数据存储的地理位置。创建后不可变。

    • display_color: string

      在 Anthropic 控制台中表示工作区的十六进制颜色代码。

    • name: string

      工作区的名称。

    • tags: map[string]

      用户定义的标签，为字符串键值对。键不能以 anthropic 开头。

    • type: "workspace"

      对象类型。

      对于工作区，此值始终为 "workspace"。

      • "workspace"

  • first_id: string

    data 列表中的第一个 ID。可用作上一页的 before_id。

  • has_more: boolean

    指示在请求的页面方向上是否有更多结果。

  • last_id: string

    data 列表中的最后一个 ID。可用作下一页的 after_id。

示例

curl https://api.anthropic.com/v1/organizations/workspaces \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
      "archived_at": "2024-11-01T23:59:27.427722Z",
      "created_at": "2024-10-30T23:58:27.427722Z",
      "data_residency": {
        "allowed_inference_geos": "unrestricted",
        "default_inference_geo": "default_inference_geo",
        "workspace_geo": "workspace_geo"
      },
      "display_color": "#6C5BB9",
      "name": "Workspace Name",
      "tags": {
        "env": "prod",
        "team": "platform"
      },
      "type": "workspace"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

更新工作区

post /v1/organizations/workspaces/{workspace_id}

更新工作区

路径参数

  • workspace_id: string

请求体参数

  • data_residency: optional object { allowed_inference_geos, default_inference_geo }

    工作区的数据驻留配置。

    • allowed_inference_geos: optional array of string or "unrestricted"

      允许的推理地理位置值。使用 'unrestricted' 允许所有地理位置，或使用特定地理位置列表。

      • array of string

      • "unrestricted"

        • "unrestricted"

    • default_inference_geo: optional string

      当请求省略参数时应用的默认推理地理位置。必须是 allowed_inference_geos 的成员，除非 allowed_inference_geos 为 "unrestricted"。

  • name: optional string

    工作区的名称。

  • tags: optional map[string]

    用户定义的标签，为字符串键值对。键不能以 anthropic 开头。

返回值

  • Workspace object { id, archived_at, created_at, 5 more }

    • id: string

      工作区的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示工作区的归档时间，如果工作区未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示工作区的创建时间。

    • data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }

      数据驻留配置。

      • allowed_inference_geos: array of string or "unrestricted"

        允许的推理地理位置值。'unrestricted' 表示允许所有地理位置。

        • array of string

        • "unrestricted"

          • "unrestricted"

      • default_inference_geo: string

        当请求省略参数时应用的默认推理地理位置。

      • workspace_geo: string

        工作区数据存储的地理位置。创建后不可变。

    • display_color: string

      在 Anthropic 控制台中表示工作区的十六进制颜色代码。

    • name: string

      工作区的名称。

    • tags: map[string]

      用户定义的标签，为字符串键值对。键不能以 anthropic 开头。

    • type: "workspace"

      对象类型。

      对于工作区，此值始终为 "workspace"。

      • "workspace"

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "tags": {
            "env": "prod",
            "team": "platform"
          }
        }'

响应

{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "data_residency": {
    "allowed_inference_geos": "unrestricted",
    "default_inference_geo": "default_inference_geo",
    "workspace_geo": "workspace_geo"
  },
  "display_color": "#6C5BB9",
  "name": "Workspace Name",
  "tags": {
    "env": "prod",
    "team": "platform"
  },
  "type": "workspace"
}

归档工作区

post /v1/organizations/workspaces/{workspace_id}/archive

归档工作区

路径参数

  • workspace_id: string

返回值

  • Workspace object { id, archived_at, created_at, 5 more }

    • id: string

      工作区的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示工作区的归档时间，如果工作区未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示工作区的创建时间。

    • data_residency: object { allowed_inference_geos, default_inference_geo, workspace_geo }

      数据驻留配置。

      • allowed_inference_geos: array of string or "unrestricted"

        允许的推理地理位置值。'unrestricted' 表示允许所有地理位置。

        • array of string

        • "unrestricted"

          • "unrestricted"

      • default_inference_geo: string

        当请求省略参数时应用的默认推理地理位置。

      • workspace_geo: string

        工作区数据存储的地理位置。创建后不可变。

    • display_color: string

      在 Anthropic 控制台中表示工作区的十六进制颜色代码。

    • name: string

      工作区的名称。

    • tags: map[string]

      用户定义的标签，为字符串键值对。键不能以 anthropic 开头。

    • type: "workspace"

      对象类型。

      对于工作区，此值始终为 "workspace"。

      • "workspace"

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "data_residency": {
    "allowed_inference_geos": "unrestricted",
    "default_inference_geo": "default_inference_geo",
    "workspace_geo": "workspace_geo"
  },
  "display_color": "#6C5BB9",
  "name": "Workspace Name",
  "tags": {
    "env": "prod",
    "team": "platform"
  },
  "type": "workspace"
}

成员

创建工作区 Member

post /v1/organizations/workspaces/{workspace_id}/members

创建工作区 Member

路径参数

  • workspace_id: string

    工作区的 ID。

请求体参数

  • user_id: string

    用户的 ID。

  • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or "workspace_admin"

    新工作区成员的角色。不能为 "workspace_billing"。

    • "workspace_user"

    • "workspace_developer"

    • "workspace_restricted_developer"

    • "workspace_admin"

返回值

  • WorkspaceMember object { type, user_id, workspace_id, workspace_role }

    • type: "workspace_member"

      对象类型。

      对于工作区成员，此值始终为 "workspace_member"。

      • "workspace_member"

    • user_id: string

      用户的 ID。

    • workspace_id: string

      工作区的 ID。

    • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

      工作区成员的角色。

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
          "workspace_role": "workspace_user"
        }'

响应

{
  "type": "workspace_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "workspace_role": "workspace_user"
}

获取工作区 Member

get /v1/organizations/workspaces/{workspace_id}/members/{user_id}

获取工作区 Member

路径参数

  • workspace_id: string

    工作区的 ID。

  • user_id: string

    用户的 ID。

返回值

  • WorkspaceMember object { type, user_id, workspace_id, workspace_role }

    • type: "workspace_member"

      对象类型。

      对于工作区成员，此值始终为 "workspace_member"。

      • "workspace_member"

    • user_id: string

      用户的 ID。

    • workspace_id: string

      工作区的 ID。

    • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

      工作区成员的角色。

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "type": "workspace_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "workspace_role": "workspace_user"
}

列出工作区成员

get /v1/organizations/workspaces/{workspace_id}/members

列出工作区成员

路径参数

  • workspace_id: string

    工作区的 ID。

查询参数

  • after_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之后的结果页。

  • before_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之前的结果页。

  • limit: optional number

    每页返回的项目数。

    默认为 20。范围为 1 到 1000。

返回值

  • data: array of WorkspaceMember

    • type: "workspace_member"

      对象类型。

      对于工作区成员，此值始终为 "workspace_member"。

      • "workspace_member"

    • user_id: string

      用户的 ID。

    • workspace_id: string

      工作区的 ID。

    • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

      工作区成员的角色。

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

  • first_id: string

    data 列表中的第一个 ID。可用作上一页的 before_id。

  • has_more: boolean

    指示在请求的页面方向上是否有更多结果。

  • last_id: string

    data 列表中的最后一个 ID。可用作下一页的 after_id。

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "type": "workspace_member",
      "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
      "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
      "workspace_role": "workspace_user"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

更新工作区 Member

post /v1/organizations/workspaces/{workspace_id}/members/{user_id}

更新工作区 Member

路径参数

  • workspace_id: string

    工作区的 ID。

  • user_id: string

    用户的 ID。

请求体参数

  • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

    用户的新工作区角色。

    • "workspace_user"

    • "workspace_developer"

    • "workspace_restricted_developer"

    • "workspace_admin"

    • "workspace_billing"

返回值

  • WorkspaceMember object { type, user_id, workspace_id, workspace_role }

    • type: "workspace_member"

      对象类型。

      对于工作区成员，此值始终为 "workspace_member"。

      • "workspace_member"

    • user_id: string

      用户的 ID。

    • workspace_id: string

      工作区的 ID。

    • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

      工作区成员的角色。

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "workspace_role": "workspace_user"
        }'

响应

{
  "type": "workspace_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "workspace_role": "workspace_user"
}

删除工作区成员

delete /v1/organizations/workspaces/{workspace_id}/members/{user_id}

删除工作区成员

路径参数

  • workspace_id: string

    工作区的 ID。

  • user_id: string

    用户的 ID。

返回值

  • type: "workspace_member_deleted"

    已删除的对象类型。

    对于工作区成员，此值始终为 "workspace_member_deleted"。

    • "workspace_member_deleted"

  • user_id: string

    用户的 ID。

  • workspace_id: string

    工作区的 ID。

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
    -X DELETE \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "type": "workspace_member_deleted",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

域类型

Workspace Member

  • WorkspaceMember object { type, user_id, workspace_id, workspace_role }

    • type: "workspace_member"

      对象类型。

      对于工作区成员，此值始终为 "workspace_member"。

      • "workspace_member"

    • user_id: string

      用户的 ID。

    • workspace_id: string

      工作区的 ID。

    • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

      工作区成员的角色。

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

成员删除响应

  • MemberDeleteResponse object { type, user_id, workspace_id }

    • type: "workspace_member_deleted"

      已删除的对象类型。

      对于工作区成员，此值始终为 "workspace_member_deleted"。

      • "workspace_member_deleted"

    • user_id: string

      用户的 ID。

    • workspace_id: string

      工作区的 ID。

速率限制

列出工作区速率限制

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

列出为工作区配置的速率限制覆盖。

仅返回具有工作区级覆盖的组和限制器类型。 没有覆盖的组继承组织限制且不会列出；使用 GET /v1/organizations/rate_limits 查看这些限制。

路径参数

  • workspace_id: string

    工作区的 ID。

查询参数

  • group_type: optional "model_group" or "batch" or "token_count" or 3 more

    按组类型筛选。

    • "model_group"

    • "batch"

    • "token_count"

    • "files"

    • "skills"

    • "web_search"

  • page: optional string

    来自先前响应 next_page 的不透明游标。

返回值

  • data: array of object { group_type, limits, models, type }

    工作区的速率限制条目，每个至少有一个覆盖的组一个。

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

      此条目表示的速率限制组类型。model_group 条目适用于模型系列（列在 models 中）；其他值适用于 API 表面类别，models 设置为 null。

      • "model_group"

      • "batch"

      • "token_count"

      • "files"

      • "skills"

      • "web_search"

    • limits: array of object { org_limit, type, value }

      此工作区中此组覆盖的限制器值。没有工作区覆盖的限制器类型被省略并继承组织值。

      • org_limit: number

        同一限制器类型的组织级别值，供参考。当组织未为此限制器类型配置限制时为 null。

      • type: string

        限制器类型（例如 requests_per_minute 或 input_tokens_per_minute）。

      • value: number

        此限制器类型的工作区级覆盖值。

    • models: array of string

      此条目限制适用的模型名称，包括别名。当 group_type 不是 "model_group" 时为 null。

    • type: "workspace_rate_limit"

      对象类型。对于工作区速率限制条目，始终为 workspace_rate_limit。

      • "workspace_rate_limit"

  • next_page: string

    在后续请求中作为 page 提供的令牌，用于检索下一页数据。

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "group_type": "model_group",
      "limits": [
        {
          "org_limit": 0,
          "type": "type",
          "value": 0
        }
      ],
      "models": [
        "string"
      ],
      "type": "workspace_rate_limit"
    }
  ],
  "next_page": "next_page"
}

域类型

速率限制列表响应

  • RateLimitListResponse object { data, next_page }

    • data: array of object { group_type, limits, models, type }

      工作区的速率限制条目，每个至少有一个覆盖的组一个。

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

        此条目表示的速率限制组类型。model_group 条目适用于模型系列（列在 models 中）；其他值适用于 API 表面类别，models 设置为 null。

        • "model_group"

        • "batch"

        • "token_count"

        • "files"

        • "skills"

        • "web_search"

      • limits: array of object { org_limit, type, value }

        此工作区中此组覆盖的限制器值。没有工作区覆盖的限制器类型被省略并继承组织值。

        • org_limit: number

          同一限制器类型的组织级别值，供参考。当组织未为此限制器类型配置限制时为 null。

        • type: string

          限制器类型（例如 requests_per_minute 或 input_tokens_per_minute）。

        • value: number

          此限制器类型的工作区级覆盖值。

      • models: array of string

        此条目限制适用的模型名称，包括别名。当 group_type 不是 "model_group" 时为 null。

      • type: "workspace_rate_limit"

        对象类型。对于工作区速率限制条目，始终为 workspace_rate_limit。

        • "workspace_rate_limit"

    • next_page: string

      在后续请求中作为 page 提供的令牌，用于检索下一页数据。

API 密钥

获取 API 密钥

get /v1/organizations/api_keys/{api_key_id}

获取 API 密钥

路径参数

  • api_key_id: string

    API 密钥的 ID。

返回值

  • APIKey object { id, created_at, created_by, 6 more }

    • id: string

      API 密钥的 ID。

    • created_at: string

      RFC 3339 日期时间字符串，指示 API 密钥的创建时间。

    • created_by: object { id, type }

      创建 API 密钥的执行者的 ID 和类型。

      • id: string

        创建对象的执行者的 ID。

      • type: string

        创建对象的执行者的类型。

    • expires_at: string

      RFC 3339 日期时间字符串，指示 API 密钥的过期时间，如果永不过期则为 null。

    • name: string

      API 密钥的名称。

    • partial_key_hint: string

      API 密钥的部分编辑提示。

    • status: "active" or "inactive" or "archived" or "expired"

      API 密钥的状态。

      • "active"

      • "inactive"

      • "archived"

      • "expired"

    • type: "api_key"

      对象类型。

      对于 API 密钥，此值始终为 "api_key"。

      • "api_key"

    • workspace_id: string

      与 API 密钥关联的工作区 ID，如果 API 密钥属于默认工作区则为 null。

示例

curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "type": "user"
  },
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "name": "Developer Key",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

列出 API 密钥

get /v1/organizations/api_keys

列出 API 密钥

查询参数

  • after_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之后的结果页。

  • before_id: optional string

    用作分页游标的对象 ID。提供后，将返回此对象之前的结果页。

  • created_by_user_id: optional string

    按创建对象的用户 ID 筛选。

  • limit: optional number

    每页返回的项目数。

    默认为 20。范围为 1 到 1000。

  • status: optional "active" or "inactive" or "archived" or "expired"

    按 API 密钥状态筛选。

    • "active"

    • "inactive"

    • "archived"

    • "expired"

  • workspace_id: optional string

    按工作区 ID 筛选。

返回值

  • data: array of APIKey

    • id: string

      API 密钥的 ID。

    • created_at: string

      RFC 3339 日期时间字符串，指示 API 密钥的创建时间。

    • created_by: object { id, type }

      创建 API 密钥的执行者的 ID 和类型。

      • id: string

        创建对象的执行者的 ID。

      • type: string

        创建对象的执行者的类型。

    • expires_at: string

      RFC 3339 日期时间字符串，指示 API 密钥的过期时间，如果永不过期则为 null。

    • name: string

      API 密钥的名称。

    • partial_key_hint: string

      API 密钥的部分编辑提示。

    • status: "active" or "inactive" or "archived" or "expired"

      API 密钥的状态。

      • "active"

      • "inactive"

      • "archived"

      • "expired"

    • type: "api_key"

      对象类型。

      对于 API 密钥，此值始终为 "api_key"。

      • "api_key"

    • workspace_id: string

      与 API 密钥关联的工作区 ID，如果 API 密钥属于默认工作区则为 null。

  • first_id: string

    data 列表中的第一个 ID。可用作上一页的 before_id。

  • has_more: boolean

    指示在请求的页面方向上是否有更多结果。

  • last_id: string

    data 列表中的最后一个 ID。可用作下一页的 after_id。

示例

curl https://api.anthropic.com/v1/organizations/api_keys \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
      "created_at": "2024-10-30T23:58:27.427722Z",
      "created_by": {
        "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
        "type": "user"
      },
      "expires_at": "2024-10-30T23:58:27.427722Z",
      "name": "Developer Key",
      "partial_key_hint": "sk-ant-api03-R2D...igAA",
      "status": "active",
      "type": "api_key",
      "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

更新 API 密钥

post /v1/organizations/api_keys/{api_key_id}

更新 API 密钥

路径参数

  • api_key_id: string

    API 密钥的 ID。

请求体参数

  • name: optional string

    API 密钥的名称。

  • status: optional "active" or "inactive" or "archived"

    API 密钥的状态。

    • "active"

    • "inactive"

    • "archived"

返回值

  • APIKey object { id, created_at, created_by, 6 more }

    • id: string

      API 密钥的 ID。

    • created_at: string

      RFC 3339 日期时间字符串，指示 API 密钥的创建时间。

    • created_by: object { id, type }

      创建 API 密钥的执行者的 ID 和类型。

      • id: string

        创建对象的执行者的 ID。

      • type: string

        创建对象的执行者的类型。

    • expires_at: string

      RFC 3339 日期时间字符串，指示 API 密钥的过期时间，如果永不过期则为 null。

    • name: string

      API 密钥的名称。

    • partial_key_hint: string

      API 密钥的部分编辑提示。

    • status: "active" or "inactive" or "archived" or "expired"

      API 密钥的状态。

      • "active"

      • "inactive"

      • "archived"

      • "expired"

    • type: "api_key"

      对象类型。

      对于 API 密钥，此值始终为 "api_key"。

      • "api_key"

    • workspace_id: string

      与 API 密钥关联的工作区 ID，如果 API 密钥属于默认工作区则为 null。

示例

curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{}'

响应

{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "type": "user"
  },
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "name": "Developer Key",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

用量报告

获取消息用量报告

get /v1/organizations/usage_report/messages

获取消息用量报告

查询参数

  • starting_at: string

    将返回在此 RFC 3339 时间戳之后或之时开始的时间桶。 每个时间桶将对齐到 UTC 的分钟/小时/天的开始。

  • account_ids: optional array of string

    将返回的用量限制为指定的用户帐户 ID。

  • api_key_ids: optional array of string

    将返回的用量限制为指定的 API 密钥 ID。

  • bucket_width: optional "1d" or "1m" or "1h"

    响应数据的时间粒度。

    • "1d"

    • "1m"

    • "1h"

  • context_window: optional array of "0-200k" or "200k-1M"

    将返回的用量限制为指定的上下文窗口。

    • "0-200k"

    • "200k-1M"

  • ending_at: optional string

    将返回在此 RFC 3339 时间戳之前结束的时间桶。

  • group_by: optional array of "api_key_id" or "workspace_id" or "model" or 6 more

    按可用选项的任意子集分组。按 speed 分组需要 fast-mode-2026-02-01 beta 请求头。

    • "api_key_id"

    • "workspace_id"

    • "model"

    • "service_tier"

    • "context_window"

    • "inference_geo"

    • "speed"

    • "account_id"

    • "service_account_id"

  • inference_geos: optional array of "global" or "us" or "not_available"

    将返回的用量限制为指定的推理地理位置。对于不支持指定 inference_geo 的模型，请使用 not_available。

    • "global"

    • "us"

    • "not_available"

  • limit: optional number

    响应中返回的最大时间桶数。

    默认和最大限制取决于 bucket_width： • "1d": Default of 7 days, maximum of 31 days • "1h": Default of 24 hours, maximum of 168 hours • "1m": Default of 60 minutes, maximum of 1440 minutes

  • models: optional array of string

    将返回的用量限制为指定的模型。

  • page: optional string

    可选设置为先前响应中的 next_page 令牌。

  • service_account_ids: optional array of string

    将返回的用量限制为指定的服务帐户 ID。

  • service_tiers: optional array of "standard" or "batch" or "priority" or 3 more

    将返回的用量限制为指定的服务层级。

    • "standard"

    • "batch"

    • "priority"

    • "priority_on_demand"

    • "flex"

    • "flex_discount"

  • speeds: optional array of "standard" or "fast"

    将返回的用量限制为指定的速度（Claude Code 研究预览）。 需要 fast-mode-2026-02-01 beta 请求头。

    • "standard"

    • "fast"

  • workspace_ids: optional array of string

    将返回的用量限制为指定的工作区 ID。

请求头参数

  • "anthropic-beta": optional array of string

    可选请求头，用于指定要使用的 beta 版本。

    要使用多个 beta，请使用逗号分隔的列表（如 beta1,beta2）或为每个 beta 多次指定请求头。

返回值

  • MessagesUsageReport object { data, has_more, next_page }

    • data: array of object { ending_at, results, starting_at }

      • ending_at: string

        RFC 3339 格式的时间桶结束时间（不包含）。

      • results: array of object { account_id, api_key_id, cache_creation, 10 more }

        此时间桶的用量项目列表。如果指定了一个或多个 group_by[] 参数，则可能有多个项目。

        • account_id: string

          发出请求的用户帐户 ID。如果未按帐户分组或非 OAuth 请求则为 null。

        • api_key_id: string

          使用的 API 密钥 ID。如果未按 API 密钥分组或在 Anthropic 控制台中使用则为 null。

        • cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

          用于缓存创建的输入 token 数量。

          • ephemeral_1h_input_tokens: number

            用于创建 1 小时缓存条目的输入 token 数量。

          • ephemeral_5m_input_tokens: number

            用于创建 5 分钟缓存条目的输入 token 数量。

        • cache_read_input_tokens: number

          从缓存读取的输入 token 数量。

        • context_window: "0-200k" or "200k-1M"

          使用的上下文窗口。如果未按上下文窗口分组则为 null。

          • "0-200k"

          • "200k-1M"

        • inference_geo: string

          使用的推理地理位置，如果设置了则匹配请求的 inference_geo 参数，否则为工作区的 default_inference_geo。 对于不支持指定 inference_geo 的模型，值为 "not_available"。如果未按推理地理位置分组则始终为 null。

        • model: string

          使用的模型。如果未按模型分组则为 null。

        • output_tokens: number

          生成的输出 token 数量。

        • server_tool_use: object { web_search_requests }

          服务端工具使用指标。

          • web_search_requests: number

            发出的网络搜索请求数量。

        • service_account_id: string

          发出请求的服务帐户 ID。如果未按服务帐户分组或非 OIDC 联合请求则为 null。

        • service_tier: "standard" or "batch" or "priority" or 3 more

          使用的服务层级。如果未按服务层级分组则为 null。

          • "standard"

          • "batch"

          • "priority"

          • "priority_on_demand"

          • "flex"

          • "flex_discount"

        • uncached_input_tokens: number

          处理的未缓存输入 token 数量。

        • workspace_id: string

          使用的工作区 ID。如果未按工作区分组或为默认工作区则为 null。

      • starting_at: string

        RFC 3339 格式的时间桶开始时间（包含）。

    • has_more: boolean

      指示是否有更多结果。

    • next_page: string

      在后续请求中作为 page 提供的令牌，用于检索下一页数据。

示例

curl https://api.anthropic.com/v1/organizations/usage_report/messages \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "ending_at": "2025-08-02T00:00:00Z",
      "results": [
        {
          "account_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
          "api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
          "cache_creation": {
            "ephemeral_1h_input_tokens": 1000,
            "ephemeral_5m_input_tokens": 500
          },
          "cache_read_input_tokens": 200,
          "context_window": "0-200k",
          "inference_geo": "global",
          "model": "claude-opus-4-6",
          "output_tokens": 500,
          "server_tool_use": {
            "web_search_requests": 10
          },
          "service_account_id": "svac_01Hk3R9TWxq7CfQak00OiVw4",
          "service_tier": "standard",
          "uncached_input_tokens": 1500,
          "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
        }
      ],
      "starting_at": "2025-08-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_page": "2019-12-27T18:11:19.117Z"
}

获取 Claude Code 用量报告

get /v1/organizations/usage_report/claude_code

检索 Claude Code 用户的每日聚合用量指标。 使组织能够分析开发人员生产力并构建自定义仪表板。

查询参数

  • starting_at: string

    UTC 日期，格式为 YYYY-MM-DD。仅返回此单日的指标。

  • limit: optional number

    每页记录数（默认：20，最大：1000）。

  • page: optional string

    来自先前响应 next_page 字段的不透明游标令牌。

返回值

  • ClaudeCodeUsageReport object { data, has_more, next_page }

    • data: array of object { actor, core_metrics, customer_type, 6 more }

      请求日期的 Claude Code 用量记录列表。

      • actor: object { email_address, type } or object { api_key_name, type }

        执行 Claude Code 操作的用户或 API 密钥。

        • UserActor object { email_address, type }

          • email_address: string

            执行 Claude Code 操作的用户的电子邮件地址。

          • type: "user_actor"

            • "user_actor"

        • APIActor object { api_key_name, type }

          • api_key_name: string

            用于执行 Claude Code 操作的 API 密钥名称。

          • type: "api_actor"

            • "api_actor"

      • core_metrics: object { commits_by_claude_code, lines_of_code, num_sessions, pull_requests_by_claude_code }

        衡量 Claude Code 使用和影响的核心生产力指标。

        • commits_by_claude_code: number

          通过 Claude Code 的提交功能创建的 git 提交数量。

        • lines_of_code: object { added, removed }

          通过 Claude Code 进行的代码更改统计。

          • added: number

            Claude Code 在所有文件中添加的代码行总数。

          • removed: number

            Claude Code 在所有文件中移除的代码行总数。

        • num_sessions: number

          此执行者发起的不同 Claude Code 会话数量。

        • pull_requests_by_claude_code: number

          通过 Claude Code 的 PR 功能创建的拉取请求数量。

      • customer_type: "api" or "subscription"

        客户帐户类型（api 为 API 客户，subscription 为 Pro/Team 客户）。

        • "api"

        • "subscription"

      • date: string

        UTC 日期，格式为 YYYY-MM-DD，用于用量指标。

      • model_breakdown: array of object { estimated_cost, model, tokens }

        按使用的 AI 模型划分的 token 用量和成本细分。

        • estimated_cost: object { amount, currency }

          使用此模型的预估成本

          • amount: number

            预估成本金额，以最小货币单位计（例如美元的美分）。

          • currency: string

            预估成本的货币代码（例如 'USD'）。

        • model: string

          用于 Claude Code 交互的 AI 模型名称。

        • tokens: object { cache_creation, cache_read, input, output }

          此模型的 token 用量细分

          • cache_creation: number

            此模型消耗的缓存创建 token 数量。

          • cache_read: number

            此模型消耗的缓存读取 token 数量。

          • input: number

            此模型消耗的输入 token 数量。

          • output: number

            此模型生成的输出 token 数量。

      • organization_id: string

        拥有 Claude Code 用量的组织 ID。

      • terminal_type: string

        使用 Claude Code 的终端或环境类型。

      • tool_actions: map[object { accepted, rejected } ]

        按工具类型划分的工具操作接受和拒绝率细分。

        • accepted: number

          用户接受的工具操作提案数量。

        • rejected: number

          用户拒绝的工具操作提案数量。

      • subscription_type: optional "enterprise" or "team"

        订阅客户的订阅层级。API 客户为 null。

        • "enterprise"

        • "team"

    • has_more: boolean

      如果当前页之后有更多记录可用则为 True。

    • next_page: string

      用于获取下一页结果的不透明游标令牌，如果没有更多页面可用则为 null。

示例

curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "actor": {
        "email_address": "user@emaildomain.com",
        "type": "user_actor"
      },
      "core_metrics": {
        "commits_by_claude_code": 8,
        "lines_of_code": {
          "added": 342,
          "removed": 128
        },
        "num_sessions": 15,
        "pull_requests_by_claude_code": 2
      },
      "customer_type": "api",
      "date": "2025-08-08T00:00:00Z",
      "model_breakdown": [
        {
          "estimated_cost": {
            "amount": 186,
            "currency": "USD"
          },
          "model": "claude-sonnet-4-20250514",
          "tokens": {
            "cache_creation": 2340,
            "cache_read": 8790,
            "input": 45230,
            "output": 12450
          }
        },
        {
          "estimated_cost": {
            "amount": 42,
            "currency": "USD"
          },
          "model": "claude-3-5-haiku-20241022",
          "tokens": {
            "cache_creation": 890,
            "cache_read": 3420,
            "input": 23100,
            "output": 5680
          }
        }
      ],
      "organization_id": "12345678-1234-5678-1234-567812345678",
      "terminal_type": "iTerm.app",
      "tool_actions": {
        "edit_tool": {
          "accepted": 25,
          "rejected": 3
        },
        "multi_edit_tool": {
          "accepted": 12,
          "rejected": 1
        },
        "notebook_edit_tool": {
          "accepted": 5,
          "rejected": 2
        },
        "write_tool": {
          "accepted": 8,
          "rejected": 0
        }
      },
      "subscription_type": "enterprise"
    }
  ],
  "has_more": true,
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}

域类型

Claude Code 用量报告

  • ClaudeCodeUsageReport object { data, has_more, next_page }

    • data: array of object { actor, core_metrics, customer_type, 6 more }

      请求日期的 Claude Code 用量记录列表。

      • actor: object { email_address, type } or object { api_key_name, type }

        执行 Claude Code 操作的用户或 API 密钥。

        • UserActor object { email_address, type }

          • email_address: string

            执行 Claude Code 操作的用户的电子邮件地址。

          • type: "user_actor"

            • "user_actor"

        • APIActor object { api_key_name, type }

          • api_key_name: string

            用于执行 Claude Code 操作的 API 密钥名称。

          • type: "api_actor"

            • "api_actor"

      • core_metrics: object { commits_by_claude_code, lines_of_code, num_sessions, pull_requests_by_claude_code }

        衡量 Claude Code 使用和影响的核心生产力指标。

        • commits_by_claude_code: number

          通过 Claude Code 的提交功能创建的 git 提交数量。

        • lines_of_code: object { added, removed }

          通过 Claude Code 进行的代码更改统计。

          • added: number

            Claude Code 在所有文件中添加的代码行总数。

          • removed: number

            Claude Code 在所有文件中移除的代码行总数。

        • num_sessions: number

          此执行者发起的不同 Claude Code 会话数量。

        • pull_requests_by_claude_code: number

          通过 Claude Code 的 PR 功能创建的拉取请求数量。

      • customer_type: "api" or "subscription"

        客户帐户类型（api 为 API 客户，subscription 为 Pro/Team 客户）。

        • "api"

        • "subscription"

      • date: string

        UTC 日期，格式为 YYYY-MM-DD，用于用量指标。

      • model_breakdown: array of object { estimated_cost, model, tokens }

        按使用的 AI 模型划分的 token 用量和成本细分。

        • estimated_cost: object { amount, currency }

          使用此模型的预估成本

          • amount: number

            预估成本金额，以最小货币单位计（例如美元的美分）。

          • currency: string

            预估成本的货币代码（例如 'USD'）。

        • model: string

          用于 Claude Code 交互的 AI 模型名称。

        • tokens: object { cache_creation, cache_read, input, output }

          此模型的 token 用量细分

          • cache_creation: number

            此模型消耗的缓存创建 token 数量。

          • cache_read: number

            此模型消耗的缓存读取 token 数量。

          • input: number

            此模型消耗的输入 token 数量。

          • output: number

            此模型生成的输出 token 数量。

      • organization_id: string

        拥有 Claude Code 用量的组织 ID。

      • terminal_type: string

        使用 Claude Code 的终端或环境类型。

      • tool_actions: map[object { accepted, rejected } ]

        按工具类型划分的工具操作接受和拒绝率细分。

        • accepted: number

          用户接受的工具操作提案数量。

        • rejected: number

          用户拒绝的工具操作提案数量。

      • subscription_type: optional "enterprise" or "team"

        订阅客户的订阅层级。API 客户为 null。

        • "enterprise"

        • "team"

    • has_more: boolean

      如果当前页之后有更多记录可用则为 True。

    • next_page: string

      用于获取下一页结果的不透明游标令牌，如果没有更多页面可用则为 null。

消息用量报告

  • MessagesUsageReport object { data, has_more, next_page }

    • data: array of object { ending_at, results, starting_at }

      • ending_at: string

        RFC 3339 格式的时间桶结束时间（不包含）。

      • results: array of object { account_id, api_key_id, cache_creation, 10 more }

        此时间桶的用量项目列表。如果指定了一个或多个 group_by[] 参数，则可能有多个项目。

        • account_id: string

          发出请求的用户帐户 ID。如果未按帐户分组或非 OAuth 请求则为 null。

        • api_key_id: string

          使用的 API 密钥 ID。如果未按 API 密钥分组或在 Anthropic 控制台中使用则为 null。

        • cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

          用于缓存创建的输入 token 数量。

          • ephemeral_1h_input_tokens: number

            用于创建 1 小时缓存条目的输入 token 数量。

          • ephemeral_5m_input_tokens: number

            用于创建 5 分钟缓存条目的输入 token 数量。

        • cache_read_input_tokens: number

          从缓存读取的输入 token 数量。

        • context_window: "0-200k" or "200k-1M"

          使用的上下文窗口。如果未按上下文窗口分组则为 null。

          • "0-200k"

          • "200k-1M"

        • inference_geo: string

          使用的推理地理位置，如果设置了则匹配请求的 inference_geo 参数，否则为工作区的 default_inference_geo。 对于不支持指定 inference_geo 的模型，值为 "not_available"。如果未按推理地理位置分组则始终为 null。

        • model: string

          使用的模型。如果未按模型分组则为 null。

        • output_tokens: number

          生成的输出 token 数量。

        • server_tool_use: object { web_search_requests }

          服务端工具使用指标。

          • web_search_requests: number

            发出的网络搜索请求数量。

        • service_account_id: string

          发出请求的服务帐户 ID。如果未按服务帐户分组或非 OIDC 联合请求则为 null。

        • service_tier: "standard" or "batch" or "priority" or 3 more

          使用的服务层级。如果未按服务层级分组则为 null。

          • "standard"

          • "batch"

          • "priority"

          • "priority_on_demand"

          • "flex"

          • "flex_discount"

        • uncached_input_tokens: number

          处理的未缓存输入 token 数量。

        • workspace_id: string

          使用的工作区 ID。如果未按工作区分组或为默认工作区则为 null。

      • starting_at: string

        RFC 3339 格式的时间桶开始时间（包含）。

    • has_more: boolean

      指示是否有更多结果。

    • next_page: string

      在后续请求中作为 page 提供的令牌，用于检索下一页数据。

成本报告

获取成本报告

get /v1/organizations/cost_report

获取成本报告

查询参数

  • starting_at: string

    将返回在此 RFC 3339 时间戳之后或之时开始的时间桶。 每个时间桶将对齐到 UTC 的分钟/小时/天的开始。

  • bucket_width: optional "1d"

    响应数据的时间粒度。

    • "1d"

  • ending_at: optional string

    将返回在此 RFC 3339 时间戳之前结束的时间桶。

  • group_by: optional array of "workspace_id" or "description"

    按可用选项的任意子集分组。

    • "workspace_id"

    • "description"

  • limit: optional number

    响应中返回的最大时间桶数。

  • page: optional string

    可选设置为先前响应中的 next_page 令牌。

请求头参数

  • "anthropic-beta": optional array of string

    可选请求头，用于指定要使用的 beta 版本。

    要使用多个 beta，请使用逗号分隔的列表（如 beta1,beta2）或为每个 beta 多次指定请求头。

返回值

  • CostReport object { data, has_more, next_page }

    • data: array of object { ending_at, results, starting_at }

      • ending_at: string

        RFC 3339 格式的时间桶结束时间（不包含）。

      • results: array of object { amount, context_window, cost_type, 7 more }

        此时间桶的成本项目列表。如果指定了一个或多个 group_by[] 参数，则可能有多个项目。

        • amount: string

          成本金额，以最小货币单位（例如美分）的十进制字符串表示。例如，"USD" 中的 "123.45" 表示 $1.23。

        • context_window: "0-200k" or "200k-1M"

          使用的输入上下文窗口。如果未按描述分组或非 token 成本则为 null。

          • "0-200k"

          • "200k-1M"

        • cost_type: "tokens" or "web_search" or "code_execution" or "session_usage"

          成本类型。如果未按描述分组则为 null。

          • "tokens"

          • "web_search"

          • "code_execution"

          • "session_usage"

        • currency: string

          成本金额的货币代码。目前始终为 "USD"。

        • description: string

          成本项目的描述。如果未按描述分组则为 null。

        • inference_geo: string

          使用的推理地理位置，如果设置了则匹配请求的 inference_geo 参数，否则为工作区的 default_inference_geo。 对于不支持指定 inference_geo 的模型，值为 "not_available"。如果未按推理地理位置分组则始终为 null。

        • model: string

          使用的模型名称。如果未按描述分组或非 token 成本则为 null。

        • service_tier: "standard" or "batch"

          使用的服务层级。如果未按描述分组或非 token 成本则为 null。

          • "standard"

          • "batch"

        • token_type: "uncached_input_tokens" or "output_tokens" or "cache_read_input_tokens" or 2 more

          token 类型。如果未按描述分组或非 token 成本则为 null。

          • "uncached_input_tokens"

          • "output_tokens"

          • "cache_read_input_tokens"

          • "cache_creation.ephemeral_1h_input_tokens"

          • "cache_creation.ephemeral_5m_input_tokens"

        • workspace_id: string

          此成本关联的工作区 ID。如果未按工作区分组或为默认工作区则为 null。

      • starting_at: string

        RFC 3339 格式的时间桶开始时间（包含）。

    • has_more: boolean

      指示是否有更多结果。

    • next_page: string

      在后续请求中作为 page 提供的令牌，用于检索下一页数据。

示例

curl https://api.anthropic.com/v1/organizations/cost_report \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "ending_at": "2025-08-02T00:00:00Z",
      "results": [
        {
          "amount": "123.78912",
          "context_window": "0-200k",
          "cost_type": "tokens",
          "currency": "USD",
          "description": "Claude Sonnet 4 Usage - Input Tokens",
          "inference_geo": "global",
          "model": "claude-opus-4-6",
          "service_tier": "standard",
          "token_type": "uncached_input_tokens",
          "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
        }
      ],
      "starting_at": "2025-08-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_page": "2019-12-27T18:11:19.117Z"
}

域类型

成本报告

  • CostReport object { data, has_more, next_page }

    • data: array of object { ending_at, results, starting_at }

      • ending_at: string

        RFC 3339 格式的时间桶结束时间（不包含）。

      • results: array of object { amount, context_window, cost_type, 7 more }

        此时间桶的成本项目列表。如果指定了一个或多个 group_by[] 参数，则可能有多个项目。

        • amount: string

          成本金额，以最小货币单位（例如美分）的十进制字符串表示。例如，"USD" 中的 "123.45" 表示 $1.23。

        • context_window: "0-200k" or "200k-1M"

          使用的输入上下文窗口。如果未按描述分组或非 token 成本则为 null。

          • "0-200k"

          • "200k-1M"

        • cost_type: "tokens" or "web_search" or "code_execution" or "session_usage"

          成本类型。如果未按描述分组则为 null。

          • "tokens"

          • "web_search"

          • "code_execution"

          • "session_usage"

        • currency: string

          成本金额的货币代码。目前始终为 "USD"。

        • description: string

          成本项目的描述。如果未按描述分组则为 null。

        • inference_geo: string

          使用的推理地理位置，如果设置了则匹配请求的 inference_geo 参数，否则为工作区的 default_inference_geo。 对于不支持指定 inference_geo 的模型，值为 "not_available"。如果未按推理地理位置分组则始终为 null。

        • model: string

          使用的模型名称。如果未按描述分组或非 token 成本则为 null。

        • service_tier: "standard" or "batch"

          使用的服务层级。如果未按描述分组或非 token 成本则为 null。

          • "standard"

          • "batch"

        • token_type: "uncached_input_tokens" or "output_tokens" or "cache_read_input_tokens" or 2 more

          token 类型。如果未按描述分组或非 token 成本则为 null。

          • "uncached_input_tokens"

          • "output_tokens"

          • "cache_read_input_tokens"

          • "cache_creation.ephemeral_1h_input_tokens"

          • "cache_creation.ephemeral_5m_input_tokens"

        • workspace_id: string

          此成本关联的工作区 ID。如果未按工作区分组或为默认工作区则为 null。

      • starting_at: string

        RFC 3339 格式的时间桶开始时间（包含）。

    • has_more: boolean

      指示是否有更多结果。

    • next_page: string

      在后续请求中作为 page 提供的令牌，用于检索下一页数据。

速率限制

列出组织速率限制

get /v1/organizations/rate_limits

列出组织的消息 API 速率限制。

每个条目对应一个速率限制组（模型系列 或 API 表面类别，如文件 API 或消息批次） 并包含适用于该组的限制器值集。

查询参数

  • group_type: optional "model_group" or "batch" or "token_count" or 3 more

    按组类型筛选。

    • "model_group"

    • "batch"

    • "token_count"

    • "files"

    • "skills"

    • "web_search"

  • model: optional string

    筛选到包含此模型的单个条目。接受完整模型名称和别名。如果模型未找到或此组织没有速率限制则返回 404。

  • page: optional string

    来自先前响应 next_page 的不透明游标。

返回值

  • data: array of object { group_type, limits, models, type }

    组织的速率限制条目，每个组一个。

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

      此条目表示的速率限制组类型。model_group 条目适用于模型系列（列在 models 中）；其他值适用于 API 表面类别，models 设置为 null。

      • "model_group"

      • "batch"

      • "token_count"

      • "files"

      • "skills"

      • "web_search"

    • limits: array of object { type, value }

      适用于此组的限制器值。

      • type: string

        限制器类型（例如 requests_per_minute 或 input_tokens_per_minute）。

      • value: number

        此限制器类型的已配置限制值。

    • models: array of string

      此条目限制适用的模型名称，包括别名。当 group_type 不是 "model_group" 时为 null。

    • type: "rate_limit"

      对象类型。对于组织速率限制条点，始终为 rate_limit。

      • "rate_limit"

  • next_page: string

    在后续请求中作为 page 提供的令牌，用于检索下一页数据。

示例

curl https://api.anthropic.com/v1/organizations/rate_limits \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "group_type": "model_group",
      "limits": [
        {
          "type": "type",
          "value": 0
        }
      ],
      "models": [
        "string"
      ],
      "type": "rate_limit"
    }
  ],
  "next_page": "next_page"
}

域类型

速率限制列表响应

  • RateLimitListResponse object { data, next_page }

    • data: array of object { group_type, limits, models, type }

      组织的速率限制条目，每个组一个。

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

        此条目表示的速率限制组类型。model_group 条目适用于模型系列（列在 models 中）；其他值适用于 API 表面类别，models 设置为 null。

        • "model_group"

        • "batch"

        • "token_count"

        • "files"

        • "skills"

        • "web_search"

      • limits: array of object { type, value }

        适用于此组的限制器值。

        • type: string

          限制器类型（例如 requests_per_minute 或 input_tokens_per_minute）。

        • value: number

          此限制器类型的已配置限制值。

      • models: array of string

        此条目限制适用的模型名称，包括别名。当 group_type 不是 "model_group" 时为 null。

      • type: "rate_limit"

        对象类型。对于组织速率限制条点，始终为 rate_limit。

        • "rate_limit"

    • next_page: string

      在后续请求中作为 page 提供的令牌，用于检索下一页数据。

MCP 隧道

获取隧道

get /v1/organizations/tunnels/{tunnel_id}

按 ID 获取调用者组织中的单个隧道。

路径参数

  • tunnel_id: string

    隧道的 ID。

请求头参数

  • "anthropic-beta": array of "mcp-tunnels-2026-05-19"

    所有隧道端点必需。

    • "mcp-tunnels-2026-05-19"

返回值

  • id: string

    隧道的 ID。

  • archived_at: string

    RFC 3339 日期时间字符串，指示隧道的归档时间， 如果未归档则为 null。

  • created_at: string

    RFC 3339 日期时间字符串，指示隧道的创建时间。

  • display_name: string

    隧道的人类可读名称（1–255 个字符），如果未设置则为 null。

  • domain: string

    Anthropic 为隧道分配的主机名。主机为此值子域的 MCP 服务器 URL 将通过此隧道路由。全局唯一且 永不重用，即使在隧道归档后也是如此。

  • type: "tunnel"

    对象类型。 Always tunnel for Tunnels.

    • "tunnel"

  • workspace_id: string

    此隧道所属的工作区 ID，默认工作区为 null。 创建后不可变。

示例

curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_WIF_BEARER_TOKEN"

响应

{
  "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_name": "Production",
  "domain": "a1b2c3d4.tunnel.anthropic.com",
  "type": "tunnel",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

列出隧道

get /v1/organizations/tunnels

列出组织的隧道。

结果跨越调用者的组织，按创建时间排序 （最新的在前）。使用 workspace_id 筛选单个工作区； 除非设置 include_archived，否则已归档的隧道将被排除。

查询参数

  • include_archived: optional boolean

    在结果中包含已归档的隧道。默认情况下 排除已归档隧道。

  • limit: optional number

    单页返回的最大隧道数。

  • page: optional string

    来自先前响应 next_page 的不透明分页游标。省略以 获取第一页。

  • workspace_id: optional string

    仅返回此工作区中的隧道。接受 wrkspc_ 前缀的 工作区 ID；省略以列出所有工作区的隧道。

请求头参数

  • "anthropic-beta": array of "mcp-tunnels-2026-05-19"

    所有隧道端点必需。

    • "mcp-tunnels-2026-05-19"

返回值

  • data: array of object { id, archived_at, created_at, 4 more }

    • id: string

      隧道的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示隧道的归档时间， 如果未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示隧道的创建时间。

    • display_name: string

      隧道的人类可读名称（1–255 个字符），如果未设置则为 null。

    • domain: string

      Anthropic 为隧道分配的主机名。主机为此值子域的 MCP 服务器 URL 将通过此隧道路由。全局唯一且 永不重用，即使在隧道归档后也是如此。

    • type: "tunnel"

      对象类型。 Always tunnel for Tunnels.

      • "tunnel"

    • workspace_id: string

      此隧道所属的工作区 ID，默认工作区为 null。 创建后不可变。

  • next_page: string

    下一页的不透明游标，如果没有更多结果则为 null。

示例

curl https://api.anthropic.com/v1/organizations/tunnels \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_WIF_BEARER_TOKEN"

响应

{
  "data": [
    {
      "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
      "archived_at": "2024-11-01T23:59:27.427722Z",
      "created_at": "2024-10-30T23:58:27.427722Z",
      "display_name": "Production",
      "domain": "a1b2c3d4.tunnel.anthropic.com",
      "type": "tunnel",
      "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}

显示隧道令牌

post /v1/organizations/tunnels/{tunnel_id}/reveal_token

返回隧道的当前连接令牌。

每次调用时实时获取该值；Anthropic 不存储它。 重复调用返回相同的值，直到令牌被轮换。 使用 POST 暴露，以便令牌不会出现在 中间访问日志中。

路径参数

  • tunnel_id: string

    隧道的 ID。

请求头参数

  • "anthropic-beta": array of "mcp-tunnels-2026-05-19"

    所有隧道端点必需。

    • "mcp-tunnels-2026-05-19"

返回值

  • id: string

    当前令牌值的稳定标识符。令牌轮换时会更改。

  • tunnel_token: string

    隧道的连接令牌。

  • type: "tunnel_token"

    对象类型。对于隧道令牌，始终为 tunnel_token。

    • "tunnel_token"

示例

curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/reveal_token \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_WIF_BEARER_TOKEN"

响应

{
  "id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
  "tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
  "type": "tunnel_token"
}

轮换隧道令牌

post /v1/organizations/tunnels/{tunnel_id}/rotate_token

使隧道的当前令牌对新连接无效，并返回一个新值。

已建立的连接不会因轮换而中断；轮换后重启的 连接器必须使用新值。可选的 reason 用于记录操作上下文。

路径参数

  • tunnel_id: string

    隧道的 ID。

请求头参数

  • "anthropic-beta": array of "mcp-tunnels-2026-05-19"

    所有隧道端点必需。

    • "mcp-tunnels-2026-05-19"

请求体参数

  • reason: optional string

    轮换的可选自由文本原因，记录用于审计。

返回值

  • id: string

    当前令牌值的稳定标识符。令牌轮换时会更改。

  • tunnel_token: string

    隧道的连接令牌。

  • type: "tunnel_token"

    对象类型。对于隧道令牌，始终为 tunnel_token。

    • "tunnel_token"

示例

curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/rotate_token \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_WIF_BEARER_TOKEN"

响应

{
  "id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0",
  "tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==",
  "type": "tunnel_token"
}

归档隧道

post /v1/organizations/tunnels/{tunnel_id}/archive

归档隧道。归档操作不可逆。

隧道上的每个未归档证书都在同一操作中归档， 主机名被停用且永不重新分配， 隧道令牌被无效化。对已归档的隧道重试 将返回不变的现有记录。

路径参数

  • tunnel_id: string

    隧道的 ID。

请求头参数

  • "anthropic-beta": array of "mcp-tunnels-2026-05-19"

    所有隧道端点必需。

    • "mcp-tunnels-2026-05-19"

返回值

  • id: string

    隧道的 ID。

  • archived_at: string

    RFC 3339 日期时间字符串，指示隧道的归档时间， 如果未归档则为 null。

  • created_at: string

    RFC 3339 日期时间字符串，指示隧道的创建时间。

  • display_name: string

    隧道的人类可读名称（1–255 个字符），如果未设置则为 null。

  • domain: string

    Anthropic 为隧道分配的主机名。主机为此值子域的 MCP 服务器 URL 将通过此隧道路由。全局唯一且 永不重用，即使在隧道归档后也是如此。

  • type: "tunnel"

    对象类型。 Always tunnel for Tunnels.

    • "tunnel"

  • workspace_id: string

    此隧道所属的工作区 ID，默认工作区为 null。 创建后不可变。

示例

curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/archive \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_WIF_BEARER_TOKEN"

响应

{
  "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "display_name": "Production",
  "domain": "a1b2c3d4.tunnel.anthropic.com",
  "type": "tunnel",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

域类型

MCP 隧道获取响应

  • MCPTunnelRetrieveResponse object { id, archived_at, created_at, 4 more }

    • id: string

      隧道的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示隧道的归档时间， 如果未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示隧道的创建时间。

    • display_name: string

      隧道的人类可读名称（1–255 个字符），如果未设置则为 null。

    • domain: string

      Anthropic 为隧道分配的主机名。主机为此值子域的 MCP 服务器 URL 将通过此隧道路由。全局唯一且 永不重用，即使在隧道归档后也是如此。

    • type: "tunnel"

      对象类型。 Always tunnel for Tunnels.

      • "tunnel"

    • workspace_id: string

      此隧道所属的工作区 ID，默认工作区为 null。 创建后不可变。

MCP 隧道列表响应

  • MCPTunnelListResponse object { data, next_page }

    • data: array of object { id, archived_at, created_at, 4 more }

      • id: string

        隧道的 ID。

      • archived_at: string

        RFC 3339 日期时间字符串，指示隧道的归档时间， 如果未归档则为 null。

      • created_at: string

        RFC 3339 日期时间字符串，指示隧道的创建时间。

      • display_name: string

        隧道的人类可读名称（1–255 个字符），如果未设置则为 null。

      • domain: string

        Anthropic 为隧道分配的主机名。主机为此值子域的 MCP 服务器 URL 将通过此隧道路由。全局唯一且 永不重用，即使在隧道归档后也是如此。

      • type: "tunnel"

        对象类型。 Always tunnel for Tunnels.

        • "tunnel"

      • workspace_id: string

        此隧道所属的工作区 ID，默认工作区为 null。 创建后不可变。

    • next_page: string

      下一页的不透明游标，如果没有更多结果则为 null。

MCP 隧道显示令牌响应

  • MCPTunnelRevealTokenResponse object { id, tunnel_token, type }

    • id: string

      当前令牌值的稳定标识符。令牌轮换时会更改。

    • tunnel_token: string

      隧道的连接令牌。

    • type: "tunnel_token"

      对象类型。对于隧道令牌，始终为 tunnel_token。

      • "tunnel_token"

MCP 隧道轮换令牌响应

  • MCPTunnelRotateTokenResponse object { id, tunnel_token, type }

    • id: string

      当前令牌值的稳定标识符。令牌轮换时会更改。

    • tunnel_token: string

      隧道的连接令牌。

    • type: "tunnel_token"

      对象类型。对于隧道令牌，始终为 tunnel_token。

      • "tunnel_token"

MCP 隧道归档响应

  • MCPTunnelArchiveResponse object { id, archived_at, created_at, 4 more }

    • id: string

      隧道的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示隧道的归档时间， 如果未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示隧道的创建时间。

    • display_name: string

      隧道的人类可读名称（1–255 个字符），如果未设置则为 null。

    • domain: string

      Anthropic 为隧道分配的主机名。主机为此值子域的 MCP 服务器 URL 将通过此隧道路由。全局唯一且 永不重用，即使在隧道归档后也是如此。

    • type: "tunnel"

      对象类型。 Always tunnel for Tunnels.

      • "tunnel"

    • workspace_id: string

      此隧道所属的工作区 ID，默认工作区为 null。 创建后不可变。

隧道证书

创建隧道证书

post /v1/organizations/tunnels/{tunnel_id}/certificates

为隧道注册公共 CA 证书。

Anthropic 在终止内部 TLS 会话时会根据此 CA 验证网关的服务器证书。PEM 内容必须 恰好包含一个 X.509 证书且无私钥材料。一个隧道 最多持有两个未归档证书。

路径参数

  • tunnel_id: string

    隧道的 ID。

请求头参数

  • "anthropic-beta": array of "mcp-tunnels-2026-05-19"

    所有隧道端点必需。

    • "mcp-tunnels-2026-05-19"

请求体参数

  • ca_certificate_pem: string

    PEM 编码的 X.509 CA 证书。必须恰好包含一个证书且 无私钥材料。

返回值

  • id: string

    隧道证书的 ID。

  • archived_at: string

    RFC 3339 日期时间字符串，指示证书的归档时间， 如果未归档则为 null。

  • created_at: string

    RFC 3339 日期时间字符串，指示证书的注册时间。

  • expires_at: string

    RFC 3339 日期时间字符串，指示证书的过期时间， 如果不过期则为 null。

  • fingerprint: string

    证书的 SHA-256 指纹，为小写十六进制字符串。

  • tunnel_id: string

    此证书注册的隧道 ID。

  • type: "tunnel_certificate"

    对象类型。对于隧道证书，始终为 tunnel_certificate。

    • "tunnel_certificate"

示例

curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_WIF_BEARER_TOKEN" \
    -d '{
          "ca_certificate_pem": "-----BEGIN CERTIFICATE-----\\nMIIBexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexa\\n...illustrative placeholder, not a real certificate...\\n-----END CERTIFICATE-----\\n"
        }'

响应

{
  "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
  "type": "tunnel_certificate"
}

获取隧道 Certificate

get /v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}

按 ID 获取隧道上注册的单个证书。

路径参数

  • tunnel_id: string

    隧道的 ID。

  • certificate_id: string

    隧道证书的 ID。

请求头参数

  • "anthropic-beta": array of "mcp-tunnels-2026-05-19"

    所有隧道端点必需。

    • "mcp-tunnels-2026-05-19"

返回值

  • id: string

    隧道证书的 ID。

  • archived_at: string

    RFC 3339 日期时间字符串，指示证书的归档时间， 如果未归档则为 null。

  • created_at: string

    RFC 3339 日期时间字符串，指示证书的注册时间。

  • expires_at: string

    RFC 3339 日期时间字符串，指示证书的过期时间， 如果不过期则为 null。

  • fingerprint: string

    证书的 SHA-256 指纹，为小写十六进制字符串。

  • tunnel_id: string

    此证书注册的隧道 ID。

  • type: "tunnel_certificate"

    对象类型。对于隧道证书，始终为 tunnel_certificate。

    • "tunnel_certificate"

示例

curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_WIF_BEARER_TOKEN"

响应

{
  "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
  "type": "tunnel_certificate"
}

列出隧道证书

get /v1/organizations/tunnels/{tunnel_id}/certificates

列出隧道上注册的证书。

除非设置 include_archived，否则已归档的证书将被排除。

路径参数

  • tunnel_id: string

    隧道的 ID。

查询参数

  • include_archived: optional boolean

    在结果中包含已归档证书。默认情况下 排除已归档证书。

  • limit: optional number

    返回的最大证书数。

  • page: optional string

    一个隧道最多有两个活跃证书，因此此列表 不分页。

请求头参数

  • "anthropic-beta": array of "mcp-tunnels-2026-05-19"

    所有隧道端点必需。

    • "mcp-tunnels-2026-05-19"

返回值

  • data: array of object { id, archived_at, created_at, 4 more }

    • id: string

      隧道证书的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示证书的归档时间， 如果未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示证书的注册时间。

    • expires_at: string

      RFC 3339 日期时间字符串，指示证书的过期时间， 如果不过期则为 null。

    • fingerprint: string

      证书的 SHA-256 指纹，为小写十六进制字符串。

    • tunnel_id: string

      此证书注册的隧道 ID。

    • type: "tunnel_certificate"

      对象类型。对于隧道证书，始终为 tunnel_certificate。

      • "tunnel_certificate"

  • next_page: string

    下一页的不透明游标，如果没有更多结果则为 null。

示例

curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_WIF_BEARER_TOKEN"

响应

{
  "data": [
    {
      "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
      "archived_at": "2024-11-01T23:59:27.427722Z",
      "created_at": "2024-10-30T23:58:27.427722Z",
      "expires_at": "2024-10-30T23:58:27.427722Z",
      "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
      "type": "tunnel_certificate"
    }
  ],
  "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo="
}

归档隧道 Certificate

post /v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

归档证书，将其从 Anthropic 为此隧道信任的集合中移除。

证书记录将被保留。允许归档最后一个未归档证书； 隧道将拒绝 MCP 流量，直到添加新证书。

路径参数

  • tunnel_id: string

    隧道的 ID。

  • certificate_id: string

    隧道证书的 ID。

请求头参数

  • "anthropic-beta": array of "mcp-tunnels-2026-05-19"

    所有隧道端点必需。

    • "mcp-tunnels-2026-05-19"

返回值

  • id: string

    隧道证书的 ID。

  • archived_at: string

    RFC 3339 日期时间字符串，指示证书的归档时间， 如果未归档则为 null。

  • created_at: string

    RFC 3339 日期时间字符串，指示证书的注册时间。

  • expires_at: string

    RFC 3339 日期时间字符串，指示证书的过期时间， 如果不过期则为 null。

  • fingerprint: string

    证书的 SHA-256 指纹，为小写十六进制字符串。

  • tunnel_id: string

    此证书注册的隧道 ID。

  • type: "tunnel_certificate"

    对象类型。对于隧道证书，始终为 tunnel_certificate。

    • "tunnel_certificate"

示例

curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_WIF_BEARER_TOKEN"

响应

{
  "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8",
  "type": "tunnel_certificate"
}

域类型

隧道证书创建响应

  • TunnelCertificateCreateResponse object { id, archived_at, created_at, 4 more }

    • id: string

      隧道证书的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示证书的归档时间， 如果未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示证书的注册时间。

    • expires_at: string

      RFC 3339 日期时间字符串，指示证书的过期时间， 如果不过期则为 null。

    • fingerprint: string

      证书的 SHA-256 指纹，为小写十六进制字符串。

    • tunnel_id: string

      此证书注册的隧道 ID。

    • type: "tunnel_certificate"

      对象类型。对于隧道证书，始终为 tunnel_certificate。

      • "tunnel_certificate"

隧道证书获取响应

  • TunnelCertificateRetrieveResponse object { id, archived_at, created_at, 4 more }

    • id: string

      隧道证书的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示证书的归档时间， 如果未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示证书的注册时间。

    • expires_at: string

      RFC 3339 日期时间字符串，指示证书的过期时间， 如果不过期则为 null。

    • fingerprint: string

      证书的 SHA-256 指纹，为小写十六进制字符串。

    • tunnel_id: string

      此证书注册的隧道 ID。

    • type: "tunnel_certificate"

      对象类型。对于隧道证书，始终为 tunnel_certificate。

      • "tunnel_certificate"

隧道证书列表响应

  • TunnelCertificateListResponse object { data, next_page }

    • data: array of object { id, archived_at, created_at, 4 more }

      • id: string

        隧道证书的 ID。

      • archived_at: string

        RFC 3339 日期时间字符串，指示证书的归档时间， 如果未归档则为 null。

      • created_at: string

        RFC 3339 日期时间字符串，指示证书的注册时间。

      • expires_at: string

        RFC 3339 日期时间字符串，指示证书的过期时间， 如果不过期则为 null。

      • fingerprint: string

        证书的 SHA-256 指纹，为小写十六进制字符串。

      • tunnel_id: string

        此证书注册的隧道 ID。

      • type: "tunnel_certificate"

        对象类型。对于隧道证书，始终为 tunnel_certificate。

        • "tunnel_certificate"

    • next_page: string

      下一页的不透明游标，如果没有更多结果则为 null。

隧道证书归档响应

  • TunnelCertificateArchiveResponse object { id, archived_at, created_at, 4 more }

    • id: string

      隧道证书的 ID。

    • archived_at: string

      RFC 3339 日期时间字符串，指示证书的归档时间， 如果未归档则为 null。

    • created_at: string

      RFC 3339 日期时间字符串，指示证书的注册时间。

    • expires_at: string

      RFC 3339 日期时间字符串，指示证书的过期时间， 如果不过期则为 null。

    • fingerprint: string

      证书的 SHA-256 指纹，为小写十六进制字符串。

    • tunnel_id: string

      此证书注册的隧道 ID。

    • type: "tunnel_certificate"

      对象类型。对于隧道证书，始终为 tunnel_certificate。

      • "tunnel_certificate"