Prompt Answers
Retrieves all prompt answers for a document in the specified flow.
Bearer authentication with JWT
The unique identifier of the flow.
The unique identifier of the document.
Whether to flatten the prompt answer structure.
Optional parent prompt object identifier.
OK
Forbidden
GET /projects/{projectIdentifier}/flows/{flowIdentifier}/document/{documentObjectIdentifier}/prompt-answers HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"failedToAnswer": true,
"contextLengthExceeded": true,
"approved": true,
"assignedTo": "text",
"reviewedBy": "text",
"decimalAnswer": 1,
"booleanAnswer": true,
"textAnswer": "text",
"quote": "text",
"reviewedDate": "2025-12-06T03:43:35.884Z",
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"prompt": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": [
{
"fuzzyMatch": true,
"isYes": true,
"minimumDecimalAnswer": 1,
"maximumDecimalAnswer": 1,
"decimalOperator": "Equal",
"decimalAnswer": 1,
"textAnswer": "text",
"promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"fuzzyMatch": true,
"text": "text"
}
],
"allCategoriesMatch": true,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptPredicate": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": "[Circular Reference]",
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
}
}
],
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
},
"document": {
"name": "text",
"parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"isDirectory": true,
"documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"contentType": "text",
"size": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z",
"uploadSuccessful": true,
"tokenCount": 1,
"metadataTokenCount": 1,
"unsupportedFileType": true,
"unPackingComplete": true,
"unPackingFailed": true,
"uploadInProgress": true,
"url": "text",
"hasChildren": true,
"resourceOwner": {
"email": "text",
"name": "text",
"id": "text"
}
},
"reviewedByMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"assignedToMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"hasChildren": true,
"checkIsFlowWideAssemblyAnswer": true,
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"promptAnswerCategories": [
{
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"category": {
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
},
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}
],
"flowWideAssemblyAnswer": true,
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}
]Retrieves a prompt answer for a document and prompt in the specified flow.
Bearer authentication with JWT
The unique identifier of the flow.
The unique identifier of the prompt.
The unique identifier of the document.
OK
Forbidden
Not Found
GET /projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/by-prompt-and-document HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"failedToAnswer": true,
"contextLengthExceeded": true,
"approved": true,
"assignedTo": "text",
"reviewedBy": "text",
"decimalAnswer": 1,
"booleanAnswer": true,
"textAnswer": "text",
"quote": "text",
"reviewedDate": "2025-12-06T03:43:35.884Z",
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"prompt": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": [
{
"fuzzyMatch": true,
"isYes": true,
"minimumDecimalAnswer": 1,
"maximumDecimalAnswer": 1,
"decimalOperator": "Equal",
"decimalAnswer": 1,
"textAnswer": "text",
"promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"fuzzyMatch": true,
"text": "text"
}
],
"allCategoriesMatch": true,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptPredicate": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": [
"[Circular Reference]"
],
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
}
}
],
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
},
"document": {
"name": "text",
"parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"isDirectory": true,
"documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"contentType": "text",
"size": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z",
"uploadSuccessful": true,
"tokenCount": 1,
"metadataTokenCount": 1,
"unsupportedFileType": true,
"unPackingComplete": true,
"unPackingFailed": true,
"uploadInProgress": true,
"url": "text",
"hasChildren": true,
"resourceOwner": {
"email": "text",
"name": "text",
"id": "text"
}
},
"reviewedByMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"assignedToMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"hasChildren": true,
"checkIsFlowWideAssemblyAnswer": true,
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"promptAnswerCategories": [
{
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"category": {
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
},
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}
],
"flowWideAssemblyAnswer": true,
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}Retrieves a prompt answer by its object identifier.
Bearer authentication with JWT
The unique identifier of the prompt answer.
OK
Forbidden
Not Found
GET /projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"failedToAnswer": true,
"contextLengthExceeded": true,
"approved": true,
"assignedTo": "text",
"reviewedBy": "text",
"decimalAnswer": 1,
"booleanAnswer": true,
"textAnswer": "text",
"quote": "text",
"reviewedDate": "2025-12-06T03:43:35.884Z",
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"prompt": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": [
{
"fuzzyMatch": true,
"isYes": true,
"minimumDecimalAnswer": 1,
"maximumDecimalAnswer": 1,
"decimalOperator": "Equal",
"decimalAnswer": 1,
"textAnswer": "text",
"promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"fuzzyMatch": true,
"text": "text"
}
],
"allCategoriesMatch": true,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptPredicate": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": [
"[Circular Reference]"
],
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
}
}
],
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
},
"document": {
"name": "text",
"parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"isDirectory": true,
"documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"contentType": "text",
"size": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z",
"uploadSuccessful": true,
"tokenCount": 1,
"metadataTokenCount": 1,
"unsupportedFileType": true,
"unPackingComplete": true,
"unPackingFailed": true,
"uploadInProgress": true,
"url": "text",
"hasChildren": true,
"resourceOwner": {
"email": "text",
"name": "text",
"id": "text"
}
},
"reviewedByMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"assignedToMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"hasChildren": true,
"checkIsFlowWideAssemblyAnswer": true,
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"promptAnswerCategories": [
{
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"category": {
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
},
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}
],
"flowWideAssemblyAnswer": true,
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}Updates a prompt answer by its object identifier.
Bearer authentication with JWT
The unique identifier of the prompt answer to update.
OK
Bad Request
Forbidden
Not Found
PUT /projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 224
{
"failedToAnswer": true,
"contextLengthExceeded": true,
"approved": true,
"assignedTo": "text",
"reviewedBy": "text",
"decimalAnswer": 1,
"booleanAnswer": true,
"textAnswer": "text",
"quote": "text",
"reviewedDate": "2025-12-06T03:43:35.884Z"
}{
"failedToAnswer": true,
"contextLengthExceeded": true,
"approved": true,
"assignedTo": "text",
"reviewedBy": "text",
"decimalAnswer": 1,
"booleanAnswer": true,
"textAnswer": "text",
"quote": "text",
"reviewedDate": "2025-12-06T03:43:35.884Z",
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"prompt": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": [
{
"fuzzyMatch": true,
"isYes": true,
"minimumDecimalAnswer": 1,
"maximumDecimalAnswer": 1,
"decimalOperator": "Equal",
"decimalAnswer": 1,
"textAnswer": "text",
"promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"fuzzyMatch": true,
"text": "text"
}
],
"allCategoriesMatch": true,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptPredicate": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": [
"[Circular Reference]"
],
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
}
}
],
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
},
"document": {
"name": "text",
"parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"isDirectory": true,
"documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"contentType": "text",
"size": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z",
"uploadSuccessful": true,
"tokenCount": 1,
"metadataTokenCount": 1,
"unsupportedFileType": true,
"unPackingComplete": true,
"unPackingFailed": true,
"uploadInProgress": true,
"url": "text",
"hasChildren": true,
"resourceOwner": {
"email": "text",
"name": "text",
"id": "text"
}
},
"reviewedByMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"assignedToMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"hasChildren": true,
"checkIsFlowWideAssemblyAnswer": true,
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"promptAnswerCategories": [
{
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"category": {
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
},
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}
],
"flowWideAssemblyAnswer": true,
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}Deletes a prompt answer by its object identifier.
Bearer authentication with JWT
The unique identifier of the prompt answer to delete.
No Content
Forbidden
Not Found
DELETE /projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Updates the status of a prompt answer by its object identifier.
Bearer authentication with JWT
The unique identifier of the prompt answer.
OK
Bad Request
Forbidden
Not Found
PATCH /projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}/status HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4
true{
"failedToAnswer": true,
"contextLengthExceeded": true,
"approved": true,
"assignedTo": "text",
"reviewedBy": "text",
"decimalAnswer": 1,
"booleanAnswer": true,
"textAnswer": "text",
"quote": "text",
"reviewedDate": "2025-12-06T03:43:35.884Z",
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"prompt": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": [
{
"fuzzyMatch": true,
"isYes": true,
"minimumDecimalAnswer": 1,
"maximumDecimalAnswer": 1,
"decimalOperator": "Equal",
"decimalAnswer": 1,
"textAnswer": "text",
"promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"fuzzyMatch": true,
"text": "text"
}
],
"allCategoriesMatch": true,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptPredicate": {
"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",
"filterDataTypeId": 1,
"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",
"filterDataTypeId": 1,
"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": [
"[Circular Reference]"
],
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
}
}
],
"promptDataTypeId": 1,
"dateAdded": "2025-12-06T03:43:35.884Z",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"minimumValue": 1,
"maximumValue": 1,
"found": true,
"hasChildren": true
},
"document": {
"name": "text",
"parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"isDirectory": true,
"documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"contentType": "text",
"size": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z",
"uploadSuccessful": true,
"tokenCount": 1,
"metadataTokenCount": 1,
"unsupportedFileType": true,
"unPackingComplete": true,
"unPackingFailed": true,
"uploadInProgress": true,
"url": "text",
"hasChildren": true,
"resourceOwner": {
"email": "text",
"name": "text",
"id": "text"
}
},
"reviewedByMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"assignedToMember": {
"email": "text",
"name": "text",
"resourceOwnerId": "text"
},
"hasChildren": true,
"checkIsFlowWideAssemblyAnswer": true,
"categories": [
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
],
"promptAnswerCategories": [
{
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"category": {
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
},
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}
],
"flowWideAssemblyAnswer": true,
"evidence": [
{
"quoteOnly": true,
"text": "text",
"paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"polygonPoints": [
1
],
"pageNumber": 1,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T03:43:35.884Z"
}
]
}Assigns a prompt answer to a user.
Bearer authentication with JWT
The unique identifier of the flow.
The unique identifier of the prompt answer.
No Content
Bad Request
Forbidden
Not Found
POST /projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}/assign-to-user HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"No content
Adds categories to a prompt answer.
Bearer authentication with JWT
The unique identifier of the prompt answer.
No Content
Bad Request
Forbidden
Not Found
POST /projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/categories HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
[
"123e4567-e89b-12d3-a456-426614174000"
]No content
Removes a category from a prompt answer.
Bearer authentication with JWT
The unique identifier of the prompt answer.
The unique identifier of the category to remove.
No Content
Bad Request
Forbidden
Not Found
DELETE /projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/categories/{categoryObjectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated