获取任务列表
更新时间不可用
获取符合指定条件的实时转录翻译任务列表。
GET
https://api.agora.io/api/speech-to-text/v1/projects/{appid}/agents鉴权
appidstring必填
你的项目的 App ID，可在声网控制台获取。
channelstring查询指定频道名下的任务列表。
from_timeinteger查询列表开始时间戳（秒），默认为 1 天前。
to_timeinteger查询列表结束时间戳（秒），默认为当前时刻。
statestring指定需要查询任务的状态，单次查询不支持指定多种状态：
STARTING(1)：正在启动的任务。RUNNING(2)：正在运行的任务。STOPPING(3)：正在停止的任务。STOPPED(4)：已完成退出的任务。RECOVERING(5)：正在恢复的任务。FAILED(6)：执行失败的任务。
limitinteger分页获取单次返回的最大条数。
cursorstring分页游标，即分页起始位置的 agent_id。
响应
如果返回的状态码为 200，表示请求成功。
响应 Body
countinteger本次返回的任务数量。
满足条件的任务列表。
start_tsinteger任务创建时间戳。
statusstring任务状态：
STARTING：任务开始启动。RUNNING：任务进行中。STOPPING：任务退出中。STOPPED：任务退出成功。RECOVERING：任务恢复中。FAILED：任务退出失败。
agent_idstring任务 ID。
返回列表的元信息。
cursorstring分页游标。
totalinteger满足本次查询条件的任务总数量。
statusstring请求状态。
请求示例
curl --request GET \
--url "https://api.agora.io/api/speech-to-text/v1/projects/:appid/agents" \
--header 'Authorization: Basic <credentials>'响应示例
{
"data": {
"count": 1,
"list": [
{
"start_ts": 1735035893,
"status": "RUNNING",
"agent_id": "1NT29X11GQSxxxxx80BEIN56XF"
}
]
},
"meta": {
"cursor": "",
"total": 1
},
"status": "ok"
}