查询智能体状态
更新时间不可用
查询指定智能体实例的当前运行状态。
GET
https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}appidstring必填
你的项目使用的 App ID。
agentIdstring必填
智能体实例 ID,即智能体的唯一标识。调用 POST 创建对话式智能体 成功后在响应包体中获取。
Authorizationstring必填
发送 HTTP 请求时,你可以从以下鉴权方式中任选其一:
- 使用 Token 认证(推荐):参考实现 HTTP 鉴权生成 Token 并填入
AuthorizationHeader。传参示例:Authorization: agora token="007abcxxxxxxx123"。 - 使用 Basic Auth:参考实现 HTTP 鉴权生成 Base64 编码的
Authorization字段。传参示例:Authorization: Basic NDI1OTQ3N2I4MzYy...YwZjA=。
响应
- 若返回的状态码为
200则表示请求成功。响应包体中包含本次请求的结果。 - 若返回的状态码不为
200则表示请求失败。响应包体中包含错误的类别和描述,你可以参考响应状态码了解可能的原因。
响应 Body
messagestring请求信息。
start_tsinteger智能体创建时间戳。
stop_tsinteger智能体停止时间戳。
statusstring智能体运行状态:
IDLE(0):空闲状态的智能体。STARTING(1):正在启动的智能体。RUNNING(2):正在运行的智能体。STOPPING(3):正在停止的智能体。STOPPED(4):已完成退出的智能体。FAILED(6):执行失败的智能体。
namestring智能体名称,即调用创建接口时传入的 name。同一频道内唯一。
agent_idstring智能体唯一标识。
请求示例
curl --request GET \
--url "https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/:appid/agents/:agentId" \
--header 'Authorization: agora token="007abcxxxxxxx123"'响应示例
{
"message": "agent exits with reason: xxxx",
"start_ts": 1735035893,
"stop_ts": 1735035900,
"status": "FAILED",
"name": "support_agent_001",
"agent_id": "1NT29X11GQSxxxxxNU80BEIN56XF"
}