Projects

Get all projects.

get

Retrieves a paginated list of projects, optionally filtered by search text and sorted, scoped either to the caller's projects or the whole organization.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

scopestringOptionalDefault: member

sortingstringOptionalDefault: dateAdded

descbooleanOptionalDefault: true

filterColumnstring · enumOptionalPossible values:

filterOperationstring · enumOptionalPossible values:

filterSearchTermstringOptional

Responses

200

OK

totalCountinteger · int32Optional

400

Bad Request

401

Unauthorized

403

Forbidden

get/projects

GET /projects HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "text",
      "description": "text",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "metadataValues": [
        {
          "isYes": true,
          "text": "text",
          "decimalValue": 1,
          "date": "2026-01-01T00:00:00.000Z",
          "categories": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "metadata": {
            "name": "text",
            "description": "text",
            "dataType": "text",
            "isRequired": true,
            "options": [
              {
                "name": "text",
                "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
          }
        }
      ],
      "resourceOwner": {
        "email": "text",
        "name": "text",
        "id": "text"
      },
      "isPersonal": true
    }
  ],
  "totalCount": 1
}

Create a new project.

post

Creates a new project in the caller's organization using the supplied name, description and metadata, and returns the created project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Body

namestring · nullableRequired

descriptionstring · nullableRequired

Responses

200

OK

namestring · nullableRequired

descriptionstring · nullableRequired

dateAddedstring · date-time · nullableRequired

objectIdentifierstring · uuidRequired

isPersonalbooleanOptional

400

Bad Request

401

Unauthorized

403

Forbidden

post/projects

POST /projects HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 321

{
  "name": "text",
  "description": "text",
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2026-01-01T00:00:00.000Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "name": "text",
  "description": "text",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2026-01-01T00:00:00.000Z",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "name": "text",
        "description": "text",
        "dataType": "text",
        "isRequired": true,
        "options": [
          {
            "name": "text",
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "isPersonal": true
}

Get a project by identifier.

get

Retrieves a single project's details by its GUID, returned as a ProjectReadModel.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Responses

200

OK

namestring · nullableRequired

descriptionstring · nullableRequired

dateAddedstring · date-time · nullableRequired

objectIdentifierstring · uuidRequired

isPersonalbooleanOptional

403

Forbidden

404

Not Found

get/projects/{projectIdentifier}

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

{
  "name": "text",
  "description": "text",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2026-01-01T00:00:00.000Z",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "name": "text",
        "description": "text",
        "dataType": "text",
        "isRequired": true,
        "options": [
          {
            "name": "text",
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "isPersonal": true
}

Update a project.

put

Updates the project identified by the route GUID with the supplied values and returns the updated ProjectReadModel.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstring · uuidRequired

Body

namestring · nullableRequired

descriptionstring · nullableRequired

Responses

200

OK

namestring · nullableRequired

descriptionstring · nullableRequired

dateAddedstring · date-time · nullableRequired

objectIdentifierstring · uuidRequired

isPersonalbooleanOptional

400

Bad Request

403

Forbidden

404

Not Found

put/projects/{projectIdentifier}

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

{
  "name": "text",
  "description": "text",
  "metadata": [
    {
      "isYes": true,
      "decimalValue": 1,
      "text": "text",
      "date": "2026-01-01T00:00:00.000Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "name": "text",
  "description": "text",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2026-01-01T00:00:00.000Z",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "name": "text",
        "description": "text",
        "dataType": "text",
        "isRequired": true,
        "options": [
          {
            "name": "text",
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "isPersonal": true
}

Delete a project.

delete

Permanently deletes the project identified by the route GUID. For external workspace administrators removing an unwanted project. Personal projects cannot be deleted.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Responses

204

No Content

No content

400

Bad Request

403

Forbidden

404

Not Found

delete/projects/{projectIdentifier}

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

No content

Get the current user's personal project.

get

Retrieves the authenticated user's personal project as a ProjectReadModel. Returns 403 when personal workspaces are not enabled.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

OK

namestring · nullableRequired

descriptionstring · nullableRequired

dateAddedstring · date-time · nullableRequired

objectIdentifierstring · uuidRequired

isPersonalbooleanOptional

403

Forbidden

get/projects/my-personal-project

GET /projects/my-personal-project HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "description": "text",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2026-01-01T00:00:00.000Z",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "name": "text",
        "description": "text",
        "dataType": "text",
        "isRequired": true,
        "options": [
          {
            "name": "text",
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "isPersonal": true
}

Get analytics for a project.

get

Retrieves aggregated usage and activity analytics for the project, returned as a ProjectAnalyticsModel.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Responses

200

OK

objectIdentifierstring · uuidRequired

assistantCountinteger · int32Optional

flowCountinteger · int32Optional

teamCountinteger · int32Optional

documentCountinteger · int32Optional

403

Forbidden

404

Not Found

get/projects/{projectIdentifier}/analytics

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

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "assistantCount": 1,
  "flowCount": 1,
  "teamCount": 1,
  "documentCount": 1
}