Skip to main content
GET
/
v2.0
/
conversations
/
{sessionId}
Get a conversation
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/conversations/{sessionId} \
  --header 'Authorization: Bearer <token>' \
  --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
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
sessionId
string
required

The Id of the Session

Query Parameters

​
projectId
string
Required string length: 24
​
expertMode
boolean

expertMode on or off e.g. expertMode=true

Response

Returns a Conversation.

​
items
object[]
​
total
integer