完整文档索引见 llms.txt。在页面 URL 后附加
.md即可获取 Markdown 版本;本页的 Markdown 版本可在此获取。
标签
标签相关操作
获取所有标签
获取实例中的所有标签。
GET
/tags请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
limit | query | number | 否 | 最多返回的数据项数量。 默认值: |
cursor | query | string | 否 | 将 cursor 参数设为上次请求响应中的 nextCursor 属性,以进行分页。使用默认值时,获取集合的第一页。更多信息,请参阅分页说明。 |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | array | 是 | 展开字段
| ||||||||||||||||||||
nextCursor | string | 是 |
创 建标签
在实例中创建标签。
POST
/tags请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
Idempotency-Key | header | string | 否 | 此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求,会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试,会返回 409。 |
请求体
application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 否 | 只读。 |
name | string | 是 | |
createdAt | string | 否 | 只读。 |
updatedAt | string | 否 | 只读。 |
响应
| 状态码 | 说明 |
|---|---|
201 | 操作成功。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
409 | 冲突 |
415 | 不支持的媒体类 型。 |
422 | 无法处理的实体 |
响应结构:201 · application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 是 | 只读。 |
name | string | 是 | |
createdAt | string | 是 | 只读。 |
updatedAt | string | 是 | 只读。 |
获取标签
获取标签。
GET
/tags/{tagId}请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
tagId | path | string | 是 | 标签的 ID。 |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
401 | 未授权 |
403 | 禁止访问 |
404 | 未找到指定资源。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 是 | 只读。 |
name | string | 是 | |
createdAt | string | 是 | 只读。 |
updatedAt | string | 是 | 只读。 |
更新标签
更新标签。
PUT
/tags/{tagId}请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
tagId | path | string | 是 | 标签的 ID。 |
请求体
application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 否 | 只读。 |
name | string | 是 | |
createdAt | string | 否 | 只读。 |
updatedAt | string | 否 | 只读。 |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
404 | 未找到指定资源。 |
409 | 冲突 |
415 | 不支持的媒体类型。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 是 | 只读。 |
name | string | 是 | |
createdAt | string | 否 | 只读。 |
updatedAt | string | 否 | 只读。 |
删除标签
删除标签。
DELETE
/tags/{tagId}请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
tagId | path | string | 是 | 标签的 ID。 |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
401 | 未授权 |
403 | 禁止访问 |
404 | 未找到指定资源。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 是 | 只读。 |
name | string | 是 | |
createdAt | string | 是 | 只读。 |
updatedAt | string | 是 | 只读。 |