limitinteger
Max number of conversations to return
Default:50
>= 1
offsetinteger
Number of conversations to skip
Default:0
>= 0
List conversations for a project
get
https://api.dev.poly.ai/v1/agents/{agentId}/conversations
Query Parameters
Path Parameters
agentIdstringrequired
Response
application/json
Response
application/json
Successful response
GetConversationsResponse
A page of conversations matching the query, plus total count and
limit/offset pagination.
conversationsarray[object]required
Public-facing conversation summary (used in list endpoint).
Show Child Parameters
countintegerrequired
limitintegerrequired
offsetintegerrequired
get/v1/agents/{agentId}/conversations
Authentication
Path Parameters
Query Parameters
application/json
Get a conversation by ID
get
https://api.dev.poly.ai/v1/agents/{agentId}/conversations/{conversationId}
Path Parameters
agentIdstringrequired
conversationIdstringrequired
Response
application/json
Response
application/json
Successful response
ConversationDetailResponse
Public-facing conversation detail (includes turns, metrics).
conversationIdstringrequired
accountIdstringrequired
projectIdstringrequired
createdAtstring
startedAtstring
finishedAtstring
channelstring
fromNumberstring
toNumberstring
languagestring
variantIdstring
clientEnvstring
totalDurationinteger
polyaiDurationinteger
durationinteger
inProgressboolean
handoffboolean
handoffDestinationstring
handoffReasonstring
directionstring
tagsarray[string]
polyScorenumber
shortSummarystring
deploymentIdstring
notestring
audioUrlstring
turnsarray[object]
metricsobject
functionEventsobject
get/v1/agents/{agentId}/conversations/{conversationId}
Authentication
Path Parameters
application/json
Add annotations to a conversation
post
https://api.dev.poly.ai/v1/agents/{agentId}/conversations/{conversationId}/annotation
Path Parameters
agentIdstringrequired
conversationIdstringrequired
Body
application/json
Body
application/json
AddAnnotationsBody
Request body for adding annotations to a conversation.
annotationsarray[object]required
>= 1 items
Response
application/json
Response
application/json
Successful response
OperationSuccessResponse
Minimal success payload for mutation endpoints.
successboolean
Default:true
post/v1/agents/{agentId}/conversations/{conversationId}/annotation
Authentication
Path Parameters
Body
{
"annotations": [
{}
]
}
application/json
Get audio recording for a conversation
get
https://api.dev.poly.ai/v1/agents/{agentId}/conversations/{conversationId}/audio
Query Parameters
directionstring
Audio direction: “combined”, “user”, or “agent”
Allowed values:combineduseragent
Default:combined
redactedboolean
Whether to return redacted audio
Default:false
Path Parameters
agentIdstringrequired
conversationIdstringrequired
Response
audio/wav
Response
audio/wav
Successful response
string(binary)
get/v1/agents/{agentId}/conversations/{conversationId}/audio
Authentication
Path Parameters
Query Parameters
audio/wav
Upsert a note on a conversation
post
https://api.dev.poly.ai/v1/agents/{agentId}/conversations/{conversationId}/note
Path Parameters
agentIdstringrequired
conversationIdstringrequired
Body
application/json
Body
application/json
UpsertNoteBody
Request body for upserting a note on a conversation.
notestringrequired
Response
application/json
Response
application/json
Successful response
OperationSuccessResponse
Minimal success payload for mutation endpoints.
successboolean
Default:true
post/v1/agents/{agentId}/conversations/{conversationId}/note
Authentication
Path Parameters
Body
{
"note": "note"
}
application/json