GET
/
api
/
v1
/
agents
/
{agentId}
/
conversations

Retrieve all information about an agent’s conversations.

Response Headers for Pagination

Header NameTypeDescription
X-Page-SizeintegerThe number of items per page.
X-Start-AfterstringThe ID of the last item on the previous page.
X-Next-Start-AfterstringThe ID of the last item on the current page.
X-Total-CountintegerThe total number of items.

These headers are included in the response to help manage pagination when retrieving conversations for a specific agent.

Authorizations

AUTHORIZATION
string
headerrequired

API key required for this endpoint. Use Bearer YOUR_SECRET_API_KEY. Get your key from https://play.ai/developers.

X-USER-ID
string
headerrequired

User ID required for this endpoint. Get it from https://play.ai/developers.

Headers

accept
enum<string>
Available options:
application/json

Path Parameters

agentId
string
required

The agent's ID.

Query Parameters

pageSize
integer
default: 50

The number of items to return per page.

startAfter
string

The conversation ID to start after.

Response

200 - application/json
id
string
source
string
callerEmail
string
startedAt
string
endedAt
string
durationInSeconds
integer