Prompts

List comments for a prompt answer.

get

Returns a paginated list of comments attached to a prompt answer, suitable for rendering a discussion thread.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptAnswerObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Query parameters

pageinteger · int32OptionalDefault: 1

pageSizeinteger · int32OptionalDefault: 20

Responses

200

OK

text/plainapplication/jsontext/json

totalCountinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/prompt-answers/{promptAnswerObjectIdentifier}/comments

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptAnswerObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "comment": "text",
      "dateAdded": "2026-07-11T01:29:17.474Z",
      "resourceOwnerId": "text",
      "resourceOwner": {
        "name": "text",
        "id": "text",
        "email": "text",
        "picture": "text",
        "roles": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      }
    }
  ],
  "totalCount": 1
}

Add a comment to a prompt answer.

post

Creates a new comment against a prompt answer so collaborators can discuss the generated result. Returns the created comment.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptAnswerObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

commentstring · nullableRequired

Responses

201

Created

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

promptAnswerObjectIdentifierstring · uuidOptional

commentstring · nullableOptional

dateAddedstring · date-timeOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/projects/{projectIdentifier}/prompt-answers/{promptAnswerObjectIdentifier}/comments

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/prompt-answers/{promptAnswerObjectIdentifier}/comments HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "comment": "text"
}

application/jsontext/jsonapplication/*+json

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "promptAnswerObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "comment": "text",
  "dateAdded": "2026-07-11T01:29:17.474Z",
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Get a prompt answer comment.

get

Returns the details of a single prompt answer comment identified by its GUID.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

promptAnswerObjectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

promptAnswerObjectIdentifierstring · uuidOptional

commentstring · nullableOptional

dateAddedstring · date-timeOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/prompt-answers/{promptAnswerObjectIdentifier}/comments/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/prompt-answers/{promptAnswerObjectIdentifier}/comments/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "promptAnswerObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "comment": "text",
  "dateAdded": "2026-07-11T01:29:17.474Z",
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Update a prompt answer comment.

put

Edits the text of an existing prompt answer comment and returns the updated comment.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

promptAnswerObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

commentstring · nullableRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

promptAnswerObjectIdentifierstring · uuidOptional

commentstring · nullableOptional

dateAddedstring · date-timeOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

put/projects/{projectIdentifier}/prompt-answers/{promptAnswerObjectIdentifier}/comments/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /projects/{projectIdentifier}/prompt-answers/{promptAnswerObjectIdentifier}/comments/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "comment": "text"
}

application/jsontext/jsonapplication/*+json

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "promptAnswerObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "comment": "text",
  "dateAdded": "2026-07-11T01:29:17.474Z",
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Delete a prompt answer comment.

delete

Permanently deletes a prompt answer comment. The deletion cannot be undone.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

promptAnswerObjectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

delete/projects/{projectIdentifier}/prompt-answers/{promptAnswerObjectIdentifier}/comments/{objectIdentifier}

HTTPcURLJavaScriptPython

DELETE /projects/{projectIdentifier}/prompt-answers/{promptAnswerObjectIdentifier}/comments/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List prompts.

get

Returns prompts in a flow group, filterable by parent, search term, explicit identifiers or numeric id, with optional answer options.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Query parameters

includeOptionsbooleanOptional

flattenbooleanOptional

parentObjectIdentifierstring · uuidOptional

offsetObjectIdentifierstring · uuidOptional

takeinteger · int32OptionalDefault: 100

searchTermstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

idinteger · int32Optional

objectIdentifiersstringOptional

Responses

200

OK

text/plainapplication/jsontext/json

dateAddedstring · date-timeOptional

objectIdentifierstring · uuidOptional

stableObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

minimumValuenumber · double · nullableOptional

maximumValuenumber · double · nullableOptional

foundboolean · nullableOptional

hasChildrenboolean · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

runStatusstring · enumOptionalPossible values:

questionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts

HTTPcURLJavaScriptPython

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

[
  {
    "dateAdded": "2026-07-11T01:29:17.474Z",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "description": "text",
    "promptDataType": "boolean",
    "conditionOperator": "and",
    "categories": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "colour": "primary"
      }
    ],
    "minimumValue": 1,
    "maximumValue": 1,
    "found": true,
    "hasChildren": true,
    "startDate": "2026-07-11T01:29:17.474Z",
    "endDate": "2026-07-11T01:29:17.474Z",
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "runStatus": "pending",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "promptDataType": "boolean",
            "properties": [
              {
                "type": "text",
                "attrs": {
                  "type": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "id": "text",
                  "label": "text",
                  "renderAs": "text",
                  "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                }
              }
            ],
            "level": 1,
            "href": "text",
            "textAlign": "text"
          },
          "marks": [
            {
              "type": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "promptDataType": "boolean",
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              }
            }
          ],
          "content": [
            "[Circular Reference]"
          ]
        }
      ]
    },
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "reasoningEffort": "none",
    "canEdit": true,
    "includeDocuments": true,
    "conditions": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "promptPredicate": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "label": "text",
          "promptDataType": "boolean"
        },
        "isYes": true,
        "fuzzyMatch": true,
        "minimumDecimalAnswer": 1,
        "maximumDecimalAnswer": 1,
        "textAnswer": "text",
        "allCategoriesMatch": true,
        "decimalAnswer": 1,
        "decimalOperator": "equal",
        "dateOperator": "equal",
        "startDate": "2026-07-11T01:29:17.474Z",
        "endDate": "2026-07-11T01:29:17.474Z",
        "dateAnswer": "2026-07-11T01:29:17.474Z",
        "categories": [
          {
            "category": "text"
          }
        ]
      }
    ],
    "resourceOwnerId": "text",
    "resourceOwner": {
      "name": "text",
      "id": "text",
      "email": "text",
      "picture": "text",
      "roles": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  }
]

Create a prompt.

post

Adds a new prompt to a flow group, including its question, model and any answer-based conditions.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

resourceOwnerstring · nullableOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

Responses

200

OK

text/plainapplication/jsontext/json

dateAddedstring · date-timeOptional

objectIdentifierstring · uuidOptional

stableObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

minimumValuenumber · double · nullableOptional

maximumValuenumber · double · nullableOptional

foundboolean · nullableOptional

hasChildrenboolean · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

runStatusstring · enumOptionalPossible values:

questionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

resourceOwnerIdstring · nullableOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

post/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2413

{
  "resourceOwner": "text",
  "label": "text",
  "description": "text",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "promptDataType": "boolean",
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "conditions": [
    {
      "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isYes": true,
      "fuzzyMatch": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "textAnswer": "text",
      "allCategoriesMatch": true,
      "decimalAnswer": 1,
      "decimalOperator": "equal",
      "dateOperator": "equal",
      "startDate": "2026-07-11T01:29:17.474Z",
      "endDate": "2026-07-11T01:29:17.474Z",
      "dateAnswer": "2026-07-11T01:29:17.474Z",
      "categories": [
        {
          "category": "text"
        }
      ]
    }
  ],
  "promptDataType": "boolean",
  "conditionOperator": "and",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true
}

application/jsontext/jsonapplication/*+json

{
  "dateAdded": "2026-07-11T01:29:17.474Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "label": "text",
  "description": "text",
  "promptDataType": "boolean",
  "conditionOperator": "and",
  "categories": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "colour": "primary"
    }
  ],
  "minimumValue": 1,
  "maximumValue": 1,
  "found": true,
  "hasChildren": true,
  "startDate": "2026-07-11T01:29:17.474Z",
  "endDate": "2026-07-11T01:29:17.474Z",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "runStatus": "pending",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "promptDataType": "boolean",
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true,
  "conditions": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptPredicate": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "promptDataType": "boolean"
      },
      "isYes": true,
      "fuzzyMatch": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "textAnswer": "text",
      "allCategoriesMatch": true,
      "decimalAnswer": 1,
      "decimalOperator": "equal",
      "dateOperator": "equal",
      "startDate": "2026-07-11T01:29:17.474Z",
      "endDate": "2026-07-11T01:29:17.474Z",
      "dateAnswer": "2026-07-11T01:29:17.474Z",
      "categories": [
        {
          "category": "text"
        }
      ]
    }
  ],
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Get a prompt.

get

Returns a single prompt by its GUID, optionally including its answer options and rich question JSON.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowGroupObjectIdentifierstringRequired

Query parameters

includeOptionsbooleanOptional

includeQuestionJsonbooleanOptional

Responses

200

OK

text/plainapplication/jsontext/json

dateAddedstring · date-timeOptional

objectIdentifierstring · uuidOptional

stableObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

minimumValuenumber · double · nullableOptional

maximumValuenumber · double · nullableOptional

foundboolean · nullableOptional

hasChildrenboolean · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

runStatusstring · enumOptionalPossible values:

questionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "dateAdded": "2026-07-11T01:29:17.474Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "label": "text",
  "description": "text",
  "promptDataType": "boolean",
  "conditionOperator": "and",
  "categories": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "colour": "primary"
    }
  ],
  "minimumValue": 1,
  "maximumValue": 1,
  "found": true,
  "hasChildren": true,
  "startDate": "2026-07-11T01:29:17.474Z",
  "endDate": "2026-07-11T01:29:17.474Z",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "runStatus": "pending",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "promptDataType": "boolean",
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true,
  "conditions": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptPredicate": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "promptDataType": "boolean"
      },
      "isYes": true,
      "fuzzyMatch": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "textAnswer": "text",
      "allCategoriesMatch": true,
      "decimalAnswer": 1,
      "decimalOperator": "equal",
      "dateOperator": "equal",
      "startDate": "2026-07-11T01:29:17.474Z",
      "endDate": "2026-07-11T01:29:17.474Z",
      "dateAnswer": "2026-07-11T01:29:17.474Z",
      "categories": [
        {
          "category": "text"
        }
      ]
    }
  ],
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Update a prompt.

put

Edits an existing prompt's question, model, data type and conditions.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowGroupObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

labelstring · nullableOptional

descriptionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

questionstring · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditboolean · nullableOptional

includeDocumentsboolean · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

dateAddedstring · date-timeOptional

objectIdentifierstring · uuidOptional

stableObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

minimumValuenumber · double · nullableOptional

maximumValuenumber · double · nullableOptional

foundboolean · nullableOptional

hasChildrenboolean · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

runStatusstring · enumOptionalPossible values:

questionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

resourceOwnerIdstring · nullableOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

put/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2408

{
  "label": "text",
  "description": "text",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "promptDataType": "boolean",
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "promptDataType": "boolean",
  "conditionOperator": "and",
  "conditions": [
    {
      "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isYes": true,
      "fuzzyMatch": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "textAnswer": "text",
      "allCategoriesMatch": true,
      "decimalAnswer": 1,
      "decimalOperator": "equal",
      "dateOperator": "equal",
      "startDate": "2026-07-11T01:29:17.474Z",
      "endDate": "2026-07-11T01:29:17.474Z",
      "dateAnswer": "2026-07-11T01:29:17.474Z",
      "categories": [
        {
          "category": "text"
        }
      ]
    }
  ],
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true
}

application/jsontext/jsonapplication/*+json

{
  "dateAdded": "2026-07-11T01:29:17.474Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "label": "text",
  "description": "text",
  "promptDataType": "boolean",
  "conditionOperator": "and",
  "categories": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "colour": "primary"
    }
  ],
  "minimumValue": 1,
  "maximumValue": 1,
  "found": true,
  "hasChildren": true,
  "startDate": "2026-07-11T01:29:17.474Z",
  "endDate": "2026-07-11T01:29:17.474Z",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "runStatus": "pending",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "promptDataType": "boolean",
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true,
  "conditions": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptPredicate": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "promptDataType": "boolean"
      },
      "isYes": true,
      "fuzzyMatch": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "textAnswer": "text",
      "allCategoriesMatch": true,
      "decimalAnswer": 1,
      "decimalOperator": "equal",
      "dateOperator": "equal",
      "startDate": "2026-07-11T01:29:17.474Z",
      "endDate": "2026-07-11T01:29:17.474Z",
      "dateAnswer": "2026-07-11T01:29:17.474Z",
      "categories": [
        {
          "category": "text"
        }
      ]
    }
  ],
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Delete a prompt.

delete

Permanently removes a prompt from a flow group, provided it is not referenced elsewhere and no run is active.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowGroupObjectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

delete/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier}

HTTPcURLJavaScriptPython

DELETE /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Count prompts.

get

Returns the total count of prompts in the flow group.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

integer · int32Optional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/count

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/count HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

List a prompt's ancestors.

get

Returns the chain of parent prompts above a given prompt in its flow group.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Query parameters

searchTextstringOptional

Responses

200

OK

text/plainapplication/jsontext/json

dateAddedstring · date-timeOptional

objectIdentifierstring · uuidOptional

stableObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

minimumValuenumber · double · nullableOptional

maximumValuenumber · double · nullableOptional

foundboolean · nullableOptional

hasChildrenboolean · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

runStatusstring · enumOptionalPossible values:

questionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier}/ancestors

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier}/ancestors HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "dateAdded": "2026-07-11T01:29:17.474Z",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "description": "text",
    "promptDataType": "boolean",
    "conditionOperator": "and",
    "categories": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "colour": "primary"
      }
    ],
    "minimumValue": 1,
    "maximumValue": 1,
    "found": true,
    "hasChildren": true,
    "startDate": "2026-07-11T01:29:17.474Z",
    "endDate": "2026-07-11T01:29:17.474Z",
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "runStatus": "pending",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "promptDataType": "boolean",
            "properties": [
              {
                "type": "text",
                "attrs": {
                  "type": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "id": "text",
                  "label": "text",
                  "renderAs": "text",
                  "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                }
              }
            ],
            "level": 1,
            "href": "text",
            "textAlign": "text"
          },
          "marks": [
            {
              "type": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "promptDataType": "boolean",
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              }
            }
          ],
          "content": [
            "[Circular Reference]"
          ]
        }
      ]
    },
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "reasoningEffort": "none",
    "canEdit": true,
    "includeDocuments": true,
    "conditions": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "promptPredicate": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "label": "text",
          "promptDataType": "boolean"
        },
        "isYes": true,
        "fuzzyMatch": true,
        "minimumDecimalAnswer": 1,
        "maximumDecimalAnswer": 1,
        "textAnswer": "text",
        "allCategoriesMatch": true,
        "decimalAnswer": 1,
        "decimalOperator": "equal",
        "dateOperator": "equal",
        "startDate": "2026-07-11T01:29:17.474Z",
        "endDate": "2026-07-11T01:29:17.474Z",
        "dateAnswer": "2026-07-11T01:29:17.474Z",
        "categories": [
          {
            "category": "text"
          }
        ]
      }
    ],
    "resourceOwnerId": "text",
    "resourceOwner": {
      "name": "text",
      "id": "text",
      "email": "text",
      "picture": "text",
      "roles": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  }
]

List ancestors by parent.

get

Returns the ancestor prompts for a new prompt that would sit under the given parent.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Query parameters

parentObjectIdentifierstring · uuidOptional

searchTextstringOptional

Responses

200

OK

text/plainapplication/jsontext/json

dateAddedstring · date-timeOptional

objectIdentifierstring · uuidOptional

stableObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

minimumValuenumber · double · nullableOptional

maximumValuenumber · double · nullableOptional

foundboolean · nullableOptional

hasChildrenboolean · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

runStatusstring · enumOptionalPossible values:

questionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/ancestors-by-parent

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/ancestors-by-parent HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "dateAdded": "2026-07-11T01:29:17.474Z",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "description": "text",
    "promptDataType": "boolean",
    "conditionOperator": "and",
    "categories": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "colour": "primary"
      }
    ],
    "minimumValue": 1,
    "maximumValue": 1,
    "found": true,
    "hasChildren": true,
    "startDate": "2026-07-11T01:29:17.474Z",
    "endDate": "2026-07-11T01:29:17.474Z",
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "runStatus": "pending",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "promptDataType": "boolean",
            "properties": [
              {
                "type": "text",
                "attrs": {
                  "type": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "id": "text",
                  "label": "text",
                  "renderAs": "text",
                  "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                }
              }
            ],
            "level": 1,
            "href": "text",
            "textAlign": "text"
          },
          "marks": [
            {
              "type": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "promptDataType": "boolean",
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              }
            }
          ],
          "content": [
            "[Circular Reference]"
          ]
        }
      ]
    },
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "reasoningEffort": "none",
    "canEdit": true,
    "includeDocuments": true,
    "conditions": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "promptPredicate": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "label": "text",
          "promptDataType": "boolean"
        },
        "isYes": true,
        "fuzzyMatch": true,
        "minimumDecimalAnswer": 1,
        "maximumDecimalAnswer": 1,
        "textAnswer": "text",
        "allCategoriesMatch": true,
        "decimalAnswer": 1,
        "decimalOperator": "equal",
        "dateOperator": "equal",
        "startDate": "2026-07-11T01:29:17.474Z",
        "endDate": "2026-07-11T01:29:17.474Z",
        "dateAnswer": "2026-07-11T01:29:17.474Z",
        "categories": [
          {
            "category": "text"
          }
        ]
      }
    ],
    "resourceOwnerId": "text",
    "resourceOwner": {
      "name": "text",
      "id": "text",
      "email": "text",
      "picture": "text",
      "roles": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  }
]

List mention options.

get

Returns the prompts that may be referenced in a mention or condition, excluding those that would create a cycle.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Query parameters

objectIdentifierstring · uuidOptional

parentObjectIdentifierstring · uuidOptional

searchTextstringOptional

Responses

200

OK

text/plainapplication/jsontext/json

dateAddedstring · date-timeOptional

objectIdentifierstring · uuidOptional

stableObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

minimumValuenumber · double · nullableOptional

maximumValuenumber · double · nullableOptional

foundboolean · nullableOptional

hasChildrenboolean · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

runStatusstring · enumOptionalPossible values:

questionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/mention-options

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/mention-options HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "dateAdded": "2026-07-11T01:29:17.474Z",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "description": "text",
    "promptDataType": "boolean",
    "conditionOperator": "and",
    "categories": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "colour": "primary"
      }
    ],
    "minimumValue": 1,
    "maximumValue": 1,
    "found": true,
    "hasChildren": true,
    "startDate": "2026-07-11T01:29:17.474Z",
    "endDate": "2026-07-11T01:29:17.474Z",
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "runStatus": "pending",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "promptDataType": "boolean",
            "properties": [
              {
                "type": "text",
                "attrs": {
                  "type": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "id": "text",
                  "label": "text",
                  "renderAs": "text",
                  "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                }
              }
            ],
            "level": 1,
            "href": "text",
            "textAlign": "text"
          },
          "marks": [
            {
              "type": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "promptDataType": "boolean",
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              }
            }
          ],
          "content": [
            "[Circular Reference]"
          ]
        }
      ]
    },
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "reasoningEffort": "none",
    "canEdit": true,
    "includeDocuments": true,
    "conditions": [
      {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "promptPredicate": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "label": "text",
          "promptDataType": "boolean"
        },
        "isYes": true,
        "fuzzyMatch": true,
        "minimumDecimalAnswer": 1,
        "maximumDecimalAnswer": 1,
        "textAnswer": "text",
        "allCategoriesMatch": true,
        "decimalAnswer": 1,
        "decimalOperator": "equal",
        "dateOperator": "equal",
        "startDate": "2026-07-11T01:29:17.474Z",
        "endDate": "2026-07-11T01:29:17.474Z",
        "dateAnswer": "2026-07-11T01:29:17.474Z",
        "categories": [
          {
            "category": "text"
          }
        ]
      }
    ],
    "resourceOwnerId": "text",
    "resourceOwner": {
      "name": "text",
      "id": "text",
      "email": "text",
      "picture": "text",
      "roles": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  }
]

Move a prompt.

put

Repositions a prompt within its flow group by changing its parent and order.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

parentObjectIdentifierstring · uuid · nullableOptional

orderNumberinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

dateAddedstring · date-timeOptional

objectIdentifierstring · uuidOptional

stableObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

conditionOperatorstring · enumOptionalPossible values:

minimumValuenumber · double · nullableOptional

maximumValuenumber · double · nullableOptional

foundboolean · nullableOptional

hasChildrenboolean · nullableOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

runStatusstring · enumOptionalPossible values:

questionstring · nullableOptional

modelIdentifierstring · uuid · nullableOptional

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

put/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier}/position

HTTPcURLJavaScriptPython

PUT /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/prompts/{objectIdentifier}/position HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": 1
}

application/jsontext/jsonapplication/*+json

{
  "dateAdded": "2026-07-11T01:29:17.474Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "label": "text",
  "description": "text",
  "promptDataType": "boolean",
  "conditionOperator": "and",
  "categories": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "colour": "primary"
    }
  ],
  "minimumValue": 1,
  "maximumValue": 1,
  "found": true,
  "hasChildren": true,
  "startDate": "2026-07-11T01:29:17.474Z",
  "endDate": "2026-07-11T01:29:17.474Z",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "runStatus": "pending",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "promptDataType": "boolean",
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "promptDataType": "boolean",
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true,
  "conditions": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptPredicate": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "promptDataType": "boolean"
      },
      "isYes": true,
      "fuzzyMatch": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "textAnswer": "text",
      "allCategoriesMatch": true,
      "decimalAnswer": 1,
      "decimalOperator": "equal",
      "dateOperator": "equal",
      "startDate": "2026-07-11T01:29:17.474Z",
      "endDate": "2026-07-11T01:29:17.474Z",
      "dateAnswer": "2026-07-11T01:29:17.474Z",
      "categories": [
        {
          "category": "text"
        }
      ]
    }
  ],
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

List prompts with answers.

get

Returns a page of prompts for a flow document collection, each with its answer in that collection.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdstring · uuidRequired

flowDocumentCollectionIdstring · uuidRequired

projectIdentifierstringRequired

Query parameters

parentObjectIdentifierstring · uuidOptional

pageinteger · int32OptionalDefault: 1

pageSizeinteger · int32OptionalDefault: 100

searchTermstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

OK

text/plainapplication/jsontext/json

totalCountinteger · int32Optional

pageinteger · int32Optional

pageSizeinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flows/{flowId}/flow-document-collections/{flowDocumentCollectionId}/prompts

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flows/{flowId}/flow-document-collections/{flowDocumentCollectionId}/prompts HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "page": 1,
  "pageSize": 1,
  "items": [
    {
      "prompt": {
        "dateAdded": "2026-07-11T01:29:17.474Z",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "description": "text",
        "promptDataType": "boolean",
        "conditionOperator": "and",
        "categories": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "colour": "primary"
          }
        ],
        "minimumValue": 1,
        "maximumValue": 1,
        "found": true,
        "hasChildren": true,
        "startDate": "2026-07-11T01:29:17.474Z",
        "endDate": "2026-07-11T01:29:17.474Z",
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "runStatus": "pending",
        "question": "text",
        "questionJson": {
          "type": "text",
          "content": [
            "[Circular Reference]"
          ]
        },
        "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "reasoningEffort": "none",
        "canEdit": true,
        "includeDocuments": true,
        "conditions": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "promptPredicate": {
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "label": "text",
              "promptDataType": "boolean"
            },
            "isYes": true,
            "fuzzyMatch": true,
            "minimumDecimalAnswer": 1,
            "maximumDecimalAnswer": 1,
            "textAnswer": "text",
            "allCategoriesMatch": true,
            "decimalAnswer": 1,
            "decimalOperator": "equal",
            "dateOperator": "equal",
            "startDate": "2026-07-11T01:29:17.474Z",
            "endDate": "2026-07-11T01:29:17.474Z",
            "dateAnswer": "2026-07-11T01:29:17.474Z",
            "categories": [
              {
                "category": "text"
              }
            ]
          }
        ],
        "resourceOwnerId": "text",
        "resourceOwner": {
          "name": "text",
          "id": "text",
          "email": "text",
          "picture": "text",
          "roles": [
            {
              "id": "text",
              "name": "text"
            }
          ]
        }
      },
      "answer": {
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "booleanAnswer": true,
        "textAnswer": "text",
        "decimalAnswer": 1,
        "dateAnswer": "2026-07-11T01:29:17.474Z",
        "assignedTo": "text",
        "reviewedBy": "text",
        "approved": true,
        "dateAdded": "2026-07-11T01:29:17.474Z",
        "assignedToMember": {
          "id": "text",
          "name": "text",
          "email": "text"
        },
        "reviewedByMember": {
          "id": "text",
          "name": "text",
          "email": "text"
        },
        "hasChildren": true,
        "approvedPromptCount": 1,
        "rejectedPromptCount": 1,
        "awaitingVerificationCount": 1,
        "prompt": {
          "dateAdded": "2026-07-11T01:29:17.474Z",
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "label": "text",
          "description": "text",
          "promptDataType": "boolean",
          "conditionOperator": "and",
          "categories": [
            {
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "colour": "primary"
            }
          ],
          "minimumValue": 1,
          "maximumValue": 1,
          "found": true,
          "hasChildren": true,
          "startDate": "2026-07-11T01:29:17.474Z",
          "endDate": "2026-07-11T01:29:17.474Z",
          "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "runStatus": "pending",
          "question": "text",
          "questionJson": {
            "type": "text",
            "content": [
              "[Circular Reference]"
            ]
          },
          "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "reasoningEffort": "none",
          "canEdit": true,
          "includeDocuments": true,
          "conditions": [
            {
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "promptPredicate": {
                "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
                "label": "text",
                "promptDataType": "boolean"
              },
              "isYes": true,
              "fuzzyMatch": true,
              "minimumDecimalAnswer": 1,
              "maximumDecimalAnswer": 1,
              "textAnswer": "text",
              "allCategoriesMatch": true,
              "decimalAnswer": 1,
              "decimalOperator": "equal",
              "dateOperator": "equal",
              "startDate": "2026-07-11T01:29:17.474Z",
              "endDate": "2026-07-11T01:29:17.474Z",
              "dateAnswer": "2026-07-11T01:29:17.474Z",
              "categories": [
                {
                  "category": "text"
                }
              ]
            }
          ],
          "resourceOwnerId": "text",
          "resourceOwner": {
            "name": "text",
            "id": "text",
            "email": "text",
            "picture": "text",
            "roles": [
              {
                "id": "text",
                "name": "text"
              }
            ]
          }
        },
        "promptAnswerCategories": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "category": {
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "colour": 1
            },
            "name": "text",
            "colour": 1,
            "evidence": [
              {
                "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
                "text": "text",
                "polygonPoints": [
                  1
                ],
                "pageNumber": 1,
                "quoteOnly": true,
                "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
                "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          }
        ],
        "evidence": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "text": "text",
            "polygonPoints": [
              1
            ],
            "pageNumber": 1,
            "quoteOnly": true,
            "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "conditionsNotMet": true
    }
  ]
}