GET
/
api
/
v1
/
agents
/
{agentId}
/
conversations
/
{conversationId}
curl --request GET \
  --url https://api.play.ai/api/v1/agents/{agentId}/conversations/{conversationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-USER-ID: <api-key>'
{
  "id": "tIKQo8GMvOZyGx0Wm2RT",
  "source": "web",
  "callerEmail": "[email protected]",
  "startedAt": "2024-06-04T15:13:53.687Z",
  "endedAt": "2024-06-04T15:18:54.687Z",
  "durationInSeconds": 301
}

Authorizations

Authorization
string
header
required

Your secret API key from PlayAI, formatted as Bearer YOUR_SECRET_API_KEY.

X-USER-ID
string
header
required

Your unique user ID from PlayAI.

Headers

accept
enum<string>
Available options:
application/json

Path Parameters

agentId
string
required

The agent's ID.

Example:

"f0gZrOKBKL7veJ6o1M"

conversationId
string
required

The conversation's ID.

Response

200 - application/json
Conversation retrieved.
id
string
Example:

"tIKQo8GMvOZyGx0Wm2RT"

source
string
Example:

"web"

callerEmail
string
startedAt
string
Example:

"2024-06-04T15:13:53.687Z"

endedAt
string
Example:

"2024-06-04T15:18:54.687Z"

durationInSeconds
integer
Example:

301