Inkeep light logo
Schedule a callSee it for my content
Analytics apiConversation

Log Conversation

Logs a new conversation or updates an existing one with new messages. Always include all messages.

API Key Types: WEB, API

POST
/conversations

Authorization

AuthorizationRequiredBearer <token>

The API key for a Web integration

In: header

AuthorizationRequiredBearer <token>

The API key for an API integration

In: header

Request Body

application/jsonRequired

Note: The maximum size of the request body is 2 MB.

bodyRequiredCreateConversation
curl -X POST "https://api.analytics.inkeep.com/conversations" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "externalId": "string",
    "externalUrl": "string",
    "type": "openai",
    "supportTicketConversationId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "projectId": "string",
    "integrationId": "string",
    "properties": {},
    "userProperties": {},
    "tags": [
      "string"
    ],
    "visibility": "private",
    "messages": [
      {
        "id": "string",
        "type": "openai",
        "externalId": "string",
        "externalUrl": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "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"
            }
          }
        ]
      }
    ]
  }'

Conversation upserted successfully

{
  "id": "string",
  "externalId": "string",
  "externalUrl": "string",
  "type": "openai",
  "supportTicketConversationId": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "projectId": "string",
  "integrationId": "string",
  "properties": {},
  "userProperties": {},
  "tags": [
    "string"
  ],
  "visibility": "private",
  "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"
          }
        }
      ]
    }
  ]
}

Add analytics to any OpenAI compatible chatGet Conversation