知识库Agent Tool操作接口
设置文档有效期
设置文档有效期。validType 支持 PERMANENT、CUSTOM、EXPIRED;CUSTOM 必须传 validStartTime 和 validEndTime。
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| spaceId | int64 | 是 | 知识库空间 ID。 | 123456 |
| docId | int64 | 是 | 文档 ID。 | 987654 |
| validType | string | 是 | 有效期类型,支持 PERMANENT、CUSTOM、EXPIRED。 | CUSTOM |
| validStartTime | string | 否 | 自定义有效期开始时间,格式 yyyy-MM-dd HH:mm:ss。CUSTOM 时必填。 | 2026-06-11 00:00:00 |
| validEndTime | string | 否 | 自定义有效期结束时间,格式 yyyy-MM-dd HH:mm:ss。CUSTOM 时必填。 | 2026-12-31 23:59:59 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。 | 200 |
| msg | string | 响应说明。成功通常为 ok;失败时为错误原因。 | ok |
| message | string | 兼容字段,部分异常场景可能返回错误说明。 | |
| data | object | 操作成功标识。 | |
| └success | boolean | 是否成功。 | true |
错误码
| 状态码 | 描述 |
|---|---|
| 400 | 请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。 |
| 401 | PERSONAL_API 鉴权失败。常见业务码:405 AUTH_FAILED。 |
| 403 | 权限不足。常见业务码:406 FORBIDDEN。 |
| 404 | 资源不存在。常见业务码:404 NOT_FOUND。 |
| 500 | 服务内部异常。常见业务码:500 ERROR。 |
postEndpoint
/api/athena/agent/tool/setDocValidcurl -X POST "https://b.163.com/api/athena/agent/tool/setDocValid" \ -H "Content-Type: application/json" \ -d '{ "spaceId": 123456, "docId": 987654, "validType": "CUSTOM" }'{
"code": 200,
"msg": "ok",
"message": "string",
"data": {
"success": true
}
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}这篇文档有帮助吗?