获取智能体列表
更新时间不可用
检索符合指定条件的智能体列表。
GET
https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/{appid}/agents注意
该接口仅支持查询最近 7 天内创建的智能体列表。
appidstring必填
你的项目使用的 App ID。
channelstring查询指定频道名下的智能体列表。
from_timeinteger查询列表开始时间戳 (s)，默认为 1 天前。
to_timeinteger查询列表结束时间戳 (s)，默认为当前时刻。
statestring指定需要查询智能体的状态，单次查询不支持指定多种状态：
IDLE(0)：空闲状态的智能体。STARTING(1)：正在启动的智能体。RUNNING(2)：正在运行的智能体。STOPPING(3)：正在停止的智能体。STOPPED(4)：已完成退出的智能体。FAILED(6)：执行失败的智能体。
limitinteger分页获取单次返回的最大条数。
cursorstring分页游标，即分页起始位置的 agent_id。
Authorizationstring必填
发送 HTTP 请求时，你可以从以下鉴权方式中任选其一：
- 使用 Token 认证（推荐）：参考实现 HTTP 鉴权生成 Token 并填入
AuthorizationHeader。传参示例：Authorization: agora token="007abcxxxxxxx123"。 - 使用 Basic Auth：参考实现 HTTP 鉴权生成 Base64 编码的
Authorization字段。传参示例：Authorization: Basic NDI1OTQ3N2I4MzYy...YwZjA=。
响应
- 若返回的状态码为
200则表示请求成功。响应包体中包含本次请求的结果。 - 若返回的状态码不为
200则表示请求失败。响应包体中包含错误的类别和描述，你可以参考响应状态码了解可能的原因。
响应 Body
countinteger本次返回的智能体数量。
满足条件的智能体列表。
start_tsinteger智能体创建时间戳。
statusstring智能体运行状态：
IDLE(0)：空闲状态的智能体。STARTING(1)：正在启动的智能体。RUNNING(2)：正在运行的智能体。STOPPING(3)：正在停止的智能体。STOPPED(4)：已完成退出的智能体。FAILED(6)：执行失败的智能体。
agent_idstring智能体唯一标识。
返回列表的元信息。
cursorstring分页游标。
totalinteger满足本次查询条件的智能体总数量。
statusstring请求状态。
请求示例
curl --request GET \
--url "https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/:appid/agents" \
--header 'Authorization: agora token="007abcxxxxxxx123"'响应示例
{
"data": {
"count": 1,
"list": [
{
"start_ts": 1735035893,
"status": "RUNNING",
"agent_id": "1NT29X11GQSxxxxx80BEIN56XF"
}
]
},
"meta": {
"cursor": "",
"total": 1
},
"status": "ok"
}