Flow Chat Messages

Get all messages for a flow chat.

get

Returns a paged, searchable, sortable list of the messages in a flow chat.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

chatIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

OK

text/plainapplication/jsontext/json

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

messageResponseTypeIdinteger · int32 · nullableOptional

isAssistantbooleanRequired

isStreamingbooleanOptional

hasContentBlocksbooleanOptional

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/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,
    "tools": [
      "text"
    ],
    "agentMode": true,
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-07-11T02:17:49.107Z",
    "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-07-11T02:17:49.107Z",
          "uploadSuccessful": true,
          "tokenCount": 1,
          "metadataTokenCount": 1,
          "indexingNotPossible": true,
          "unsupportedFileType": true,
          "unPackingComplete": true,
          "unPackingFailed": true,
          "uploadInProgress": true,
          "url": "text",
          "hasChildren": 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,
          "metadata": [
            {
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "key": "text",
              "value": "text"
            }
          ]
        }
      ],
      "dateAdded": "2026-07-11T02:17:49.107Z",
      "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,
      "assistantMessageCount": 1,
      "userMessageCount": 1,
      "totalCount": 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-07-11T02:17:49.107Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "indexingNotPossible": true,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": 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,
        "metadata": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "key": "text",
            "value": "text"
          }
        ]
      }
    ],
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    },
    "isStreaming": true,
    "hasContentBlocks": true
  }
]

Create a new message in a flow chat.

post

Sends a user message to the flow chat and returns the model-generated reply, optionally as a streamed Server-Sent Events response.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

chatIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

messageResponseTypeIdinteger · int32 · nullableOptional

isAssistantbooleanRequired

isStreamingbooleanOptional

hasContentBlocksbooleanOptional

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "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,
  "tools": [
    "text"
  ],
  "agentMode": true
}

application/jsontext/jsonapplication/*+json

{
  "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,
  "tools": [
    "text"
  ],
  "agentMode": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-11T02:17:49.107Z",
  "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-07-11T02:17:49.107Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "indexingNotPossible": true,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": 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,
        "metadata": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "key": "text",
            "value": "text"
          }
        ]
      }
    ],
    "dateAdded": "2026-07-11T02:17:49.107Z",
    "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,
    "assistantMessageCount": 1,
    "userMessageCount": 1,
    "totalCount": 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-07-11T02:17:49.107Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "indexingNotPossible": true,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": 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,
      "metadata": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "isStreaming": true,
  "hasContentBlocks": true
}

Compare two documents in a flow chat.

post

Creates a comparison message for exactly two documents and returns the model-generated comparison.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

chatIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

comparisonDocumentIdentifierstring · uuidRequired

documentObjectIdentifiersstring · uuid[] · nullableRequired

Responses

200

OK

text/plainapplication/jsontext/json

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

messageResponseTypeIdinteger · int32 · nullableOptional

isAssistantbooleanRequired

isStreamingbooleanOptional

hasContentBlocksbooleanOptional

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages/compare

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages/compare HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "comparisonDocumentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "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,
  "tools": [
    "text"
  ],
  "agentMode": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-11T02:17:49.107Z",
  "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-07-11T02:17:49.107Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "indexingNotPossible": true,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": 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,
        "metadata": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "key": "text",
            "value": "text"
          }
        ]
      }
    ],
    "dateAdded": "2026-07-11T02:17:49.107Z",
    "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,
    "assistantMessageCount": 1,
    "userMessageCount": 1,
    "totalCount": 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-07-11T02:17:49.107Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "indexingNotPossible": true,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": 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,
      "metadata": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "isStreaming": true,
  "hasContentBlocks": true
}

Get a flow chat message by object identifier.

get

Returns the details of a single flow chat message identified by its GUID.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowIdentifierstringRequired

chatIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

messageResponseTypeIdinteger · int32 · nullableOptional

isAssistantbooleanRequired

isStreamingbooleanOptional

hasContentBlocksbooleanOptional

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/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,
  "tools": [
    "text"
  ],
  "agentMode": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-11T02:17:49.107Z",
  "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-07-11T02:17:49.107Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "indexingNotPossible": true,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": 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,
        "metadata": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "key": "text",
            "value": "text"
          }
        ]
      }
    ],
    "dateAdded": "2026-07-11T02:17:49.107Z",
    "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,
    "assistantMessageCount": 1,
    "userMessageCount": 1,
    "totalCount": 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-07-11T02:17:49.107Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "indexingNotPossible": true,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": 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,
      "metadata": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "isStreaming": true,
  "hasContentBlocks": true
}

Update a flow chat message by object identifier.

put

Replaces the text of an existing flow chat message and returns the updated message.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowIdentifierstringRequired

chatIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

textstring · nullableRequired

messageDocumentIdentifiersstring · uuid[] · nullableOptional

flowObjectIdentifiersstring · uuid[] · nullableOptional

modelIdentifierstring · uuidRequired

streamboolean · nullableOptional

messageTypestring · enumOptionalPossible values:

thinkingEffortstring · nullableOptional

compactionEnabledboolean · nullableOptional

toolsstring[] · nullableOptional

agentModeboolean · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

messageResponseTypeIdinteger · int32 · nullableOptional

isAssistantbooleanRequired

isStreamingbooleanOptional

hasContentBlocksbooleanOptional

403

Forbidden

text/plainapplication/jsontext/json

put/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "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,
  "tools": [
    "text"
  ],
  "agentMode": true
}

application/jsontext/jsonapplication/*+json

{
  "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,
  "tools": [
    "text"
  ],
  "agentMode": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-11T02:17:49.107Z",
  "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-07-11T02:17:49.107Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "indexingNotPossible": true,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": 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,
        "metadata": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "key": "text",
            "value": "text"
          }
        ]
      }
    ],
    "dateAdded": "2026-07-11T02:17:49.107Z",
    "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,
    "assistantMessageCount": 1,
    "userMessageCount": 1,
    "totalCount": 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-07-11T02:17:49.107Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "indexingNotPossible": true,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": 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,
      "metadata": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "isStreaming": true,
  "hasContentBlocks": true
}

Delete a flow chat message by object identifier.

delete

Permanently removes a flow chat message. Requires container admin rights.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowIdentifierstringRequired

chatIdentifierstringRequired

Responses

204

No Content

No content

403

Forbidden

text/plainapplication/jsontext/json

delete/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages/{objectIdentifier}

HTTPcURLJavaScriptPython

DELETE /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export a flow chat message in the specified format.

post

Generates and returns a downloadable file (PDF, Word, Excel, or email) representing a flow chat message.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

chatIdentifierstring · uuidRequired

messageObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowIdentifierstringRequired

Query parameters

formatstringOptionalDefault: pdf

Responses

200

OK

text/plainapplication/jsontext/json

string · binaryOptional

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{chatIdentifier}/messages/{messageObjectIdentifier}/export

HTTPcURLJavaScriptPython

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

binary