Skip to content
OnCoreDocs
Conversations

GEThttps://core-api.heysadie.ai/conversations/{id}

id success data conversationId assistantId assistantName channel customerIdentifier status startedAt closedAt lastInboundAt lastOutboundAt transcript summary messages analysis endedReason cost costBreakdown metadata timestamp version path error code message details field

Get conversation

Try it in the API Explorer

Example request

Terminal
curl "https://core-api.heysadie.ai/conversations/CONVERSATION_ID" \
  -H "Authorization: ApiKey YOUR_API_KEY"

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.

Request

Path parameters

idstringrequired

The resource's UUID.

Responses

200
successbooleanrequired
dataobjectoptional
Show 18 child properties
idstringrequired
conversationIdstring | nullrequired
assistantIdstring | nullrequired
assistantNamestring | nullrequired
channelstring | nullrequired
customerIdentifierstring | nullrequired
statusstring | nullrequired
startedAtstring (date-time) | string (date) | number | nullrequired
closedAtstring (date-time) | string (date) | number | nullrequired
lastInboundAtstring (date-time) | string (date) | number | nulloptional
lastOutboundAtstring (date-time) | string (date) | number | nulloptional
transcriptstring | nulloptional
summarystring | nulloptional
messagesany | nulloptional
analysisany | nulloptional
endedReasonstring | nullrequired
costnumber | nulloptional
costBreakdownany | nulloptional
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
400
successbooleanrequired
errorobjectoptional
Show 3 child properties
codeenumrequired
Allowed values:"VALIDATION_ERROR"
messagestringrequired
detailsobject[]optional
Show 2 item properties
fieldstringrequired
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
401
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"UNAUTHORIZED"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
403
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"FORBIDDEN"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
404
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
500
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional