Search OpenAiChatMessages

GET

api

sys

openaichatmessages

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/openaichatmessages \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/openaichatmessages"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/openaichatmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

An OpenAiChatMessage is a single turn in an AI conversation — what the contact said, what the AI answered, a tool the AI ran, or a message an operator pushed into the thread. Messages belong to an AiChannelSession and share its ChatSession GUID, so filtering by conversation and ordering by creation time reproduces the transcript. This entity is read-only: turns are written by the AI pipeline as the conversation happens and are never edited afterwards.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the OpenAiChatMessage-List role.

Enums

eOpenAiChatMessageType — Action values

Value	Name
1	Operator

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location that owns this message, inherited from its conversation..

integer

Filter by iD of the platform user this message is attributed to. Set for messages exchanged inside an authenticated session; empty for anonymous web-chat and inbound email or WhatsApp contacts..

integer

Filter by iD of the conversation this message belongs to. Filter on it to read one conversation’s transcript in order..

string

Filter by display value for AiChannelSession.ExternalIdentifier..

integer

Filter by display value for AiChannelSession.Coworker.Id..

string

Filter by display value for AiChannelSession.Coworker.CoworkerType..

string

Filter by display value for AiChannelSession.Coworker.FullName..

string

Filter by display value for AiChannelSession.Coworker.MobilePhone..

string

Filter by display value for AiChannelSession.Coworker.LandLine..

string

Filter by display value for AiChannelSession.Coworker.BillingName..

string

Filter by display value for AiChannelSession.Coworker.CompanyName..

string

Filter by display value for AiChannelSession.Coworker.TeamNames..

integer

Filter by what this message was, beyond its role: Operator for ordinary AI or operator turns; OutboundCoworkerMessage and OutboundHelpDesk for AI replies delivered as a customer message or a help desk ticket; InboundCoworkerReply and InboundHelpDeskReply for the customer answering through those channels. Use it with the CoworkerMessage, HelpDeskMessage and HelpDeskComment links to show where a turn actually happened..

string

Filter by message body. User and assistant turns hold the text shown to people, in Markdown or HTML depending on channel; Tool turns hold a serialised tool result, and the assistant turn that requests tools holds a JSON array of tool calls rather than prose..

string

Filter by gUID of the conversation, matching AiChannelSession.ChatSession. Identical for every message in the same conversation..

string

Filter by which internal responder produced the message, such as CompleteWithTools, KbOpenAiResponder or ProactiveExecutionEngine. Useful for tracing why the AI answered the way it did; empty for messages that came from a person..

string

Filter by conversation role: User for the contact, Assistant for the AI, Tool for a tool result, System for prompt scaffolding, and operator-outbound for a message an operator sent into the thread. A transcript normally shows only User, Assistant and operator-outbound..

integer

Filter by feedback the recipient left on this answer through the members portal. Empty when nobody rated it..

string

Filter by channel this turn travelled on, stored as text and matching its conversation: Chat, Email, WhatsApp, Voice, CoworkerMessage or HelpDesk..

integer

Filter by iD of the customer message this turn was delivered as or came from, when the AI replied over the CoworkerMessage channel..

integer

Filter by iD of the help desk ticket this turn created or belongs to, set when the conversation was escalated to the help desk..

integer

Filter by iD of the help desk comment this turn came from, set when the customer or an operator replied on the escalated ticket..

Range Filters

integer

Filter by display value for AiChannelSession.Coworker.Id. greater than or equal to this value.

integer

Filter by display value for AiChannelSession.Coworker.Id. less than or equal to this value.

integer

Filter by feedback the recipient left on this answer through the members portal. Empty when nobody rated it. greater than or equal to this value.

integer

Filter by feedback the recipient left on this answer through the members portal. Empty when nobody rated it. less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/openaichatmessages?page=1&size=15&orderBy=Content&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/openaichatmessages?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Content',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/openaichatmessages',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Content',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Content

curl -X GET \
  "https://spaces.nexudus.com/api/sys/openaichatmessages?OpenAiChatMessage_Content=example-value&orderBy=Content&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/openaichatmessages?' + new URLSearchParams({
    OpenAiChatMessage_Content: 'example-value',
    orderBy: 'Content',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/openaichatmessages',
    params={
        'OpenAiChatMessage_Content': 'example-value',
        'orderBy': 'Content',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/openaichatmessages?from_OpenAiChatMessage_UpdatedOn=2025-01-01T00:00&to_OpenAiChatMessage_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/openaichatmessages?' + new URLSearchParams({
    from_OpenAiChatMessage_UpdatedOn: '2025-01-01T00:00',
    to_OpenAiChatMessage_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/openaichatmessages',
    params={
        'from_OpenAiChatMessage_UpdatedOn': '2025-01-01T00:00',
        'to_OpenAiChatMessage_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

OpenAiChatMessage[]

The list of OpenAiChatMessage records matching the query. See the Get one OpenAiChatMessage endpoint for the full list of properties returned for each record.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "UserId": null,
      "AiChannelSessionId": null,
      "AiChannelSessionExternalIdentifier": null,
      "AiChannelSessionCoworkerId": null,
      "AiChannelSessionCoworkerCoworkerType": null,
      "AiChannelSessionCoworkerFullName": null,
      "AiChannelSessionCoworkerMobilePhone": null,
      "AiChannelSessionCoworkerLandLine": null,
      "AiChannelSessionCoworkerBillingName": null,
      "AiChannelSessionCoworkerCompanyName": null,
      "AiChannelSessionCoworkerTeamNames": null,
      "Action": 0,
      "Content": "",
      "ChatSession": null,
      "ResponderName": null,
      "ChatMessageRole": null,
      "Rating": null,
      "Channel": null,
      "CoworkerMessageId": null,
      "HelpDeskMessageId": null,
      "HelpDeskCommentId": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "OpenAiChatMessage Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Content",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search OpenAiChatMessages

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/openaichatmessages \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/openaichatmessages"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/openaichatmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Content

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Content

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Content

Range filters

Response

200