工作区
创建工作区
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 }工作区的数据驻留配置。如果省略,默认值为 workspace_geo=
"us"、allowed_inference_geos="unrestricted"和 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 为
"unrestricted",否则必须是 allowed_inference_geos 的成员。 -
workspace_geo: optional string工作区数据存储的地理区域。创建后不可更改。如果省略,默认为 'us'。
-
-
tags: optional map[string]用户自定义的字符串键值对标签。键不能以
anthropic开头。
返回值
-
Workspace object { id, archived_at, created_at, 5 more }-
id: string工作区的 ID。
-
archived_at: stringRFC 3339 格式的日期时间字符串,表示工作区被归档的时间。如果工作区未被归档,则为
null。 -
created_at: stringRFC 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: stringRFC 3339 格式的日期时间字符串,表示工作区被归档的时间。如果工作区未被归档,则为
null。 -
created_at: stringRFC 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: stringRFC 3339 格式的日期时间字符串,表示工作区被归档的时间。如果工作区未被归档,则为
null。 -
created_at: stringRFC 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: stringdata列表中的第一个 ID。可用作上一页的before_id。 -
has_more: boolean指示在请求的分页方向上是否还有更多结果。
-
last_id: stringdata列表中的最后一个 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 为
"unrestricted",否则必须是 allowed_inference_geos 的成员。
-
-
name: optional string工作区的名称。
-
tags: optional map[string]用户自定义的字符串键值对标签。键不能以
anthropic开头。
返回值
-
Workspace object { id, archived_at, created_at, 5 more }-
id: string工作区的 ID。
-
archived_at: stringRFC 3339 格式的日期时间字符串,表示工作区被归档的时间。如果工作区未被归档,则为
null。 -
created_at: stringRFC 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: stringRFC 3339 格式的日期时间字符串,表示工作区被归档的时间。如果工作区未被归档,则为
null。 -
created_at: stringRFC 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"
}
成员
创建工作区成员
post /v1/organizations/workspaces/{workspace_id}/members
创建工作区成员
路径参数
-
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"
}
获取工作区成员
get /v1/organizations/workspaces/{workspace_id}/members/{user_id}
获取工作区成员
路径参数
-
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: stringdata列表中的第一个 ID。可用作上一页的before_id。 -
has_more: boolean指示在请求的分页方向上是否还有更多结果。
-
last_id: stringdata列表中的最后一个 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"
}
更新工作区成员
post /v1/organizations/workspaces/{workspace_id}/members/{user_id}
更新工作区成员
路径参数
-
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"
}
领域类型
工作区成员
-
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提供的令牌,用于检索下一页数据。
-