Prompt Answers

Gets all prompt answers for a document in a flow.

get

Retrieves all prompt answers for a document in a flow, optionally flattened or filtered by parent prompt.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The flow identifier.

documentObjectIdentifierstring · uuidRequired

The document object identifier.

playbookIdentifierstringRequired

Query parameters

flattenbooleanOptional

Whether to flatten the prompt answer tree.

parentPromptObjectIdentifierstring · uuidOptional

Optional parent prompt object identifier.

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/document/{documentObjectIdentifier}/prompt-answers

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/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:54:32.039Z",
    "dateAdded": "2025-12-06T03:54:32.039Z",
    "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:54:32.039Z",
            "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:54:32.039Z",
      "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:54:32.039Z",
      "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:54:32.039Z"
          }
        ]
      }
    ],
    "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:54:32.039Z"
      }
    ]
  }
]

Gets a prompt answer by prompt and document identifiers.

get

Retrieves a prompt answer by prompt and document identifiers for a flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The flow identifier.

playbookIdentifierstringRequired

Query parameters

promptObjectIdentifierstring · uuidOptional

The prompt object identifier.

documentObjectIdentifierstring · uuidOptional

The document object identifier.

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/prompt-answer/by-prompt-and-document

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/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:54:32.039Z",
  "dateAdded": "2025-12-06T03:54:32.039Z",
  "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:54:32.039Z",
          "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:54:32.039Z",
    "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:54:32.039Z",
    "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:54:32.039Z"
        }
      ]
    }
  ],
  "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:54:32.039Z"
    }
  ]
}

Gets a prompt answer by its object identifier.

get

Retrieves a prompt answer by its object identifier for a flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the prompt answer.

playbookIdentifierstringRequired

flowIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/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:54:32.039Z",
  "dateAdded": "2025-12-06T03:54:32.039Z",
  "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:54:32.039Z",
          "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:54:32.039Z",
    "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:54:32.039Z",
    "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:54:32.039Z"
        }
      ]
    }
  ],
  "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:54:32.039Z"
    }
  ]
}

Updates an existing prompt answer.

put

Updates the details of an existing prompt answer for a flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the prompt answer.

playbookIdentifierstringRequired

flowIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

failedToAnswerboolean | nullableOptional

contextLengthExceededboolean | nullableOptional

approvedboolean | nullableOptional

assignedTostring | nullableOptional

reviewedBystring | nullableOptional

decimalAnswernumber · double | nullableOptional

booleanAnswerboolean | nullableOptional

textAnswerstring | nullableOptional

quotestring | nullableOptional

reviewedDatestring · date-time | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /playbooks/{playbookIdentifier}/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:54:32.039Z"
}

application/jsontext/jsonapplication/*+json

{
  "failedToAnswer": true,
  "contextLengthExceeded": true,
  "approved": true,
  "assignedTo": "text",
  "reviewedBy": "text",
  "decimalAnswer": 1,
  "booleanAnswer": true,
  "textAnswer": "text",
  "quote": "text",
  "reviewedDate": "2025-12-06T03:54:32.039Z",
  "dateAdded": "2025-12-06T03:54:32.039Z",
  "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:54:32.039Z",
          "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:54:32.039Z",
    "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:54:32.039Z",
    "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:54:32.039Z"
        }
      ]
    }
  ],
  "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:54:32.039Z"
    }
  ]
}

Deletes a prompt answer by its object identifier.

delete

Deletes a prompt answer for a flow using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the prompt answer to delete.

playbookIdentifierstringRequired

flowIdentifierstringRequired

Responses

204

No Content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}

HTTPcURLJavaScriptPython

DELETE /playbooks/{playbookIdentifier}/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.

patch

Updates the status of a prompt answer for a flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the prompt answer.

playbookIdentifierstringRequired

flowIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

booleanOptional

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

patch

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}/status

HTTPcURLJavaScriptPython

PATCH /playbooks/{playbookIdentifier}/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

application/jsontext/jsonapplication/*+json

No content

Assigns a prompt answer to a user.

post

Assigns a prompt answer to a user for a flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The flow identifier.

objectIdentifierstring · uuidRequired

The object identifier of the prompt answer.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

stringOptional

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}/assign-to-user

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/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"

application/jsontext/jsonapplication/*+json

No content

Adds categories to a prompt answer.

post

Adds categories to a prompt answer for a flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptAnswerObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer.

playbookIdentifierstringRequired

flowIdentifierstringRequired

Bodystring · uuid[]

application/jsontext/jsonapplication/*+json

string · uuid[]Optional

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/categories

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/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"
]

application/jsontext/jsonapplication/*+json

No content

Removes a category from a prompt answer.

delete

Removes a category from a prompt answer for a flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptAnswerObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer.

categoryObjectIdentifierstring · uuidRequired

The object identifier of the category to remove.

playbookIdentifierstringRequired

flowIdentifierstringRequired

Responses

200

OK

No content

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/categories/{categoryObjectIdentifier}

HTTPcURLJavaScriptPython

DELETE /playbooks/{playbookIdentifier}/flows/{flowIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/categories/{categoryObjectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content