Skip to main content
GET
/
api
/
v1
/
agents
/
{agentId}
/
conversations
/
{conversationId}
cURL
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": "test@gmail.com",
  "startedAt": "2024-06-04T15:13:53.687Z",
  "endedAt": "2024-06-04T15:18:54.687Z",
  "durationInSeconds": 301
}

Documentation Index

Fetch the complete documentation index at: https://docs.play.ai/llms.txt

Use this file to discover all available pages before exploring further.

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. The unique ID for each agent.

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
Example:

"test@gmail.com"

​
startedAt
string<date-time>
Example:

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

​
endedAt
string<date-time>
Example:

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

​
durationInSeconds
integer
Example:

301