Messages

Retrieves a paginated list of messages for the specified assistant.

get

Retrieves a paginated list of messages for the specified assistant, optionally filtered and sorted.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

assistantIdentifierstring · uuidRequired

The unique identifier of the assistant.

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter messages.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

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"
    ],
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stream": true,
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "textWithCitations": "text",
    "dateAdded": "2025-12-06T03:43:35.884Z",
    "messageResponseTypeId": 1,
    "addingCitations": true,
    "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": "2025-12-06T03:43:35.884Z",
          "uploadSuccessful": true,
          "tokenCount": 1,
          "metadataTokenCount": 1,
          "unsupportedFileType": true,
          "unPackingComplete": true,
          "unPackingFailed": true,
          "uploadInProgress": true,
          "url": "text",
          "hasChildren": true,
          "resourceOwner": {
            "email": "text",
            "name": "text",
            "id": "text"
          }
        }
      ],
      "dateAdded": "2025-12-06T03:43:35.884Z",
      "documentMetadata": [
        {
          "paragraphs": [
            {
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "content": "text",
              "boundingRegions": [
                {
                  "points": [
                    1
                  ],
                  "page": 1
                }
              ],
              "role": "Title"
            }
          ],
          "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "estimatedTokenCount": 1,
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      }
    },
    "isAssistant": true,
    "messageCitations": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "quote": "text",
        "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "messageObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "citationsJsonResponse": {
      "citations": [
        {
          "assertion": "text",
          "evidence": [
            {
              "document": "123e4567-e89b-12d3-a456-426614174000",
              "quote": "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": "2025-12-06T03:43:35.884Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": true,
        "resourceOwner": {
          "email": "text",
          "name": "text",
          "id": "text"
        }
      }
    ],
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    }
  }
]

Creates a new message in the specified assistant.

post

Creates a new message in the specified assistant. Supports streaming responses.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

assistantIdentifierstring · uuidRequired

The unique identifier of the assistant.

projectIdentifierstringRequired

Body

textstring | nullableRequired

messageDocumentIdentifiersstring · uuid[] | nullableOptional

modelIdentifierstring · uuidRequired

streamboolean | nullableOptional

Responses

200

400

Bad Request

403

Forbidden

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: 156

{
  "text": "text",
  "messageDocumentIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true
}

{
  "text": "text",
  "messageDocumentIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "textWithCitations": "text",
  "dateAdded": "2025-12-06T03:43:35.884Z",
  "messageResponseTypeId": 1,
  "addingCitations": true,
  "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": "2025-12-06T03:43:35.884Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": true,
        "resourceOwner": {
          "email": "text",
          "name": "text",
          "id": "text"
        }
      }
    ],
    "dateAdded": "2025-12-06T03:43:35.884Z",
    "documentMetadata": [
      {
        "paragraphs": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "content": "text",
            "boundingRegions": [
              {
                "points": [
                  1
                ],
                "page": 1
              }
            ],
            "role": "Title"
          }
        ],
        "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "estimatedTokenCount": 1,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    }
  },
  "isAssistant": true,
  "messageCitations": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "quote": "text",
      "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "messageObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "citationsJsonResponse": {
    "citations": [
      {
        "assertion": "text",
        "evidence": [
          {
            "document": "123e4567-e89b-12d3-a456-426614174000",
            "quote": "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": "2025-12-06T03:43:35.884Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": true,
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      }
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Retrieves a message by its object identifier.

get

Retrieves a message by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the message to retrieve.

projectIdentifierstringRequired

assistantIdentifierstringRequired

Responses

200

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"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "textWithCitations": "text",
  "dateAdded": "2025-12-06T03:43:35.884Z",
  "messageResponseTypeId": 1,
  "addingCitations": true,
  "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": "2025-12-06T03:43:35.884Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": true,
        "resourceOwner": {
          "email": "text",
          "name": "text",
          "id": "text"
        }
      }
    ],
    "dateAdded": "2025-12-06T03:43:35.884Z",
    "documentMetadata": [
      {
        "paragraphs": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "content": "text",
            "boundingRegions": [
              {
                "points": [
                  1
                ],
                "page": 1
              }
            ],
            "role": "Title"
          }
        ],
        "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "estimatedTokenCount": 1,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    }
  },
  "isAssistant": true,
  "messageCitations": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "quote": "text",
      "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "messageObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "citationsJsonResponse": {
    "citations": [
      {
        "assertion": "text",
        "evidence": [
          {
            "document": "123e4567-e89b-12d3-a456-426614174000",
            "quote": "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": "2025-12-06T03:43:35.884Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": true,
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      }
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Updates a message by its object identifier.

put

Updates a message by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the message to update.

projectIdentifierstringRequired

assistantIdentifierstringRequired

Body

textstring | nullableRequired

messageDocumentIdentifiersstring · uuid[] | nullableOptional

modelIdentifierstring · uuidRequired

streamboolean | nullableOptional

Responses

200

400

Bad Request

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: 156

{
  "text": "text",
  "messageDocumentIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true
}

{
  "text": "text",
  "messageDocumentIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stream": true,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "textWithCitations": "text",
  "dateAdded": "2025-12-06T03:43:35.884Z",
  "messageResponseTypeId": 1,
  "addingCitations": true,
  "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": "2025-12-06T03:43:35.884Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": true,
        "resourceOwner": {
          "email": "text",
          "name": "text",
          "id": "text"
        }
      }
    ],
    "dateAdded": "2025-12-06T03:43:35.884Z",
    "documentMetadata": [
      {
        "paragraphs": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "content": "text",
            "boundingRegions": [
              {
                "points": [
                  1
                ],
                "page": 1
              }
            ],
            "role": "Title"
          }
        ],
        "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "estimatedTokenCount": 1,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    }
  },
  "isAssistant": true,
  "messageCitations": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "quote": "text",
      "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "messageObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "citationsJsonResponse": {
    "citations": [
      {
        "assertion": "text",
        "evidence": [
          {
            "document": "123e4567-e89b-12d3-a456-426614174000",
            "quote": "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": "2025-12-06T03:43:35.884Z",
      "uploadSuccessful": true,
      "tokenCount": 1,
      "metadataTokenCount": 1,
      "unsupportedFileType": true,
      "unPackingComplete": true,
      "unPackingFailed": true,
      "uploadInProgress": true,
      "url": "text",
      "hasChildren": true,
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      }
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Deletes a message by its object identifier.

delete

Deletes a message by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the message to delete.

projectIdentifierstringRequired

assistantIdentifierstringRequired

Responses

204

No Content

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

Uploads a document to be attached to a message.

post

Uploads a document to be attached to a message.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

assistantIdentifierstringRequired

Body

filestring · binaryOptional

The file to upload.

Responses

200

400

Bad Request

403

Forbidden

post

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

POST /projects/{projectIdentifier}/assistants/{assistantIdentifier}/messages/document HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "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": "2025-12-06T03:43:35.884Z",
  "uploadSuccessful": true,
  "tokenCount": 1,
  "metadataTokenCount": 1,
  "unsupportedFileType": true,
  "unPackingComplete": true,
  "unPackingFailed": true,
  "uploadInProgress": true,
  "url": "text",
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

PreviousFlows NextMetadata

Last updated 4 months ago