Chat Messages

get

Retrieves multiple chat messages.

Query parameters

chatIdstring · uuidRequired

A UUID v4 string that identifies an entity.

chatThreadIdstring · uuidOptional

A UUID v4 string that identifies an entity.

joinsany ofOptionalDefault: []

or

string · enumOptionalPossible values:

ticketIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses

200

Retrieves all chat messages for the specified chat.

application/json

or

or

or

401

Unauthorized.

application/json

404

Chat not found.

application/json

get

/api/v1/chat-messages

HTTPcURLJavaScriptPython

GET /api/v1/chat-messages?chatId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "createdAt": "2026-06-11T20:43:07.698Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2026-06-11T20:43:07.698Z",
    "chatId": "123e4567-e89b-12d3-a456-426614174000",
    "chatThreadId": "123e4567-e89b-12d3-a456-426614174000",
    "content": "text",
    "detail": {
      "attachments": [
        {
          "file": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "description": "text",
          "extension": "png",
          "name": "text"
        }
      ],
      "delivery": [
        {
          "content": {
            "attachmentsIds": [
              "123e4567-e89b-12d3-a456-426614174000"
            ],
            "text": "text"
          },
          "provider": "waha",
          "timestamp": "2026-06-11T20:43:07.698Z",
          "externalId": "text",
          "status": "sent"
        }
      ]
    },
    "externalId": "text",
    "rawContent": "text",
    "role": "user",
    "senderId": "123e4567-e89b-12d3-a456-426614174000",
    "chatMessageFollowUp": {
      "createdAt": "2026-06-11T20:43:07.698Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2026-06-11T20:43:07.698Z",
      "chatId": "123e4567-e89b-12d3-a456-426614174000",
      "chatMessageId": "123e4567-e89b-12d3-a456-426614174000",
      "dueDate": "2026-06-11T20:43:07.698Z",
      "finishedAt": "2026-06-11T20:43:07.698Z",
      "message": "text",
      "reason": "text",
      "status": "pending",
      "triggerChatMessageId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "senderSuperIdentity": {
      "createdAt": "2026-06-11T20:43:07.698Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2026-06-11T20:43:07.698Z",
      "entity": "agents",
      "sender": {
        "createdAt": "2026-06-11T20:43:07.698Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-06-11T20:43:07.698Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "codeRuntime": true,
        "internalName": "text",
        "iterations": 1,
        "llm": "claude-haiku-4-5",
        "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "picture": "text",
        "planning": true,
        "prompt": "text",
        "reasoningMode": "low",
        "role": "text",
        "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
        "temperature": 1,
        "timezone": "Africa/Cairo",
        "toolCount": 1,
        "voiceId": "123e4567-e89b-12d3-a456-426614174000",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  }
]

post

Creates a new chat message.

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body

application/json

chatIdstring · uuidRequired

The chat ID associated with the message.

chatThreadIdstring · uuid · nullableRequired

The id of the chat thread that the message belongs to.

contentstring · max: 4000Required

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

senderIdstring · uuidRequired

A UUID v4 string that identifies an entity.

rolestring · enumRequired

The role allowed when creating the chat message.

Possible values:

Responses

200

The chat message was created.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

chatIdstring · uuidRequired

The chat ID associated with the message.

chatThreadIdstring · uuid · nullableRequired

The id of the chat thread that the message belongs to.

contentstring · max: 100000Required

The content of the message.

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

rawContentstring · max: 100000 · nullableRequired

The raw content of the message as it was generated by the assistant.

rolestring · enumRequired

The role of the actor that produced the message.

Possible values:

senderIdstring · uuid · nullableRequired

The super identity ID of the sender (agents, squads, users or external users) of the message.

400

Invalid data provided.

application/json

403

You are not authorized to create the chat message.

application/json

404

Chat not found.

application/json

post

/api/v1/chat-messages

HTTPcURLJavaScriptPython

POST /api/v1/chat-messages HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "chatThreadId": "123e4567-e89b-12d3-a456-426614174000",
  "content": "text",
  "externalId": "text",
  "senderId": "123e4567-e89b-12d3-a456-426614174000",
  "detail": {
    "attachments": [
      {
        "file": "text",
        "extension": "png",
        "name": "text"
      }
    ]
  },
  "role": "user"
}

{
  "createdAt": "2026-06-11T20:43:07.698Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:43:07.698Z",
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "chatThreadId": "123e4567-e89b-12d3-a456-426614174000",
  "content": "text",
  "detail": {
    "attachments": [
      {
        "file": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "extension": "png",
        "name": "text"
      }
    ],
    "delivery": [
      {
        "content": {
          "attachmentsIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "text": "text"
        },
        "provider": "waha",
        "timestamp": "2026-06-11T20:43:07.698Z",
        "externalId": "text",
        "status": "sent"
      }
    ]
  },
  "externalId": "text",
  "rawContent": "text",
  "role": "user",
  "senderId": "123e4567-e89b-12d3-a456-426614174000"
}

post

Exports chat messages for a given period.

Header parameters

authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body

application/json

rangeEndstring · date-time · nullableOptional

The end date of the export period. Defaults to current date.

rangeStartstring · date-time · nullableRequired

The start date of the export period.

callbackUrlstring · uriRequired

A safe callback URL that must be HTTPS and point to a public server.

languagestring · enumOptionalDefault: enUsPossible values:

Responses

200

Export started. A POST will be made to callbackUrl when ready.

application/json

messagestringRequired

412

The export period exceeds the maximum of 6 months.

application/json

post

/api/v1/chat-messages/export

HTTPcURLJavaScriptPython

POST /api/v1/chat-messages/export HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "rangeEnd": "2026-06-11T20:43:07.698Z",
  "rangeStart": "2026-06-11T20:43:07.698Z",
  "callbackUrl": "https://example.com",
  "language": "enUs"
}

{
  "message": "text"
}