Project

Retrieves the details of a project by its unique identifier.

get

Retrieves the details of a project by its unique identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/projects/{projectIdentifier}

HTTPcURLJavaScriptPython

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-28T11:16:53.096Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2026-01-28T11:16:53.096Z",
      "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"
  }
}

Updates the specified project with new data.

put

Updates the specified project with new data.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstring · uuidRequired

The unique identifier of the project to update.

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

descriptionstring · nullableRequired

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put

/projects/{projectIdentifier}

HTTPcURLJavaScriptPython

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-28T11:16:53.096Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "dateAdded": "2026-01-28T11:16:53.096Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2026-01-28T11:16:53.096Z",
      "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"
  }
}

Deletes the specified project by its unique identifier.

delete

Deletes the specified project by its unique identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Responses

204

No Content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete

/projects/{projectIdentifier}

HTTPcURLJavaScriptPython

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

No content

Retrieves the personal project for the authenticated user if personal workspace is enabled.

get

Retrieves the personal project for the authenticated user if personal workspace is enabled.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get

/projects/my-personal-project

HTTPcURLJavaScriptPython

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-28T11:16:53.096Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2026-01-28T11:16:53.096Z",
      "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"
  }
}

Retrieves analytics data for the specified project.

get

Retrieves analytics data for the specified project.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/projects/{projectIdentifier}/analytics

HTTPcURLJavaScriptPython

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",
  "chatCount": 1,
  "reviewCount": 1,
  "teamCount": 1,
  "documentCount": 1
}