Messages

Get all messages for an assistant.

get

Returns a paged, optionally searched and sorted, list of messages for the specified assistant conversation.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

assistantIdentifierstring · uuidRequired

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

compactionAcknowledgedboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

messageResponseTypeIdinteger · int32 · nullableOptional

isAssistantbooleanRequired

resourceOwnerIdstring · nullableOptional

isStreamingbooleanOptional

webSearchEnabledboolean · nullableOptional

401

Unauthorized

403

Forbidden

get/projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages

GET /projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "text": "text",
    "messageDocumentIdentifiers": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "flowObjectIdentifiers": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stream": true,
    "messageType": "standard",
    "thinkingEffort": "text",
    "compactionEnabled": true,
    "compactionAcknowledged": true,
    "tools": [
      "text"
    ],
    "agentMode": true,
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "messageResponseTypeId": 1,
    "assistant": {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "documents": [
        {
          "name": "text",
          "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "isDirectory": true,
          "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "contentType": "text",
          "size": 1,
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "dateAdded": "2026-01-01T00:00:00.000Z",
          "uploadSuccessful": true,
          "tokenCount": 1,
          "metadataTokenCount": 1,
          "indexingNotPossible": true,
          "unsupportedFileType": true,
          "unPackingComplete": true,
          "unPackingFailed": true,
          "uploadInProgress": true,
          "url": "text",
          "hasChildren": true,
          "isSystemFolder": true,
          "extension": "text",
          "convertedToPdf": true,
          "fileType": "unknown",
          "uploadFailedReason": "outOfMemory",
          "resourceOwner": {
            "email": "text",
            "name": "text",
            "id": "text"
          },
          "progress": 1,
          "path": "text",
          "parent": {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "isDirectory": true
          },
          "ocrStrategy": "never",
          "ocrEngine": "azureDocumentIntelligence",
          "coordinateExtractionStrategy": "never",
          "documentUploadSource": "local",
          "pageCount": 1,
          "ocrCreditsCost": 1,
          "layoutCreditsCost": 1,
          "metadata": [
            {
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "key": "text",
              "value": "text"
            }
          ]
        }
      ],
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "documentMetadata": [
        {
          "paragraphs": [
            {
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "content": "text",
              "boundingRegions": [
                {
                  "points": [
                    1
                  ],
                  "page": 1
                }
              ],
              "role": "title"
            }
          ],
          "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "documentType": "standard",
          "comparedDocumentObjectIdentifiers": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "estimatedTokenCount": 1,
      "lastContextTokens": 1,
      "lastContextModelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "compactionEnabled": true,
      "assistantMessageCount": 1,
      "userMessageCount": 1,
      "totalCount": 1,
      "credits": 1,
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      }
    },
    "isAssistant": true,
    "messageCitations": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "quote": "text",
        "messageObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "flowObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "promptAnswerObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "cellObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "paragraphPageNumber": 1,
        "paragraphBoundingRegions": [
          1
        ],
        "sheetIndex": 1,
        "cellRowIndex": 1,
        "cellColumnIndex": 1,
        "type": "cell",
        "endIndex": 1,
        "startIndex": 1,
        "title": "text",
        "url": "text",
        "prompt": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    ],
    "documents": [
      {
        "name": "text",
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "isDirectory": true,
        "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "contentType": "text",
        "size": 1,
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "dateAdded": "2026-01-01T00:00:00.000Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "indexingNotPossible": true,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": true,
        "isSystemFolder": true,
        "extension": "text",
        "convertedToPdf": true,
        "fileType": "unknown",
        "uploadFailedReason": "outOfMemory",
        "resourceOwner": {
          "email": "text",
          "name": "text",
          "id": "text"
        },
        "progress": 1,
        "path": "text",
        "parent": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "isDirectory": true
        },
        "ocrStrategy": "never",
        "ocrEngine": "azureDocumentIntelligence",
        "coordinateExtractionStrategy": "never",
        "documentUploadSource": "local",
        "pageCount": 1,
        "ocrCreditsCost": 1,
        "layoutCreditsCost": 1,
        "metadata": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "key": "text",
            "value": "text"
          }
        ]
      }
    ],
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    },
    "resourceOwnerId": "text",
    "isStreaming": true,
    "contentBlocks": [
      {
        "id": "text",
        "origin": "openAI"
      }
    ],
    "sessionFiles": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "toolCallId": "text"
      }
    ],
    "webSearchEnabled": true
  }
]

Create a new message in an assistant.

post

Sends a user message to an assistant and returns the assistant's reply, either as a single JSON payload or as a text/event-stream when streaming is requested.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

assistantIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

compactionAcknowledgedboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

Responses

200

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

compactionAcknowledgedboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

messageResponseTypeIdinteger · int32 · nullableOptional

isAssistantbooleanRequired

resourceOwnerIdstring · nullableOptional

isStreamingbooleanOptional

webSearchEnabledboolean · nullableOptional

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages

POST /projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 359

{
  "text": "text",
  "messageDocumentIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "flowObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true,
  "messageType": "standard",
  "thinkingEffort": "text",
  "compactionEnabled": true,
  "compactionAcknowledged": true,
  "tools": [
    "text"
  ],
  "agentMode": true
}

{
  "text": "text",
  "messageDocumentIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "flowObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true,
  "messageType": "standard",
  "thinkingEffort": "text",
  "compactionEnabled": true,
  "compactionAcknowledged": true,
  "tools": [
    "text"
  ],
  "agentMode": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "messageResponseTypeId": 1,
  "assistant": {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "documents": [
      {
        "name": "text",
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "isDirectory": true,
        "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "contentType": "text",
        "size": 1,
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "dateAdded": "2026-01-01T00:00:00.000Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "indexingNotPossible": true,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": true,
        "isSystemFolder": true,
        "extension": "text",
        "convertedToPdf": true,
        "fileType": "unknown",
        "uploadFailedReason": "outOfMemory",
        "resourceOwner": {
          "email": "text",
          "name": "text",
          "id": "text"
        },
        "progress": 1,
        "path": "text",
        "parent": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "isDirectory": true
        },
        "ocrStrategy": "never",
        "ocrEngine": "azureDocumentIntelligence",
        "coordinateExtractionStrategy": "never",
        "documentUploadSource": "local",
        "pageCount": 1,
        "ocrCreditsCost": 1,
        "layoutCreditsCost": 1,
        "metadata": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "key": "text",
            "value": "text"
          }
        ]
      }
    ],
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "documentMetadata": [
      {
        "paragraphs": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "content": "text",
            "boundingRegions": [
              {
                "points": [
                  1
                ],
                "page": 1
              }
            ],
            "role": "title"
          }
        ],
        "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "documentType": "standard",
        "comparedDocumentObjectIdentifiers": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "estimatedTokenCount": 1,
    "lastContextTokens": 1,
    "lastContextModelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "compactionEnabled": true,
    "assistantMessageCount": 1,
    "userMessageCount": 1,
    "totalCount": 1,
    "credits": 1,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    }
  },
  "isAssistant": true,
  "messageCitations": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "quote": "text",
      "messageObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "flowObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptAnswerObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "cellObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "paragraphPageNumber": 1,
      "paragraphBoundingRegions": [
        1
      ],
      "sheetIndex": 1,
      "cellRowIndex": 1,
      "cellColumnIndex": 1,
      "type": "cell",
      "endIndex": 1,
      "startIndex": 1,
      "title": "text",
      "url": "text",
      "prompt": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "documents": [
    {
      "name": "text",
      "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isDirectory": true,
      "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "contentType": "text",
      "size": 1,
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "indexingNotPossible": true,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": true,
      "isSystemFolder": true,
      "extension": "text",
      "convertedToPdf": true,
      "fileType": "unknown",
      "uploadFailedReason": "outOfMemory",
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      },
      "progress": 1,
      "path": "text",
      "parent": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "isDirectory": true
      },
      "ocrStrategy": "never",
      "ocrEngine": "azureDocumentIntelligence",
      "coordinateExtractionStrategy": "never",
      "documentUploadSource": "local",
      "pageCount": 1,
      "ocrCreditsCost": 1,
      "layoutCreditsCost": 1,
      "metadata": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "resourceOwnerId": "text",
  "isStreaming": true,
  "contentBlocks": [
    {
      "id": "text",
      "origin": "openAI"
    }
  ],
  "sessionFiles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "toolCallId": "text"
    }
  ],
  "webSearchEnabled": true
}

Continue an assistant conversation in a new chat.

post

Summarizes the current conversation and creates a new chat seeded with that summary, carrying document references and linking back to the original.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

assistantIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

modelIdentifierstring · uuidOptional

Responses

200

newChatObjectIdentifierstring · uuidOptional

summarystring · nullableOptional

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/handoff

POST /projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/handoff HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "newChatObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "summary": "text"
}

Get a message by object identifier.

get

Returns the details of a single message identified by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

assistantIdentifierstringRequired

Responses

200

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

compactionAcknowledgedboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

messageResponseTypeIdinteger · int32 · nullableOptional

isAssistantbooleanRequired

resourceOwnerIdstring · nullableOptional

isStreamingbooleanOptional

webSearchEnabledboolean · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

get/projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/{objectIdentifier}

GET /projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "text": "text",
  "messageDocumentIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "flowObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true,
  "messageType": "standard",
  "thinkingEffort": "text",
  "compactionEnabled": true,
  "compactionAcknowledged": true,
  "tools": [
    "text"
  ],
  "agentMode": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "messageResponseTypeId": 1,
  "assistant": {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "documents": [
      {
        "name": "text",
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "isDirectory": true,
        "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "contentType": "text",
        "size": 1,
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "dateAdded": "2026-01-01T00:00:00.000Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "indexingNotPossible": true,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": true,
        "isSystemFolder": true,
        "extension": "text",
        "convertedToPdf": true,
        "fileType": "unknown",
        "uploadFailedReason": "outOfMemory",
        "resourceOwner": {
          "email": "text",
          "name": "text",
          "id": "text"
        },
        "progress": 1,
        "path": "text",
        "parent": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "isDirectory": true
        },
        "ocrStrategy": "never",
        "ocrEngine": "azureDocumentIntelligence",
        "coordinateExtractionStrategy": "never",
        "documentUploadSource": "local",
        "pageCount": 1,
        "ocrCreditsCost": 1,
        "layoutCreditsCost": 1,
        "metadata": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "key": "text",
            "value": "text"
          }
        ]
      }
    ],
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "documentMetadata": [
      {
        "paragraphs": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "content": "text",
            "boundingRegions": [
              {
                "points": [
                  1
                ],
                "page": 1
              }
            ],
            "role": "title"
          }
        ],
        "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "documentType": "standard",
        "comparedDocumentObjectIdentifiers": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "estimatedTokenCount": 1,
    "lastContextTokens": 1,
    "lastContextModelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "compactionEnabled": true,
    "assistantMessageCount": 1,
    "userMessageCount": 1,
    "totalCount": 1,
    "credits": 1,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    }
  },
  "isAssistant": true,
  "messageCitations": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "quote": "text",
      "messageObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "flowObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptAnswerObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "cellObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "paragraphPageNumber": 1,
      "paragraphBoundingRegions": [
        1
      ],
      "sheetIndex": 1,
      "cellRowIndex": 1,
      "cellColumnIndex": 1,
      "type": "cell",
      "endIndex": 1,
      "startIndex": 1,
      "title": "text",
      "url": "text",
      "prompt": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "documents": [
    {
      "name": "text",
      "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isDirectory": true,
      "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "contentType": "text",
      "size": 1,
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "indexingNotPossible": true,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": true,
      "isSystemFolder": true,
      "extension": "text",
      "convertedToPdf": true,
      "fileType": "unknown",
      "uploadFailedReason": "outOfMemory",
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      },
      "progress": 1,
      "path": "text",
      "parent": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "isDirectory": true
      },
      "ocrStrategy": "never",
      "ocrEngine": "azureDocumentIntelligence",
      "coordinateExtractionStrategy": "never",
      "documentUploadSource": "local",
      "pageCount": 1,
      "ocrCreditsCost": 1,
      "layoutCreditsCost": 1,
      "metadata": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "resourceOwnerId": "text",
  "isStreaming": true,
  "contentBlocks": [
    {
      "id": "text",
      "origin": "openAI"
    }
  ],
  "sessionFiles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "toolCallId": "text"
    }
  ],
  "webSearchEnabled": true
}

Update a message by object identifier.

put

Updates the text of an existing message and returns the updated message.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

assistantIdentifierstringRequired

Body

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

compactionAcknowledgedboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

Responses

200

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

compactionAcknowledgedboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

messageResponseTypeIdinteger · int32 · nullableOptional

isAssistantbooleanRequired

resourceOwnerIdstring · nullableOptional

isStreamingbooleanOptional

webSearchEnabledboolean · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

put/projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/{objectIdentifier}

PUT /projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 359

{
  "text": "text",
  "messageDocumentIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "flowObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true,
  "messageType": "standard",
  "thinkingEffort": "text",
  "compactionEnabled": true,
  "compactionAcknowledged": true,
  "tools": [
    "text"
  ],
  "agentMode": true
}

{
  "text": "text",
  "messageDocumentIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "flowObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true,
  "messageType": "standard",
  "thinkingEffort": "text",
  "compactionEnabled": true,
  "compactionAcknowledged": true,
  "tools": [
    "text"
  ],
  "agentMode": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "messageResponseTypeId": 1,
  "assistant": {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "documents": [
      {
        "name": "text",
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "isDirectory": true,
        "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "contentType": "text",
        "size": 1,
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "dateAdded": "2026-01-01T00:00:00.000Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "indexingNotPossible": true,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": true,
        "isSystemFolder": true,
        "extension": "text",
        "convertedToPdf": true,
        "fileType": "unknown",
        "uploadFailedReason": "outOfMemory",
        "resourceOwner": {
          "email": "text",
          "name": "text",
          "id": "text"
        },
        "progress": 1,
        "path": "text",
        "parent": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "isDirectory": true
        },
        "ocrStrategy": "never",
        "ocrEngine": "azureDocumentIntelligence",
        "coordinateExtractionStrategy": "never",
        "documentUploadSource": "local",
        "pageCount": 1,
        "ocrCreditsCost": 1,
        "layoutCreditsCost": 1,
        "metadata": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "key": "text",
            "value": "text"
          }
        ]
      }
    ],
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "documentMetadata": [
      {
        "paragraphs": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "content": "text",
            "boundingRegions": [
              {
                "points": [
                  1
                ],
                "page": 1
              }
            ],
            "role": "title"
          }
        ],
        "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "documentType": "standard",
        "comparedDocumentObjectIdentifiers": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "estimatedTokenCount": 1,
    "lastContextTokens": 1,
    "lastContextModelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "compactionEnabled": true,
    "assistantMessageCount": 1,
    "userMessageCount": 1,
    "totalCount": 1,
    "credits": 1,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    }
  },
  "isAssistant": true,
  "messageCitations": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "quote": "text",
      "messageObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "flowObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptAnswerObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "cellObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "paragraphPageNumber": 1,
      "paragraphBoundingRegions": [
        1
      ],
      "sheetIndex": 1,
      "cellRowIndex": 1,
      "cellColumnIndex": 1,
      "type": "cell",
      "endIndex": 1,
      "startIndex": 1,
      "title": "text",
      "url": "text",
      "prompt": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "documents": [
    {
      "name": "text",
      "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isDirectory": true,
      "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "contentType": "text",
      "size": 1,
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "indexingNotPossible": true,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": true,
      "isSystemFolder": true,
      "extension": "text",
      "convertedToPdf": true,
      "fileType": "unknown",
      "uploadFailedReason": "outOfMemory",
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      },
      "progress": 1,
      "path": "text",
      "parent": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "isDirectory": true
      },
      "ocrStrategy": "never",
      "ocrEngine": "azureDocumentIntelligence",
      "coordinateExtractionStrategy": "never",
      "documentUploadSource": "local",
      "pageCount": 1,
      "ocrCreditsCost": 1,
      "layoutCreditsCost": 1,
      "metadata": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "resourceOwnerId": "text",
  "isStreaming": true,
  "contentBlocks": [
    {
      "id": "text",
      "origin": "openAI"
    }
  ],
  "sessionFiles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "toolCallId": "text"
    }
  ],
  "webSearchEnabled": true
}

Delete a message by object identifier.

delete

Permanently deletes the specified message. Requires container administrator rights.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

assistantIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

403

Forbidden

404

Not Found

delete/projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/{objectIdentifier}

DELETE /projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export a message in the specified format.

post

Exports the specified message as a downloadable file in PDF, Word, Excel, or Outlook email format.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

assistantIdentifierstring · uuidRequired

messageObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Query parameters

formatstringOptionalDefault: pdf

Responses

200

string · binaryOptional

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/{messageObjectIdentifier}/export

POST /projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/{messageObjectIdentifier}/export HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

PreviousFlows NextMetadata

Last updated 3 days ago