Query the task status
Updated
Queries the status of a Real-time STT task.
get
https://api.agora.io/api/speech-to-text/v1/projects/{appid}/agents/{agentId}Use this method to query the status of a Real-time STT task.
Path Parameters
Response
- If the returned status code is
200, the request was successful. The response body contains the result of the request.
Response Body
application/json
application/json
Response schema
200application/jsonOK
Details of the request result
The ID of the agent.
The Unix timestamp (in seconds) when the transcription task was created.
The current status of the agent:
IDLE: The agent is not initializedSTARTING: The agent is startingRUNNING: The agent is runningSTOPPING: The agent is exitingSTOPPED: The agent exited successfullyRECOVERING: The agent is recoveringFAILED: Agent exit failed
Allowed
IDLE | STARTING | RUNNING | STOPPING | STOPPED | RECOVERING | FAILEDdefaultapplication/jsonError response.
Details of the failed request.
The ID of the agent.
The Unix timestamp (in seconds) when the transcription task was created.
The status of the agent. If the returned status code is not 200, the request failed. Troubleshoot according to the details and reason fields.
Allowed
FAILEDResponse
Refer to message and code fields to understand the possible reasons for failure.
Request examples
curl --request GET \ --url https://api.agora.io/api/speech-to-text/v1/projects/:appid/agents/:agentId \ --header 'Authorization: Basic <credentials>'Response example
{ "message": "Details of the request result.", "agent_id": "Agent ID.", "create_ts": null, "status": "RUNNING"}{ "message": "Details of the failed request.", "agent_id": "Agent ID.", "create_ts": null, "status": "FAILED"}