Project

Retrieves the details of a project by its unique identifier.

get

Retrieves the details of a project by its unique identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Responses

200

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": "2025-12-06T03:54:32.128Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2025-12-06T03:54:32.128Z",
      "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

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstring · uuidRequired

The unique identifier of the project to update.

Body

namestring | nullableRequired

descriptionstring | nullableRequired

Responses

200

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": "2025-12-06T03:54:32.128Z",
      "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "name": "text",
  "description": "text",
  "dateAdded": "2025-12-06T03:54:32.128Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2025-12-06T03:54:32.128Z",
      "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

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Responses

204

No Content

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

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

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

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": "2025-12-06T03:54:32.128Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "metadataValues": [
    {
      "isYes": true,
      "text": "text",
      "decimalValue": 1,
      "date": "2025-12-06T03:54:32.128Z",
      "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

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Responses

200

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

PreviousOrganization Metadata Options NextProject Admin ACL

Last updated 4 months ago