Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Flow Chats

List flow chats.

get

Returns a paged, searchable and sortable list of the chats belonging to the specified flow.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired
projectIdentifierstringRequired
Query parameters
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
searchTextstringOptional
sortingstring · enumOptionalPossible values:
descbooleanOptionalDefault: true
Responses
200

OK

objectIdentifierstring · uuidOptional
namestring · nullableRequired
descriptionstring · nullableOptional
dateAddedstring · date-timeOptional
estimatedTokenCountinteger · int32Optional
lastContextTokensinteger · int64 · nullableOptional
lastContextModelIdentifierstring · uuid · nullableOptional
compactionEnabledbooleanOptional
assistantMessageCountinteger · int32Optional
userMessageCountinteger · int32Optional
totalCountinteger · int32Optional
creditsnumber · double · nullableOptional
get/projects/{projectIdentifier}/flows/{flowIdentifier}/chats
GET /projects/{projectIdentifier}/flows/{flowIdentifier}/chats HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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"
    }
  }
]

Create a flow chat.

post

Creates a new chat conversation bound to the specified flow, optionally attaching documents to use as context.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired
projectIdentifierstringRequired
Body
namestring · nullableRequired
descriptionstring · nullableOptional
documentObjectIdentifiersstring · uuid[] · nullableOptional
Responses
200

OK

objectIdentifierstring · uuidOptional
namestring · nullableRequired
descriptionstring · nullableOptional
dateAddedstring · date-timeOptional
estimatedTokenCountinteger · int32Optional
lastContextTokensinteger · int64 · nullableOptional
lastContextModelIdentifierstring · uuid · nullableOptional
compactionEnabledbooleanOptional
assistantMessageCountinteger · int32Optional
userMessageCountinteger · int32Optional
totalCountinteger · int32Optional
creditsnumber · double · nullableOptional
post/projects/{projectIdentifier}/flows/{flowIdentifier}/chats
POST /projects/{projectIdentifier}/flows/{flowIdentifier}/chats HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "name": "text",
  "description": "text",
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "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"
  }
}

Get a flow chat.

get

Retrieves a single chat belonging to the flow by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
namestring · nullableRequired
descriptionstring · nullableOptional
dateAddedstring · date-timeOptional
estimatedTokenCountinteger · int32Optional
lastContextTokensinteger · int64 · nullableOptional
lastContextModelIdentifierstring · uuid · nullableOptional
compactionEnabledbooleanOptional
assistantMessageCountinteger · int32Optional
userMessageCountinteger · int32Optional
totalCountinteger · int32Optional
creditsnumber · double · nullableOptional
get/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{objectIdentifier}
GET /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
  }
}

Update a flow chat.

put

Updates a flow chat's settings, such as its name, auto-rename behaviour, or the model it uses.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowIdentifierstringRequired
Body
namestring · nullableOptional
descriptionstring · nullableOptional
autoRenameboolean · nullableOptional
modelIdentifierstring · uuid · nullableOptional
Responses
200

OK

objectIdentifierstring · uuidOptional
namestring · nullableRequired
descriptionstring · nullableOptional
dateAddedstring · date-timeOptional
estimatedTokenCountinteger · int32Optional
lastContextTokensinteger · int64 · nullableOptional
lastContextModelIdentifierstring · uuid · nullableOptional
compactionEnabledbooleanOptional
assistantMessageCountinteger · int32Optional
userMessageCountinteger · int32Optional
totalCountinteger · int32Optional
creditsnumber · double · nullableOptional
put/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{objectIdentifier}
PUT /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "name": "text",
  "description": "text",
  "autoRename": true,
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "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"
  }
}

Delete a flow chat.

delete

Permanently deletes a chat from the flow. Requires container administrator rights.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowIdentifierstringRequired
Responses
204

No Content

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

No content

Get document token length.

post

Returns the combined token count of the supplied documents, useful for estimating context window usage before attaching them to a chat.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired
projectIdentifierstringRequired
Body
idsstring · uuid[] · nullableOptional
Responses
200

OK

integer · int64Optional
post/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/query-token-length
POST /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/query-token-length HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
1

Download a flow chat session file.

get

Downloads a file generated by a tool during a flow chat session.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
sessionFileIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowIdentifierstringRequired
Responses
200

OK

string · binaryOptional
get/projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{objectIdentifier}/session-files/{sessionFileIdentifier}
GET /projects/{projectIdentifier}/flows/{flowIdentifier}/chats/{objectIdentifier}/session-files/{sessionFileIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary
PreviousFlow Chat Messages
NextFlow Document Collection Assignments

Last updated