Inkeep light logo
Chat with usSee it for my content
Analytics apiConversation

Get Conversation

GET
/conversations/{id}
/conversations/{id}

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

The API key for a Web integration

In: header

Authorization
Required
Bearer <token>

The API key for an API integration

In: header

Path Parameters

id
Required
string

curl -X GET "https://api.analytics.inkeep.com/conversations/string" \
  -H "Authorization: Bearer <token>"

Conversation retrieved successfully

{
  "id": "string",
  "externalId": "string",
  "externalUrl": "string",
  "type": "openai",
  "createdAt": "string",
  "updatedAt": "string",
  "projectId": "string",
  "integrationId": "string",
  "properties": {},
  "userProperties": {},
  "tags": [
    "string"
  ],
  "messages": [
    {
      "id": "string",
      "type": "openai",
      "externalId": "string",
      "externalUrl": "string",
      "conversationId": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "role": "system",
      "content": "string",
      "name": "string",
      "links": [
        {
          "label": "string",
          "url": "string",
          "title": "string",
          "description": "string",
          "type": "documentation",
          "breadcrumbs": [
            "string"
          ]
        }
      ],
      "properties": {},
      "userProperties": {},
      "tool_calls": [
        {
          "id": "string",
          "type": "function",
          "function": {
            "name": "string",
            "arguments": "string"
          }
        }
      ]
    }
  ],
  "messagesOpenAIFormat": [
    {
      "role": "system",
      "name": "string",
      "content": "string",
      "tool_calls": [
        {
          "id": "string",
          "type": "function",
          "function": {
            "name": "string",
            "arguments": "string"
          }
        }
      ]
    }
  ]
}

Log ConversationDelete Conversation