Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Get a Conversation
Gets a conversation by its sessionId.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/conversations/{sessionId} \
--header 'X-API-Key: <api-key>'{
"items": [
{
"projectId": "<string>",
"projectName": "<string>",
"inputId": "<string>",
"sessionId": "<string>",
"contactId": "<string>",
"organisation": "<string>",
"inputText": "<string>",
"inputData": {},
"type": "user",
"source": "user",
"flowName": "<string>",
"flowReferenceId": "<string>",
"channel": "webchat3",
"timestamp": {},
"inHandoverRequest": true,
"inHandoverConversation": true,
"outputId": "<string>",
"expiresAt": {},
"endpointUrlToken": "<string>",
"endpointName": "<string>",
"localeReferenceId": "<string>",
"localeName": "<string>",
"snapshotId": "<string>",
"snapshotName": "<string>",
"rating": 123,
"ratingComment": "<string>"
}
],
"total": 123
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The Id of the Session
Query Parameters
24^[a-z0-9]{24}$expertMode on or off e.g. expertMode=true
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/conversations/{sessionId} \
--header 'X-API-Key: <api-key>'{
"items": [
{
"projectId": "<string>",
"projectName": "<string>",
"inputId": "<string>",
"sessionId": "<string>",
"contactId": "<string>",
"organisation": "<string>",
"inputText": "<string>",
"inputData": {},
"type": "user",
"source": "user",
"flowName": "<string>",
"flowReferenceId": "<string>",
"channel": "webchat3",
"timestamp": {},
"inHandoverRequest": true,
"inHandoverConversation": true,
"outputId": "<string>",
"expiresAt": {},
"endpointUrlToken": "<string>",
"endpointName": "<string>",
"localeReferenceId": "<string>",
"localeName": "<string>",
"snapshotId": "<string>",
"snapshotName": "<string>",
"rating": 123,
"ratingComment": "<string>"
}
],
"total": 123
}