Claude Platform Docs
管理组织

Claude Tag API

从您自己的系统为您的 Claude Enterprise 组织管理 Slack 中的 Claude Tag:读取和更改频道、工作区以及组织 Slack 默认设置上的设置,查看哪些设置生效及其原因,并附加 Access bundle。

Claude Tag 是在 Slack 中作为团队成员工作的 Claude:有人在频道中提及 Claude,Claude 就会在该线程中回答。借助 Claude Tag API,您可以从自己的系统读取和更改 Claude Tag 设置,而这些设置原本需要组织所有者在 claude.ai > Organization settings > Claude Tag 中手动设置。您可以用它从审批工作流中逐个频道开启 Claude,将配置保存在版本控制中,或审计每个频道中生效的设置。

Claude Tag 是一款 claude.ai 产品。此 API 为 Claude Enterprise 组织管理该产品,与 Claude Platform 工作区、API 用量或 Claude Console 无关。

端点

该 API 在五种资源上共提供 18 个端点:

资源端点
Slack 频道: 设置频道、列出工作区的频道或按 Slack ID 查找频道、读取频道、更改其设置、查看其中生效的设置、移除频道POST /v1/organizations/claude_tag/slack_channels
GET /v1/organizations/claude_tag/slack_channels
GET /v1/organizations/claude_tag/slack_channels/{id}
POST /v1/organizations/claude_tag/slack_channels/{id}
GET /v1/organizations/claude_tag/slack_channels/{id}/effective
DELETE /v1/organizations/claude_tag/slack_channels/{id}
Slack 工作区: 列出已连接的工作区或按 Slack ID 查找工作区、读取工作区、更改其设置、查看其中生效的设置GET /v1/organizations/claude_tag/slack_workspaces
GET /v1/organizations/claude_tag/slack_workspaces/{id}
POST /v1/organizations/claude_tag/slack_workspaces/{id}
GET /v1/organizations/claude_tag/slack_workspaces/{id}/effective
Slack 默认设置: 读取和更改适用于每个工作区和频道的设置GET /v1/organizations/claude_tag/slack_defaults
POST /v1/organizations/claude_tag/slack_defaults
Bundle: 列出组织的 Access bundle、读取单个 Bundle(只读)GET /v1/organizations/claude_tag/bundles
GET /v1/organizations/claude_tag/bundles/{bundle_id}
Bundle 目标: 列出 Bundle 附加到的位置、将其附加到频道或工作区、读取单条附加记录、将其分离GET /v1/organizations/claude_tag/bundles/{bundle_id}/targets
POST /v1/organizations/claude_tag/bundles/{bundle_id}/targets
GET /v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id}
DELETE /v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id}

此版本涵盖 Slack。连接和断开 Slack 工作区、创建和编辑 Access bundle、支出限额,以及除设置中五项之外的所有 Claude Tag 设置,仍在 claude.ai 中进行。

前提条件

  • 您的组织必须使用 Claude Enterprise 计划,已完成 Claude Tag 设置,并且至少连接了一个 Slack 工作区。
  • 您的主要所有者在 claude.ai > Organization settings > API 中创建具有 read:claude_tag 作用域、write:claude_tag 作用域或两者兼有的 Admin API 密钥。请参阅创建 Admin API 密钥。
  • 每个请求都携带三个标头:x-api-key、anthropic-version: 2023-06-01 和 anthropic-beta: claude-tag-2026-09-28。

Python、TypeScript、C#、Go、Java、PHP 和 Ruby SDK 在 client.beta.organization.claude_tag 下提供这些端点,ant CLI 则在 ant beta:organization:claude-tag 下提供;它们会为您发送 anthropic-version 和 anthropic-beta 标头。本页示例使用各 SDK 的默认客户端,与 CLI 一样,它会从 ANTHROPIC_API_KEY 环境变量中读取 Admin API 密钥;curl 示例从同一变量读取密钥,并在 x-api-key 标头中传递。当 SDK 或 CLI 为您获取更多页面时,limit 设置的是每页大小,而不是总数(请参阅分页)。

API 密钥属于组织,在创建者离开后仍然有效。请勿共享这些密钥,也不要将其提交到源代码管理中。

快速入门

列出您的组织已连接到 Claude Tag 的 Slack 工作区:

client = anthropic.Anthropic()

workspaces = client.beta.organization.claude_tag.slack_workspaces.list()

# 根据需要自动获取更多页面。
for workspace in workspaces:
    print(f"{workspace.id}: {workspace.slack.team_id}")
Response
{
  "data": [
    {
      "type": "slack_workspace",
      "id": "slws_011CZkZnWa7xPc3uJfZe5LgT",
      "slack": {
        "team_id": "T01ABCD2EFG"
      },
      "settings": {
        "enabled": null,
        "instructions": "Answer in English unless asked otherwise.",
        "model": null,
        "environment_id": null,
        "guest_policy": null
      },
      "agent_id": "cagt_011CZkZrFy4aSg8uMkDt9PqW",
      "created_at": "2026-09-02T17:04:11Z",
      "updated_at": "2026-10-06T09:41:53Z"
    }
  ],
  "next_page": null
}

值为 null 的设置表示未在此工作区上设置,因此该工作区会继承它。请参阅存储的设置与生效的设置。

作用域

作用域授予的权限
read:claude_tag本页上的每个 GET 端点。
write:claude_tag本页上的每个 POST 和 DELETE 端点。它不授予读取权限,尽管更改请求的响应中包含已更改的资源。

一个密钥可以同时携带两个作用域。先查找频道再更改它的集成需要两者兼有。没有其他作用域可以授予对这些端点的访问权限。

密钥必须属于整个组织。组织始终是密钥所属的组织,任何请求都不会指定组织。发送 anthropic-workspace-id 标头的请求会返回 400,因为这里的任何内容都不属于 Claude Platform 工作区。

关键概念

本页与 claude.ai 中的名称

此 APIclaude.ai 和 Slack
Slack 工作区Slack 工作区(Slack 也称之为 team)。它与 Claude Platform 工作区无关,后者的 ID 以 wrkspc_ 开头。
Slack 默认设置Default Slack access
设置层级一个 scope:频道、工作区或 Slack 默认设置
Bundle一个 Access bundle
enabledEnable Claude Tag in Slack 开关
instructionsCustom instructions
modelModel
environment_idEnvironment
guest_policyHow should Claude work in channels with guests:restrict 对应 Restrict,channel_only 对应 Channel only,allow 对应 Full access

已设置的频道和工作区

当 Claude Tag 为某个频道或工作区保存了设置记录时,该频道或工作区即为已设置。只有已设置的频道或工作区才有 id,也只有它们会被列出:工作区的完整频道列表由 Slack 而非此 API 保存。

  • 当组织所有者在 claude.ai 中连接工作区时,该工作区即为已设置。没有端点可以设置或移除工作区。
  • 频道可以在 claude.ai 中设置、通过 Claude 在其中的首次使用设置,或通过设置频道设置。
  • Slack 默认设置在首次有人设置 Claude Tag 时即为已设置:所有者连接 Slack 工作区,或成员在 Slack 中登录或首次使用 Claude。

在工作区连接处于活动状态期间,您的组织拥有该工作区及其中的频道。您不拥有的频道或工作区会返回与不存在的频道或工作区相同的 404。

ID

您通过 Slack 显示的 ID 来识别频道。使用按 Slack ID 查找频道查找一次其 id,然后存储并使用该 id。

ID前缀出现位置
Slack 频道资源slch_频道上的 id;请求体和响应中的 slack_channel_id
Slack 工作区资源slws_工作区上的 id;请求体和响应中的 slack_workspace_id
Bundlecapp_Bundle 上的 id;路径中的 {bundle_id}
Bundle 目标btgt_Bundle 目标上的 id;路径中的 {target_id}
Slack 自身的 team IDTslack.team_id;slack_team_id 查询参数
Slack 自身的频道 IDC 或 Gslack.channel_id;slack_channel_id 查询参数

只要频道或工作区处于已设置状态,无论您对其做何更改,其 id 都不会改变,唯一的例外见只读模式。被移除后重新设置的频道或工作区会获得新的 id,旧的 id 会持续返回 404。当存储的 id 返回不带 error_code 的 404 时,请使用相同的密钥和标头获取 Slack 默认设置。该请求不指定任何频道或工作区,因此任何非 404 的状态都表示该 id 已失效:请通过 Slack ID 重新查找该频道或工作区。如果该请求也返回 404,则无法说明该 id 的任何情况:请保留您存储的 id 值,并参阅错误响应。

agent_id(前缀为 cagt_)是 Compliance API 对同一频道或工作区的命名方式,既用作 Claude 在其中运行的会话的所有者,也用于 Activity Feed 事件中。它的有效期与 id 相同。

设置

每个设置层级都存储相同的五项设置,均为可选:

设置类型描述
enabledbooleanClaude 是否开启。
instructionsstringClaude 在每个会话中读取的常设指导。去除首尾空白后最多 8,192 个字符。空白文本会清除该设置。
modelstring新会话启动时使用的模型:您的组织可在 Claude Tag 中使用的模型 ID。最多 128 个字符。
environment_idstring会话运行所在的云环境,前缀为 env_。它必须处于活动状态并属于您的组织。
guest_policyobject当频道中有 Slack 访客时,Claude 对频道中所有人的行为:{"type": "allow"}(Claude 回答)、{"type": "restrict"}(Claude 不回答)或 {"type": "channel_only"}(Claude 仅使用附加到该频道本身的 Bundle 回答)。有关它在通过 Slack Connect 共享或跨 Enterprise Grid 的频道中的含义,请参阅限制访客频道。

model 和 environment_id 仅在写入时检查,之后不再检查:如果模型或环境后来发生变化,两种视图都会继续返回存储的值。

如果组织所有者在 claude.ai 中将某个设置层级置于自托管运行器池上,则其 environment_id 会返回该池的 ID,以 ccpool_ 开头。此 API 无法设置运行器池,对于在存储了运行器池的设置层级上更改或清除 environment_id 的请求,会返回 400。

存储的设置与生效的设置

设置存在于三个层级:频道、频道所在的工作区,以及组织的 Slack 默认设置。每个层级只存储在其上设置的内容。API 为您提供两种视图:

  • 存储视图(获取频道、获取工作区)包含频道或工作区本身存储的内容。未在其上设置的设置为 null。可用它与您在其他地方保存的配置进行比较。
  • 生效视图(获取频道的生效设置、获取工作区的生效设置)包含综合考虑所有层级后生效的内容,sources 指明每个值来自哪个层级。可用它进行审计,或了解 Claude 在某个频道中为何如此表现。

每项设置单独解析:

设置规则没有层级设置时
enabled由设置了它的最近层级决定,因此频道上的 true 会在该频道开启 Claude,即使其工作区存储的是 false。true
instructions累加。所有设置了它的层级的文本会按从最宽泛到最具体的顺序拼接,中间以空行分隔。null
model由设置了它的最近层级决定。null:Claude 使用产品的默认模型
environment_id由设置了它的最近层级决定。null
guest_policy由设置了它的最近层级决定。在已设置 Slack 默认设置的组织中为 restrict

例如,某组织在其 Slack 默认设置上存储了指令,在某个工作区上关闭了 Claude,并在该工作区的一个频道上设置了模型。该频道的生效视图会显示这三个值及其各自来源:

{
  "type": "slack_channel_effective",
  "id": "slch_011CZkZmRt4vNq8sHbYw2KdX",
  "settings": {
    "enabled": false,
    "instructions": "Be brief.",
    "model": "claude-opus-5-5",
    "environment_id": null,
    "guest_policy": { "type": "restrict" }
  },
  "sources": {
    "enabled": {
      "type": "slack_workspace",
      "slack_workspace_id": "slws_011CZkZnWa7xPc3uJfZe5LgT"
    },
    "instructions": [{ "type": "slack_defaults" }],
    "model": {
      "type": "slack_channel",
      "slack_channel_id": "slch_011CZkZmRt4vNq8sHbYw2KdX"
    },
    "environment_id": { "type": "default" },
    "guest_policy": { "type": "default" }
  }
}

来源为以下之一:

type含义
slack_channel频道,在 slack_channel_id 中指明。
slack_workspace工作区,在 slack_workspace_id 中指明。
slack_parent_channel代码频道的父频道,在 slack_channel_id 中指明。代码频道是从另一个频道启动的频道。当父频道是同一工作区中的公共频道时,它位于该频道与工作区之间,并且仅提供 instructions 和 environment_id。
slack_defaults组织的 Slack 默认设置,没有 ID。
default没有层级设置值,因此应用内置默认值。

sources.instructions 是一个列表,按从最宽泛到最具体的顺序列出所有提供文本的层级,没有层级提供时为空。在通过 Slack Enterprise Grid 连接而非频道自身工作区访问该频道的组织中,来源上的 ID 可能为 null。

更改设置

三个更新端点和设置频道都接受遵循相同规则的 settings 对象:

  • 您省略的设置保持不变。 {"settings": {"enabled": false}} 会关闭 Claude,其他四项设置保持原样。
  • 您以 null 发送的设置会被清除,因此该层级会重新继承它。
  • 全有或全无。 如果请求中的任何值被拒绝,则请求中的任何设置都不会被存储。
  • 可安全重复。 每次更改都会使资源保持与第一次相同请求后的状态一致,因此没有端点接受 Idempotency-Key。未做任何更改的请求不会写入任何内容,也不会记录 Activity Feed 事件。
  • 最后写入者胜出。 没有请求接受前置条件。两个调用方各自读取资源后更改同一设置,会相互覆盖。仅当另一项更改在您的请求运行期间与之重叠时才会返回 409;您的请求中没有任何内容被存储,因此请重新读取资源,如果仍有需要,请重新发送更改。

更改频道上的 guest_policy 可能会结束该频道中正在运行的会话。这些会话在后台结束,响应不会等待其完成。

已配置的层级

一旦有人或密钥更改了某个设置层级上的设置或向其附加了 Bundle,该层级即为已配置。此后它将一直保持已配置状态,即使所有设置都被清除、所有 Bundle 都被分离。通过 Claude 的首次使用设置的频道,或通过此 API 在不带任何设置的情况下设置的频道,在首次更改或首次附加 Bundle 之前都不是已配置状态。这在两个地方很重要:只有已配置的频道才能被移除,只有未配置的频道才可能获得新的 id(请参阅只读模式)。

只读模式

API / Terraform read-only mode 是组织所有者在 claude.ai 的 Claude Tag 设置中开启和关闭的一项设置。该名称描述的是 claude.ai 和 Slack:开启此模式时,它们会拒绝个人对此 API 所管理内容的更改,因此只有密钥才能进行这些更改。它不会使此 API 变为只读。无论此模式开启与否,本页上的每个端点的响应都相同,也没有端点读取或更改此模式。

此模式关闭时,个人和密钥会更改相同的设置、附加和分离相同的 Bundle,每次更改都会替换已存储的内容。如果您的流水线应成为唯一的更改来源,请开启此模式。

此模式开启时,claude.ai 和 Slack 会拒绝:

  • 更改频道、工作区或 Slack 默认设置上五项设置中的任何一项。
  • 在 claude.ai 中设置频道、移除频道或断开工作区连接。
  • 将 Bundle 附加到频道或工作区、将其分离,或删除已附加到频道或工作区的 Bundle。

无论此模式开启与否,有些操作都仍然可行:所有者仍可连接新工作区、创建和编辑 Bundle,以及更改此 API 不管理的 Claude Tag 设置。Claude 的首次使用仍会设置频道,在 Slack 中删除频道仍会将其移除,卸载 Claude 的 Slack 应用仍会断开该工作区的连接。

此模式关闭时,在 claude.ai 中设置一个已设置但未配置的频道可能会替换该频道的记录。此时该频道会获得新的 id 和 agent_id,旧的 id 会返回 404。已配置频道的 id 会一直有效,直到该频道被移除。

群组私信

Slack 群组私信的 ID 采用频道的格式,因此 Claude 在其中的使用会像频道一样设置它:它有 id、会被列出,并且可以读取。通过此 API 设置群组私信、更改其设置以及向其附加 Bundle 都会返回 400。允许从中分离 Bundle。

示例工作流

仅在已批准的频道中开启 Claude

任何成员都可以邀请 Claude 加入公共频道。要仅在您已批准的地方开启 Claude:

  1. 通过在 Slack 默认设置上将 enabled 设置为 false,在所有地方关闭 Claude。
  2. 当您的审批系统批准某个频道时,使用 "settings": {"enabled": true} 设置该频道。该请求接受 Slack 自身的 ID,无论频道是否已设置都会返回该频道,因此可以安全重复。
  3. 在同一次运行中,附加该团队获批的 Bundle,使频道的第一个会话就已具备其工具。

将配置保存在版本控制中

  1. 以 Slack 为每个频道显示的 ID 作为配置的键,并通过这些 ID 查找每个频道。
  2. 将存储视图与您的代码仓库声明的内容进行比较。生效视图会混入继承的值。
  3. 仅发送不同的设置,对于代码仓库不再声明的设置发送 null。
  4. 请组织所有者开启只读模式,以免有人手动更改相同的设置。

审计所有地方生效的设置

  1. 列出您的工作区,然后列出每个工作区的频道。
  2. 读取每个频道的生效设置,并标记您的策略所禁止的情况,例如 enabled 为 true 但没有存档审批的频道,或 guest_policy 为 allow 的频道。
  3. 列出您的 Bundle,然后列出每个 Bundle 的目标,以查看对敏感系统的访问权限附加在何处。

Slack 频道

频道对象是单个 Slack 频道的存储视图:

字段描述
typeslack_channel。
id前缀为 slch_。请参阅 ID。
slackSlack 自身的 ID:team_id 表示频道所在的工作区,channel_id 表示频道。
settings频道本身存储的内容。始终存在,包含全部五项设置;未设置的项为 null。
agent_id前缀为 cagt_。请参阅 ID。
created_at频道被设置的时间。
updated_atClaude Tag 对该频道的记录最后一次更改的时间。每次更改设置时(无论是在此处、claude.ai 还是 Slack 中)它都会变化,也可能因此处任何响应都未显示的更改而变化。请将较新的值视为重新读取频道的理由,而不是设置已更改的证据。附加或分离 Bundle 本身不会使其变化。

缺少 slch_ 前缀的 id 会返回 400。带有该前缀但不对应您组织中任何频道的 id 会返回 404。

设置频道

POST /v1/organizations/claude_tag/slack_channels 设置一个 Slack 频道并返回该频道。slack.team_id 和 slack.channel_id 为必填项,是 Slack 自身的 ID。settings 为可选项,并遵循更改设置中的规则。如果频道已设置,请求会返回现有频道并应用 settings;两种情况下响应均为 200。需要 write:claude_tag 作用域。

client = anthropic.Anthropic()

channel = client.beta.organization.claude_tag.slack_channels.create(
    slack={"team_id": "T01ABCD2EFG", "channel_id": "C05HJKL6MNP"},
    settings={"instructions": "Answer in the language of the question."},
)

print(channel.id)
Response
{
  "type": "slack_channel",
  "id": "slch_011CZkZmRt4vNq8sHbYw2KdX",
  "slack": {
    "team_id": "T01ABCD2EFG",
    "channel_id": "C05HJKL6MNP"
  },
  "settings": {
    "enabled": null,
    "instructions": "Answer in the language of the question.",
    "model": null,
    "environment_id": null,
    "guest_policy": null
  },
  "agent_id": "cagt_011CZkZsHz6bTh2vNmEu4QrX",
  "created_at": "2026-10-19T16:20:05Z",
  "updated_at": "2026-10-19T16:20:05Z"
}

在设置频道之前,Claude 的 Slack 应用会向 Slack 确认该频道位于该工作区中、未被归档且对该应用可见。未通过此检查的频道会返回 404,未安装 Claude 的 Slack 应用的工作区也会返回 404。

设置频道和应用 settings 是两个步骤。当第一步成功而第二步被拒绝时,返回的是拒绝响应,频道保持已设置状态且未存储任何内容。该拒绝响应带有以 slack_channel_set_up_ 开头的 error_code,并在 error.details.slack_channel_id 中包含新频道的 id(请参阅错误响应)。请更正 settings 并通过更新请求将其发送到该 id,或再次发送设置请求。

列出频道

GET /v1/organizations/claude_tag/slack_channels 列出一个工作区中已设置的频道,按 created_at 从新到旧排序。slack_team_id 为必填项,是 Slack 自身的工作区 ID。即使 next_page 仍有值,一页中的频道也可能少于 limit 个,甚至没有,因此请持续请求页面,直到 next_page 为 null(请参阅分页)。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

channels = client.beta.organization.claude_tag.slack_channels.list(
    slack_team_id="T01ABCD2EFG"
)

# 根据需要自动获取更多页面。
for channel in channels:
    print(f"{channel.id}: {channel.slack.channel_id}")

响应为 {"data": [...], "next_page": ...},其中每一项都是一个频道对象。指向您的组织不拥有的工作区的 slack_team_id 会返回 404。

按 Slack ID 查找频道

添加 slack_channel_id(Slack 自身的频道 ID)即可查找单个频道。data 包含该频道,如果该频道未设置则为空。查找会忽略 limit 和 page,其 next_page 为 null。这就是查找频道 id 的方法。

client = anthropic.Anthropic()

page = client.beta.organization.claude_tag.slack_channels.list(
    slack_team_id="T01ABCD2EFG",
    slack_channel_id="C05HJKL6MNP",
)

for channel in page.data:
    print(channel.id)

将 slch_ ID 作为 slack_channel_id 传递会返回 400。

获取频道

GET /v1/organizations/claude_tag/slack_channels/{id} 返回频道对象。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

channel = client.beta.organization.claude_tag.slack_channels.retrieve(
    "slch_011CZkZmRt4vNq8sHbYw2KdX"
)

print(channel.settings.enabled)

更新频道

POST /v1/organizations/claude_tag/slack_channels/{id} 更改频道的设置并返回频道对象。settings 为必填项,并遵循更改设置中的规则。需要 write:claude_tag 作用域。

在一个频道中关闭 Claude,并保持其他设置不变:

client = anthropic.Anthropic()

channel = client.beta.organization.claude_tag.slack_channels.update(
    "slch_011CZkZmRt4vNq8sHbYw2KdX",
    settings={"enabled": False},
)

print(channel.settings.enabled)

清除频道的指令,使只有继承的指令生效:

client = anthropic.Anthropic()

channel = client.beta.organization.claude_tag.slack_channels.update(
    "slch_011CZkZmRt4vNq8sHbYw2KdX",
    settings={"instructions": None},
)

print(channel.settings.instructions)

获取频道的生效设置

GET /v1/organizations/claude_tag/slack_channels/{id}/effective 返回在该频道中生效的内容以及每个值的来源。存储的设置与生效的设置展示了一个完整的响应。在此视图中,enabled 和 guest_policy 永远不会是 null。该视图在每次读取时解析,因此没有 created_at 或 updated_at。如果某个层级无法读取,请求将以 503 失败,而不会在缺少该层级的情况下进行解析。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

effective = client.beta.organization.claude_tag.slack_channels.effective.retrieve(
    "slch_011CZkZmRt4vNq8sHbYw2KdX"
)

print(effective.settings.instructions)

移除频道

DELETE /v1/organizations/claude_tag/slack_channels/{id} 将频道从 Claude Tag 中移除。它与组织所有者在 claude.ai 中执行的移除操作相同,效果也相同。它不会删除、归档或更改 Slack 中的频道,也不会影响其中的任何消息。需要 write:claude_tag 作用域。

client = anthropic.Anthropic()

deleted_channel = client.beta.organization.claude_tag.slack_channels.delete(
    "slch_011CZkZmRt4vNq8sHbYw2KdX"
)

print(deleted_channel.id)
Response
{
  "type": "slack_channel_deleted",
  "id": "slch_011CZkZmRt4vNq8sHbYw2KdX"
}

请求一返回,该 id 即返回 404,其余内容在后台删除。重复移除会返回 404。

移除频道并不会让 Claude 在其中停止工作。 Claude 会继续按照该频道继承的设置进行回答,但不再拥有关于该频道的记忆,并且下一次使用时可能会以新的 id 重新设置该频道。

  • 若要让 Claude 停止在某个频道中回答,请改为在该频道上将 enabled 设置为 false。
  • 若要让某个频道不存储任何内容,同时保留其会话和记忆,请改为清除每项设置并分离每个 Bundle。

有两类频道无法在此处移除,并会返回 400:一类是未配置的频道(error_code: "slack_channel_not_configured"),另一类是包含此 API 不管理的配置的频道,例如运行器池或仅 claude.ai 才有的设置。第二类频道由组织所有者在 claude.ai 中移除。

Slack 工作区

工作区对象是单个 Slack 工作区的存储视图。它与频道对象具有相同的字段,不同之处在于 type 为 slack_workspace,id 的前缀为 slws_,且 slack 仅包含 team_id。快速入门中的响应展示了一个完整的工作区对象。

缺少 slws_ 前缀的 id 会返回 400。带有该前缀但不对应您组织中任何工作区的 id 会返回 404。

列出工作区

GET /v1/organizations/claude_tag/slack_workspaces 列出您组织拥有的已设置工作区,按 created_at 从新到旧排序。快速入门展示了请求和响应。若要按 Slack 自身的 ID 查找某个工作区,请添加 slack_team_id:data 会包含该工作区,若该工作区尚未设置则为空;您的组织不拥有的工作区会返回 404。需要 read:claude_tag 作用域。

获取工作区

GET /v1/organizations/claude_tag/slack_workspaces/{id} 返回工作区对象。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

workspace = client.beta.organization.claude_tag.slack_workspaces.retrieve(
    "slws_011CZkZnWa7xPc3uJfZe5LgT"
)

print(workspace.settings.instructions)

更新工作区

POST /v1/organizations/claude_tag/slack_workspaces/{id} 更改工作区的设置并返回工作区对象。settings 为必填项,并遵循更改设置中的规则。您在此处设置的内容适用于该工作区中所有未设置自身值的频道。需要 write:claude_tag 作用域。

client = anthropic.Anthropic()

workspace = client.beta.organization.claude_tag.slack_workspaces.update(
    "slws_011CZkZnWa7xPc3uJfZe5LgT",
    settings={"guest_policy": {"type": "restrict"}},
)

print(workspace.settings.guest_policy)

获取工作区的生效设置

GET /v1/organizations/claude_tag/slack_workspaces/{id}/effective 返回在该工作区中生效的内容,这些内容由工作区和 Slack 默认设置解析得出,其结构如存储的设置与生效的设置所示,且 type 设置为 slack_workspace_effective。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

effective = client.beta.organization.claude_tag.slack_workspaces.effective.retrieve(
    "slws_011CZkZnWa7xPc3uJfZe5LgT"
)

print(effective.settings.enabled)

Slack 默认设置

您的组织恰好有一个 Slack 默认设置对象。它适用于每个工作区和频道,没有 id,也没有生效视图,因为不存在比它更宽泛的层级。

字段描述
typeslack_defaults。
settings默认设置所存储的内容,与频道上的相同。
agent_id前缀为 cagt_。在 Slack 默认设置完成设置之前为 null。

获取 Slack 默认设置

GET /v1/organizations/claude_tag/slack_defaults 返回该对象。尚未设置 Slack 默认设置的组织会收到 200,其中每项设置和 agent_id 均为 null。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

defaults = client.beta.organization.claude_tag.slack_defaults.retrieve()

print(defaults.settings.guest_policy)

更新 Slack 默认设置

POST /v1/organizations/claude_tag/slack_defaults 更改默认设置并返回该对象。settings 为必填项,并遵循更改设置中的规则。在 Slack 默认设置尚未设置时设置某个值的请求会返回 400。需要 write:claude_tag 作用域。

client = anthropic.Anthropic()

defaults = client.beta.organization.claude_tag.slack_defaults.update(
    settings={
        "instructions": "Keep replies under 200 words.",
        "environment_id": "env_011CZkZqDx2zRf5tLjCs7NpV",
    },
)

print(defaults.settings.environment_id)
Response
{
  "type": "slack_defaults",
  "settings": {
    "enabled": null,
    "instructions": "Keep replies under 200 words.",
    "model": null,
    "environment_id": "env_011CZkZqDx2zRf5tLjCs7NpV",
    "guest_policy": null
  },
  "agent_id": "cagt_011CZkZtKa8cUj4wPnFv6RsY"
}

Bundle

Bundle 即 claude.ai 中所称的 Access bundle:一组具名的访问权限,例如连接器、代码仓库和凭据,Claude 可以在频道或工作区中使用它们。组织所有者在 claude.ai 中创建、编辑和删除 Bundle。此 API 用于列出和附加 Bundle。它会返回 Bundle 的名称和描述,但绝不会返回 Bundle 所授予的内容。

字段描述
typebundle。
id前缀为 capp_。
display_nameBundle 的名称。
descriptionBundle 的用途。没有描述时为 null。
created_at、updated_atBundle 的创建时间和最后更改时间。

缺少 capp_ 前缀的 bundle_id 会返回 400。带有该前缀但不存在或属于其他组织的 bundle_id 会返回 404,无论请求中还包含什么内容。Claude Tag 为自身管理的 Bundle 不会被列出,并会返回 404。

列出 Bundle

GET /v1/organizations/claude_tag/bundles 列出您组织的 Bundle,按 created_at 从新到旧排序。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

bundles = client.beta.organization.claude_tag.bundles.list()

# 根据需要自动获取更多页面。
for bundle in bundles:
    print(f"{bundle.id}: {bundle.display_name}")
Response
{
  "data": [
    {
      "type": "bundle",
      "id": "capp_011CZkZjLP1cWxj5EtMmdgbq",
      "display_name": "Support tools",
      "description": "Issue tracker and the support runbooks repository.",
      "created_at": "2026-09-12T08:15:30Z",
      "updated_at": "2026-09-30T13:02:47Z"
    }
  ],
  "next_page": null
}

获取 Bundle

GET /v1/organizations/claude_tag/bundles/{bundle_id} 返回 Bundle 对象。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

bundle = client.beta.organization.claude_tag.bundles.retrieve(
    "capp_011CZkZjLP1cWxj5EtMmdgbq"
)

print(bundle.display_name)

Bundle 目标

Bundle 目标是一个 Bundle 附加到一个频道或一个工作区的记录。附加到工作区的 Bundle 可以在该工作区及其中的每个频道中使用。附加到频道的 Bundle 只能在该频道中使用。

字段描述
typeslack_channel 或 slack_workspace。
id前缀为 btgt_。它是路径中的 {target_id},绝不是频道或工作区自身的 id。
slack_channel_id在 slack_channel 目标上:频道的 id,前缀为 slch_。
slack_workspace_id在 slack_workspace 目标上:工作区的 id,前缀为 slws_。
created_atBundle 的附加时间。

一个 Bundle 最多只能附加到某个频道或工作区一次,并且同一组配对始终具有相同的 id,即使在分离后重新附加也是如此。该 id 是不透明的:请从附加操作的响应或列表中获取它。Bundle 目标不包含其 Bundle 的 id,而其路径同样需要该 id,因此请将两者一起保存。

附加到频道或工作区的第一个 Bundle 会使其成为已配置状态。附加或分离不会更改任何存储的设置。在该频道或工作区中正在运行的会话会收到其访问权限已更改的通知。

claude.ai 在值班(on-call)设置中附加的 Bundle 会被列出且可以读取,但无法在此处附加或分离;对于由值班设置管理的频道或工作区,也无法在其上附加或分离任何内容。这些请求均会返回 400。

列出 Bundle 的目标

GET /v1/organizations/claude_tag/bundles/{bundle_id}/targets 列出该 Bundle 所附加到的频道和工作区,按 created_at 从新到旧排序。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

targets = client.beta.organization.claude_tag.bundles.targets.list(
    "capp_011CZkZjLP1cWxj5EtMmdgbq"
)

# 根据需要自动获取更多页面。
for target in targets:
    print(f"{target.id}: {target.type}")
Response
{
  "data": [
    {
      "type": "slack_channel",
      "id": "btgt_011CZkZpBv9yQd6wKhAr8MnU",
      "slack_channel_id": "slch_011CZkZmRt4vNq8sHbYw2KdX",
      "created_at": "2026-10-19T16:21:44Z"
    },
    {
      "type": "slack_workspace",
      "id": "btgt_011CZkZuMc3dVk7xQpGw9StZ",
      "slack_workspace_id": "slws_011CZkZnWa7xPc3uJfZe5LgT",
      "created_at": "2026-09-12T08:17:02Z"
    }
  ],
  "next_page": null
}

仅列出附加到频道和工作区的记录。在 claude.ai 中附加到其他对象(例如 Default Slack access)的 Bundle 没有对应的 Bundle 目标,将某个 Bundle 同时应用于多个频道的规则也没有。因此,Claude 在某个频道中可以使用的 Bundle 可能多于指向该频道的目标。没有任何端点可以列出附加到某个频道或工作区的 Bundle。

附加 Bundle

POST /v1/organizations/claude_tag/bundles/{bundle_id}/targets 附加该 Bundle 并返回 Bundle 目标。请求体指定 type 及相应的 id。频道或工作区必须已经完成设置:附加操作永远不会设置频道。附加一个已附加的配对会返回 200 以及现有的 Bundle 目标。需要 write:claude_tag 作用域。

将 Bundle 附加到频道:

client = anthropic.Anthropic()

target = client.beta.organization.claude_tag.bundles.targets.create(
    "capp_011CZkZjLP1cWxj5EtMmdgbq",
    type="slack_channel",
    slack_channel_id="slch_011CZkZmRt4vNq8sHbYw2KdX",
)

print(target.id)
Response
{
  "type": "slack_channel",
  "id": "btgt_011CZkZpBv9yQd6wKhAr8MnU",
  "slack_channel_id": "slch_011CZkZmRt4vNq8sHbYw2KdX",
  "created_at": "2026-10-19T16:21:44Z"
}

将 Bundle 附加到工作区:

client = anthropic.Anthropic()

target = client.beta.organization.claude_tag.bundles.targets.create(
    "capp_011CZkZjLP1cWxj5EtMmdgbq",
    type="slack_workspace",
    slack_workspace_id="slws_011CZkZnWa7xPc3uJfZe5LgT",
)

print(target.id)

附加到频道的记录带有其生效条件,例如仅在频道中没有 Slack 访客时生效。条件在 claude.ai 中设置,不会在此处返回。通过此 API 附加时使用默认条件,而附加一个已附加的配对不会更改其条件。

获取 Bundle 目标

GET /v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id} 返回 Bundle 目标。缺少 btgt_ 前缀的 target_id 会返回 400。属于其他 Bundle、已被分离,或指向不再处于已设置状态的频道或工作区的 target_id 会返回 404。需要 read:claude_tag 作用域。

client = anthropic.Anthropic()

target = client.beta.organization.claude_tag.bundles.targets.retrieve(
    "btgt_011CZkZpBv9yQd6wKhAr8MnU",
    bundle_id="capp_011CZkZjLP1cWxj5EtMmdgbq",
)

print(target.type)

分离 Bundle

DELETE /v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id} 分离该 Bundle。重复分离会返回 404。需要 write:claude_tag 作用域。

client = anthropic.Anthropic()

deleted_target = client.beta.organization.claude_tag.bundles.targets.delete(
    "btgt_011CZkZpBv9yQd6wKhAr8MnU",
    bundle_id="capp_011CZkZjLP1cWxj5EtMmdgbq",
)

print(deleted_target.id)
Response
{
  "type": "bundle_target_deleted",
  "id": "btgt_011CZkZpBv9yQd6wKhAr8MnU"
}

无法识别的值

guest_policy.type、来源的 type、Bundle 目标的 type 以及错误代码随时可能新增取值。对于您无法识别的值,请像对待任何未知字符串一样处理,而不是直接失败。

速率限制

请求按组织进行限制,分为两个预算,由您组织的所有密钥共享,并且独立于您组织的其他 Admin API 限制。每个预算允许一次突发(burst),然后以稳定的速率补充:

预算请求突发补充
读取每个 GET120每秒 2 个
更改每个 POST 和 DELETE60每秒 1 个

超出预算的请求会返回 429 Too Many Requests,并附带 retry-after 标头。响应中包含该请求所消耗预算的 anthropic-ratelimit-requests-limit、anthropic-ratelimit-requests-remaining 和 anthropic-ratelimit-requests-reset 标头。

分页

列表端点使用 opaque cursor(不透明游标)。第一个请求最多返回 limit 行以及一个 next_page 游标;在下一个请求中将该游标原样作为 page 参数传入,并重复此操作,直到 next_page 为 null。请将游标字符串视为不透明的:不要自行解析、修改或构造它。列出频道可能会返回少于 limit 个频道甚至没有频道的页面,而 next_page 仍然有值,因此请持续请求页面,直到 next_page 为 null。Python、TypeScript、C#、Go、Java 和 Ruby SDK 的列表迭代器以及 CLI(使用 --format raw 时除外)会为您完成这一操作。在 PHP 和 curl 中,请自行请求每一页,并将其 next_page 作为 page 传入。

limit 默认为 20,最小值为 1,最大值为 100。每个列表都按 created_at 从新到旧排序,且不支持其他排序方式。

错误响应

错误响应遵循错误中记录的标准结构。联系支持团队时,请提供响应正文中的 request_id。

状态含义
400输入无效,或该操作不适用于此频道、工作区或 Bundle(请参阅各端点的章节)。
401缺少 x-api-key 标头,或无法识别该密钥。
403该密钥不是具有作用域的组织级密钥、缺少所需的作用域,或您的组织无法进行此更改。
404未找到资源,或资源不属于您的组织。当请求省略 anthropic-beta 值,或您的组织未启用此 API 时也会返回此状态,使这些端点看起来不存在。
409在请求运行期间,有其他操作更改或移除了该资源。未存储任何内容。请重新读取该资源,如果仍需要更改,请重新发送。
429超出速率限制。请参阅速率限制。
500内部错误。
503临时错误。对于更改操作,它不表明更改是否已存储。每个更改都可以安全地重复执行,因此请原样重新发送请求。

当同一状态有多种需要您以不同方式处理的原因时,错误中还会包含 error.details.error_code:

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "...",
    "details": {
      "error_code": "slack_channel_set_up_settings_refused",
      "slack_channel_id": "slch_011CZkZmRt4vNq8sHbYw2KdX"
    }
  },
  "request_id": "req_018EeWyXxfu5pfWkrYcMdjWG"
}
error_code状态含义及处理方式
organization_level_scoped_api_key_required403该凭据不是属于整个组织的、具有作用域的 Admin API 密钥。请向您的主要所有者申请一个。
api_key_scope_missing403该密钥缺少端点所需的 read:claude_tag 或 write:claude_tag。
workspace_selection_not_accepted400请求发送了 anthropic-workspace-id 标头。请将其移除。
claude_tag_writes_not_enabled403您的组织可以通过此 API 读取,但未启用更改功能。
compliance_configuration_restricted403您的组织具有合规配置,在该配置下 Claude Tag 不会存储任何新内容,例如零数据保留。设置频道、更新设置(即使是清除设置)以及附加 Bundle 都会被拒绝。分离 Bundle 和移除频道则不受影响。
environment_not_found404environment_id 未指向您的组织在此处可以使用的任何环境。路径中的 id 没有问题。
environment_archived400environment_id 指向一个已归档的环境。
slack_channel_set_up_settings_refused400请求设置了频道,随后 settings 被拒绝。details.slack_channel_id 即为该频道。请参阅设置频道。
slack_channel_set_up_environment_not_found404请求设置了频道,随后未找到 environment_id。details.slack_channel_id 即为该频道。
slack_channel_set_up_settings_conflict409请求设置了频道,随后另一项更改与 settings 发生重叠。settings 中的任何内容均未存储。details.slack_channel_id 即为该频道。
slack_channel_not_configured400该频道未配置,因此无法移除。

可能会新增代码。对于您无法识别的代码,请按照其状态的处理方式进行处理。不带 error_code 的 404 有两种可能的原因:要么是请求中指定的某项内容未找到(路径中的 id,或请求体或查询中的 Slack 频道或工作区),要么是由于请求省略了 anthropic-beta 值或您的组织未启用此 API,导致每个端点看起来都不存在。要区分这两种情况,请使用相同的密钥和标头获取 Slack 默认设置:该请求不指定任何内容,因此只有在第二种情况下才会返回 404。

Activity Feed 事件

通过此 API 进行的每项更改都会记录在您组织的 Compliance API Activity Feed 中,并归属于该 API 密钥,以携带其 apikey_ ID 的 api_actor 形式记录。这些事件与在 claude.ai 中进行相同更改时 Activity Feed 所记录的事件相同,因此无论更改是通过哪种方式进行的,一次查询即可找到它。

事件触发时机
ccr_agent_created设置频道时。
ccr_agent_updated频道、工作区或 Slack 默认设置上的某项设置发生更改时,或某个层级变为已配置时。
ccr_agent_deleted移除频道时。其 Bundle 目标随之一并移除,且不会单独触发事件。
ccr_agent_proxy_profile_bound附加 Bundle 时。
ccr_agent_proxy_profile_unbound分离 Bundle 时。

这些事件通过 agent_id(而非 id)来标识频道或工作区。两个 Bundle 事件在 profile_id 中标识 Bundle,在 scope_id 中标识频道或工作区。

ccr_agent_updated 事件会在 updated_fields 中列出所更改的内容,使用的是 Activity Feed 自己的名称:

设置在 updated_fields 中的名称
enabledslackbot_version
instructionssystem_prompt_addendum
modeldefault_model
environment_iddefault_environment_id
guest_policyguest_policy
(该层级变为已配置)is_virtual

读取操作、未更改任何内容的请求,以及在存储任何内容之前即被拒绝的请求,都不会记录任何事件。如果一个设置请求设置了频道,但其 settings 随后被拒绝,则会记录 ccr_agent_created。

另请参阅

Was this page helpful?