Cloud Agents API 多个资源共用的响应信封与基础对象。
Metadata 对象
metadata 是调用方自定义的扁平字符串键值对象。
|
规则 |
说明 |
|
结构 |
JSON object,所有 value 都必须是 string |
|
最大键数量 |
16 |
|
key 最大长度 |
64 个 Unicode 字符 |
|
value 最大长度 |
512 个 Unicode 字符 |
|
默认值 |
省略时为 |
示例:
{
"team": "docs",
"project": "cloud-agents"
}
分页列表
列表接口返回统一的游标分页信封。
|
字段 |
类型 |
说明 |
|
|
|
array |
当前页的资源对象数组 |
|
|
|
boolean |
是否还有更多数据 |
|
|
|
string | null |
当前页第一条记录的游标 ID; |
|
|
|
string | null |
当前页最后一条记录的游标 ID; |
错误信封
错误响应使用以下结构:
{
"type": "error",
"error": {
"type": "invalid_request_error",
"message": "Field 'name' is required."
}
}
|
字段 |
类型 |
说明 |
|
|
string |
固定为 |
|
|
string |
错误类别,如 |
|
|
string |
人类可读的错误信息 |
时间戳
时间字段是 UTC 的 ISO 8601 / RFC 3339 字符串,例如 "2026-05-18T15:26:39.61669Z"。部分字段可以为 null,具体以各资源结构说明为准。
ID 前缀
|
资源 |
前缀 |
|
Agent |
|
|
Environment |
|
|
Session |
|
|
Session event |
|
|
Session thread |
|
|
Turn |
|
|
File |
|
|
Vault |
|
|
Vault credential |
|
|
Skill |
|
|
Memory store |
|
|
Memory entry |
|
|
Memory version |
|
|
Forward template |
|
|
Forward identity |
|
|
Forward identity config |
|
|
Forward channel |
|
|
Forward QR session |
|
|
Forward schedule |
|
|
Forward schedule run |
|
|
Forward resource |
复用已注册资源自身 ID 前缀 |