List agents
Updated
Retrieves the agents saved in your project.
Preview documentation
https://preview.ai.agora.io/conversational-ai/v1/projects/{appid}/agentsappidstringThe App ID of your project.
limitintegerThe maximum number of agents to return on each page.
cursorstringThe next_cursor value from the previous page of results. Omit it to get the first page. The cursor is opaque, so pass it back unchanged.
orderstringThe sort order of the results:
create_ts.desc: Newest first.create_ts.asc: Oldest first.
Response Body
The request was successful. The response body contains a page of agents.
Response Headers
dataobjectcountintegerThe number of agents on this page.
listarray<object>The agents on this page. Retrieve an agent to get its configuration.
agent_idstringThe ID of the agent.
agent_namestringThe name of the agent.
create_tsintegerThe time the agent was created, as a Unix timestamp in seconds.
update_tsintegerThe time the agent was last updated, as a Unix timestamp in seconds.
has_morebooleanWhether more results are available after this page.
next_cursorstring | nullThe cursor for the next page. Pass it in the cursor query parameter of your next request. null on the last page.
Request examples
curl -X GET 'https://preview.ai.agora.io/conversational-ai/v1/projects/string/agents'Response example
{ "data": { "count": 1, "list": [ { "agent_id": "3f6c2a9e-8d1b-4e7a-9c55-0b2f7d1e4a10", "agent_name": "Customer Support Agent", "create_ts": 1786543331, "update_ts": 1787733713 } ] }, "has_more": false, "next_cursor": null}