Assistants

Retrieves a paginated list of assistants for the specified project.

get

Retrieves a paginated list of assistants for the specified project, optionally filtered and sorted.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter assistants.

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

GET /projects/{projectIdentifier}/assistants 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": "2025-12-06T03:54:31.938Z",
        "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:54:31.938Z",
    "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"
    }
  }
]

Creates a new assistant in the specified project.

post

Creates a new assistant in the specified project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Body

namestring | nullableRequired

descriptionstring | nullableOptional

documentObjectIdentifiersstring · uuid[] | nullableOptional

Responses

200

400

Bad Request

403

Forbidden

post

/projects/{projectIdentifier}/assistants

POST /projects/{projectIdentifier}/assistants 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": "2025-12-06T03:54:31.938Z",
      "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:54:31.938Z",
  "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"
  }
}

Retrieves an assistant by its object identifier.

get

Retrieves a assistant by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the assistant to retrieve.

projectIdentifierstringRequired

Responses

200

403

Forbidden

404

Not Found

get

/projects/{projectIdentifier}/assistants/{objectIdentifier}

GET /projects/{projectIdentifier}/assistants/{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": "2025-12-06T03:54:31.938Z",
      "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:54:31.938Z",
  "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"
  }
}

Updates an assistant by its object identifier.

put

Updates an assistant by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the assistant to update.

projectIdentifierstringRequired

Body

namestring | nullableOptional

descriptionstring | nullableOptional

autoRenameboolean | nullableOptional

modelIdentifierstring · uuid | nullableOptional

Responses

200

400

Bad Request

403

Forbidden

404

Not Found

put

/projects/{projectIdentifier}/assistants/{objectIdentifier}

PUT /projects/{projectIdentifier}/assistants/{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": "2025-12-06T03:54:31.938Z",
      "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:54:31.938Z",
  "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"
  }
}

Deletes an assistant by its object identifier.

delete

Deletes an assistant by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the assistant to delete.

projectIdentifierstringRequired

Responses

204

No Content

403

Forbidden

404

Not Found

delete

/projects/{projectIdentifier}/assistants/{objectIdentifier}

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

No content

Gets the total token length for the specified documents in the project.

post

Gets the total token length for the specified documents in the project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Body

documentIdsstring · uuid[] | nullableOptional

Responses

200

Responseinteger · int64

400

Bad Request

403

Forbidden

post

/projects/{projectIdentifier}/assistants/query-token-length

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

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

PreviousAssembly NextDeveloper

Last updated 4 months ago