Retrieve agent history
Updated
Retrieves conversation history for a running Conversational AI agent.
https://api.agora.io/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/historyCall this endpoint while the agent is running to retrieve the conversation history between the user and the Conversational AI agent.
Path Parameters
The App ID of the project.
The agent instance ID you obtained after successfully calling join to Start a conversational AI agent.
Response
-
If the returned status code is
200, the request was successful. The response body contains the result of the request. -
If the returned status code is not
200, the request failed. The response body includes the error code and description. Refer to status codes to understand the possible reasons for failure.
Response Body
application/json
application/json
Response schema
200The request was successful. The response body contains the result of the request.
Unique identifier of the agent.
Agent creation timestamp.
Agent status. Only supports querying the running agent.
Agent history.
Message content.
Unix timestamp in milliseconds indicating when the user started speaking or the agent started TTS playback. Only returned when llm.vendor is custom.
Unix timestamp in milliseconds indicating when the user stopped speaking, or when TTS playback completed or was interrupted. Only returned when llm.vendor is custom.
The total delay in milliseconds introduced by audio processing algorithms, including noise reduction, background voice suppression, and voiceprint locking, after audio is captured from the user's microphone. Use this value to align timestamps with cloud recording audio.
Only returned when:
llm.vendoriscustomcontents[].roleisuser- Actual voice input is present
Request examples
curl --request get \
--url https://api.agora.io/api/conversational-ai-agent/v2/projects/:appid/agents/:agentId/history \
--header 'Authorization: Basic <credentials>'
Response example
{ "agent_id": "xxxx", "start_ts": 123, "status": "RUNNING", "contents": [ { "role": "user", "content": "hello." }, { "role": "assistant", "content": "hi, how can I help you?" } ]}