完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

项目

项目相关操作

获取项目

获取实例中的项目。

GET/projects

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 只读。 data.[]name string 是 data.[]type string 是 可选值：personal, team 只读。 data.[]icon object 是 项目图标；项目没有图标时为 null 展开字段 字段 类型 必填 说明 data.[]icon.type string 是 可选值：emoji, icon data.[]icon.value string 是 data.[]icon.color string 否 data.[]description string 是 data.[]customTelemetryTags array 是 data.[]creatorId string 是 data.[]createdAt string 是 只读。 data.[]updatedAt string 是 只读。
nextCursor	string	是	将 cursor 参数设为先前请求返回的 nextCursor 属性，以对项目进行分页。使用默认值时，获取集合的第一页。

下载完整 OpenAPI 定义（JSON）

创建项目

在实例中创建团队项目。

POST/projects

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。

请求体

application/json

字段	类型	必填	说明
name	string	是
id	string	否	项目 ID。省略时，服务器会生成 ID。ID 已被使用时返回 HTTP 409。
icon	object	否	展开字段 字段 类型 必填 说明 icon.type string 是 可选值：emoji, icon icon.value string 是 icon.color string 否
description	string	否
customTelemetryTags	array	否	展开字段 字段 类型 必填 说明 customTelemetryTags.[]key string 是 customTelemetryTags.[]value string 是
type	string	否	只读。

响应

状态码	说明
201	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
409	具有此 ID 的项目已存在。请求不会更改现有项目或其成员。
415	不支持的媒体类型。
422	无法处理的实体

响应结构：201 · application/json

字段	类型	必填	说明
id	string	是	只读。
name	string	是
type	string	是	可选值：personal, team 只读。
icon	object	是	项目图标；项目没有图标时为 null 展开字段 字段 类型 必填 说明 icon.type string 是 可选值：emoji, icon icon.value string 是 icon.color string 否
description	string	是
customTelemetryTags	array	是	展开字段 字段 类型 必填 说明 customTelemetryTags.[]key string 是 customTelemetryTags.[]value string 是
creatorId	string	是
createdAt	string	是	只读。
updatedAt	string	是	只读。
role	string	是	调用方在新项目中的角色。
scopes	array	是	调用方在新项目中拥有的作用域。

下载完整 OpenAPI 定义（JSON）

更新项目

更新实例中的项目。

PUT/projects/{projectId}

请求参数

参数	位置	类型	必填	说明
projectId	path	string	是	项目的 ID。

请求体

application/json

字段	类型	必填	说明
name	string	是
id	string	否	只读。
type	string	否	只读。

响应

状态码	说明
204	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

下载完整 OpenAPI 定义（JSON）

删除项目

从实例中删除项目。

DELETE/projects/{projectId}

请求参数

参数	位置	类型	必填	说明
projectId	path	string	是	项目的 ID。

响应

状态码	说明
204	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

下载完整 OpenAPI 定义（JSON）

列出项目成员

返回项目的所有成员及其角色列表。需要 user:list 作用域。

GET/projects/{projectId}/users

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
projectId	path	string	是	项目的 ID。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 用户的唯一标识符。 只读。 data.[]email string 是 用户的邮箱地址。 只读。 data.[]firstName string 是 用户的名字。 只读。 data.[]lastName string 是 用户的姓氏。 只读。 data.[]createdAt string 是 用户的创建时间。 只读。 data.[]updatedAt string 是 用户上次更新的时间。 只读。 data.[]role string 是 用户在项目中的角色，例如 project:admin、project:viewer。 只读。
nextCursor	string	是	将 cursor 参数设为先前请求返回的 nextCursor 属性，以对项目成员进行分页。使用默认值时，获取集合的第一页。

下载完整 OpenAPI 定义（JSON）

向项目添加一个或多个用户

向实例中的项目添加一个或多个用户。

POST/projects/{projectId}/users

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。
projectId	path	string	是	项目的 ID。

请求体

application/json

字段	类型	必填	说明
relations	array	是	要添加到项目的 userIds 和角色列表。 展开字段 字段 类型 必填 说明 relations.[]userId string 是 用户的唯一标识符。 relations.[]role string 是 分配给用户的项目角色。

响应

状态码	说明
201	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

下载完整 OpenAPI 定义（JSON）

从项目中移除用户

从实例中的项目中移除用户。

DELETE/projects/{projectId}/users/{userId}

请求参数

参数	位置	类型	必填	说明
projectId	path	string	是	项目的 ID。
userId	path	string	是	用户的 ID。

响应

状态码	说明
204	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

下载完整 OpenAPI 定义（JSON）

更改用户的项目角色

更改用户的项目角色。

PATCH/projects/{projectId}/users/{userId}

请求参数

参数	位置	类型	必填	说明
projectId	path	string	是	项目的 ID。
userId	path	string	是	用户的 ID。

请求体

application/json

字段	类型	必填	说明
role	string	是	分配给用户的项目角色。

响应

状态码	说明
204	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

下载完整 OpenAPI 定义（JSON）