Prompt Answers

Add evidence to a prompt answer category.

post

Creates a manual quote evidence entry against a prompt answer category and returns the created record.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptAnswerCategoryObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

textstring · nullableOptional

quoteOnlybooleanOptional

Responses

201

Created

objectIdentifierstring · uuidOptional

textstring · nullableOptional

polygonPointsnumber · float[] · nullableOptional

pageNumberinteger · int32 · nullableOptional

quoteOnlybooleanOptional

paragraphObjectIdentifierstring · uuid · nullableOptional

documentObjectIdentifierstring · uuid · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

post/projects/{projectIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence

POST /projects/{projectIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "text": "text",
  "quoteOnly": true
}

{
  "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"
}

Update a prompt answer category's evidence entry.

put

Edits the quote text of an existing category evidence entry and returns the updated record.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptAnswerCategoryObjectIdentifierstring · uuidRequired

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

textstring · nullableOptional

quoteOnlybooleanOptional

Responses

200

objectIdentifierstring · uuidOptional

textstring · nullableOptional

polygonPointsnumber · float[] · nullableOptional

pageNumberinteger · int32 · nullableOptional

quoteOnlybooleanOptional

paragraphObjectIdentifierstring · uuid · nullableOptional

documentObjectIdentifierstring · uuid · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

put/projects/{projectIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier}

PUT /projects/{projectIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "text": "text",
  "quoteOnly": true
}

{
  "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"
}

Delete a prompt answer category's evidence entry.

delete

Permanently removes an evidence entry from a prompt answer category. This cannot be undone.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptAnswerCategoryObjectIdentifierstring · uuidRequired

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

403

Forbidden

404

Not Found

delete/projects/{projectIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier}

DELETE /projects/{projectIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get a prompt answer.

get

Returns a single prompt answer in the project, identified by its GUID, including its value, status, and assignment.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

objectIdentifierstring · uuidOptional

booleanAnswerboolean · nullableOptional

textAnswerstring · nullableOptional

decimalAnswernumber · double · nullableOptional

dateAnswerstring · date-time · nullableOptional

assignedTostring · nullableOptional

reviewedBystring · nullableOptional

approvedboolean · nullableOptional

dateAddedstring · date-timeOptional

hasChildrenbooleanOptional

approvedPromptCountinteger · int32Optional

rejectedPromptCountinteger · int32Optional

awaitingVerificationCountinteger · int32Optional

401

Unauthorized

403

Forbidden

404

Not Found

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

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

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "booleanAnswer": true,
  "textAnswer": "text",
  "decimalAnswer": 1,
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "assignedTo": "text",
  "reviewedBy": "text",
  "approved": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "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-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
    "endDate": "2026-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
        "endDate": "2026-01-01T00:00:00.000Z",
        "dateAnswer": "2026-01-01T00:00:00.000Z",
        "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"
    }
  ]
}

Update a prompt answer.

put

Updates the stored value, assignment, and approval state of an existing prompt answer and returns the updated record.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

booleanAnswerboolean · nullableOptional

textAnswerstring · nullableOptional

decimalAnswernumber · double · nullableOptional

dateAnswerstring · date-time · nullableOptional

assignedTostring · nullableOptional

approvedboolean · nullableOptional

Responses

200

objectIdentifierstring · uuidOptional

booleanAnswerboolean · nullableOptional

textAnswerstring · nullableOptional

decimalAnswernumber · double · nullableOptional

dateAnswerstring · date-time · nullableOptional

assignedTostring · nullableOptional

reviewedBystring · nullableOptional

approvedboolean · nullableOptional

dateAddedstring · date-timeOptional

hasChildrenbooleanOptional

approvedPromptCountinteger · int32Optional

rejectedPromptCountinteger · int32Optional

awaitingVerificationCountinteger · int32Optional

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

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

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

{
  "booleanAnswer": true,
  "textAnswer": "text",
  "decimalAnswer": 1,
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "assignedTo": "text",
  "approved": true
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "booleanAnswer": true,
  "textAnswer": "text",
  "decimalAnswer": 1,
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "assignedTo": "text",
  "reviewedBy": "text",
  "approved": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "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-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
    "endDate": "2026-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
        "endDate": "2026-01-01T00:00:00.000Z",
        "dateAnswer": "2026-01-01T00:00:00.000Z",
        "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"
    }
  ]
}

Delete a prompt answer.

delete

Permanently removes a prompt answer from the project. This cannot be undone.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

403

Forbidden

404

Not Found

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

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

No content

List prompt answers for a document collection.

get

Returns the prompt answers generated for a flow document collection, with optional filtering by prompt or parent prompt and an option to flatten the result.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowDocumentCollectionObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Query parameters

promptObjectIdentifierstring · uuidOptional

flattenbooleanOptional

parentPromptObjectIdentifierstring · uuidOptional

includePromptbooleanOptionalDefault: false

Responses

200

objectIdentifierstring · uuidOptional

booleanAnswerboolean · nullableOptional

textAnswerstring · nullableOptional

decimalAnswernumber · double · nullableOptional

dateAnswerstring · date-time · nullableOptional

assignedTostring · nullableOptional

reviewedBystring · nullableOptional

approvedboolean · nullableOptional

dateAddedstring · date-timeOptional

hasChildrenbooleanOptional

approvedPromptCountinteger · int32Optional

rejectedPromptCountinteger · int32Optional

awaitingVerificationCountinteger · int32Optional

401

Unauthorized

403

Forbidden

get/projects/{projectIdentifier}/flow-document-collections/{flowDocumentCollectionObjectIdentifier}/prompt-answers

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

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "booleanAnswer": true,
    "textAnswer": "text",
    "decimalAnswer": 1,
    "dateAnswer": "2026-01-01T00:00:00.000Z",
    "assignedTo": "text",
    "reviewedBy": "text",
    "approved": true,
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
      "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-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "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-01-01T00:00:00.000Z",
          "endDate": "2026-01-01T00:00:00.000Z",
          "dateAnswer": "2026-01-01T00:00:00.000Z",
          "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"
      }
    ]
  }
]

Update a prompt answer's status.

patch

Changes the workflow status of a prompt answer without altering its value, and returns the updated record.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

statusboolean · nullableOptional

resourceOwnerstring · nullableOptional

Responses

200

objectIdentifierstring · uuidOptional

booleanAnswerboolean · nullableOptional

textAnswerstring · nullableOptional

decimalAnswernumber · double · nullableOptional

dateAnswerstring · date-time · nullableOptional

assignedTostring · nullableOptional

reviewedBystring · nullableOptional

approvedboolean · nullableOptional

dateAddedstring · date-timeOptional

hasChildrenbooleanOptional

approvedPromptCountinteger · int32Optional

rejectedPromptCountinteger · int32Optional

awaitingVerificationCountinteger · int32Optional

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

patch/projects/{projectIdentifier}/prompt-answers/{objectIdentifier}/status

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

{
  "status": true,
  "resourceOwner": "text"
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "booleanAnswer": true,
  "textAnswer": "text",
  "decimalAnswer": 1,
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "assignedTo": "text",
  "reviewedBy": "text",
  "approved": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "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-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
    "endDate": "2026-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
        "endDate": "2026-01-01T00:00:00.000Z",
        "dateAnswer": "2026-01-01T00:00:00.000Z",
        "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"
    }
  ]
}

Add evidence to a prompt answer.

post

Creates a manual quote evidence entry against a prompt answer and returns the created record.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

textstring · nullableOptional

quoteOnlybooleanOptional

Responses

201

Created

objectIdentifierstring · uuidOptional

textstring · nullableOptional

polygonPointsnumber · float[] · nullableOptional

pageNumberinteger · int32 · nullableOptional

quoteOnlybooleanOptional

paragraphObjectIdentifierstring · uuid · nullableOptional

documentObjectIdentifierstring · uuid · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

post/projects/{projectIdentifier}/prompt-answers/{objectIdentifier}/evidence

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

{
  "text": "text",
  "quoteOnly": true
}

{
  "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"
}

Update a prompt answer's evidence entry.

put

Edits the quote text of an existing evidence entry and returns the updated record.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

evidenceObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

textstring · nullableOptional

quoteOnlybooleanOptional

Responses

200

objectIdentifierstring · uuidOptional

textstring · nullableOptional

polygonPointsnumber · float[] · nullableOptional

pageNumberinteger · int32 · nullableOptional

quoteOnlybooleanOptional

paragraphObjectIdentifierstring · uuid · nullableOptional

documentObjectIdentifierstring · uuid · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

put/projects/{projectIdentifier}/prompt-answers/{objectIdentifier}/evidence/{evidenceObjectIdentifier}

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

{
  "text": "text",
  "quoteOnly": true
}

{
  "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"
}

Delete a prompt answer's evidence entry.

delete

Permanently removes an evidence entry from a prompt answer. This cannot be undone.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

evidenceObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

403

Forbidden

404

Not Found

delete/projects/{projectIdentifier}/prompt-answers/{objectIdentifier}/evidence/{evidenceObjectIdentifier}

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

No content

Assign a prompt answer to a user.

patch

Assigns a prompt answer to the specified user and returns the updated record.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

assignedTostring · nullableOptional

Responses

200

objectIdentifierstring · uuidOptional

booleanAnswerboolean · nullableOptional

textAnswerstring · nullableOptional

decimalAnswernumber · double · nullableOptional

dateAnswerstring · date-time · nullableOptional

assignedTostring · nullableOptional

reviewedBystring · nullableOptional

approvedboolean · nullableOptional

dateAddedstring · date-timeOptional

hasChildrenbooleanOptional

approvedPromptCountinteger · int32Optional

rejectedPromptCountinteger · int32Optional

awaitingVerificationCountinteger · int32Optional

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

patch/projects/{projectIdentifier}/prompt-answers/{objectIdentifier}/assigned-to

PATCH /projects/{projectIdentifier}/prompt-answers/{objectIdentifier}/assigned-to HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "assignedTo": "text"
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "booleanAnswer": true,
  "textAnswer": "text",
  "decimalAnswer": 1,
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "assignedTo": "text",
  "reviewedBy": "text",
  "approved": true,
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "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-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
    "endDate": "2026-01-01T00:00:00.000Z",
    "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-01-01T00:00:00.000Z",
        "endDate": "2026-01-01T00:00:00.000Z",
        "dateAnswer": "2026-01-01T00:00:00.000Z",
        "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"
    }
  ]
}

Attach categories to a prompt answer.

post

Attaches one or more existing prompt categories to a Categories-type prompt answer and returns the created links.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Bodystring · uuid[]

string · uuid[]Optional

Responses

200

objectIdentifierstring · uuidOptional

namestring · nullableOptional

colourinteger · int32 · nullableOptional

401

Unauthorized

403

Forbidden

404

Not Found

post/projects/{projectIdentifier}/prompt-answers/{objectIdentifier}/categories

POST /projects/{projectIdentifier}/prompt-answers/{objectIdentifier}/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"
]

[
  {
    "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"
      }
    ]
  }
]

Detach a category from a prompt answer.

delete

Removes a single category link from a prompt answer. This cannot be undone.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

promptAnswerCategoryObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

403

Forbidden

404

Not Found

delete/projects/{projectIdentifier}/prompt-answers/{objectIdentifier}/categories/{promptAnswerCategoryObjectIdentifier}

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

No content

PreviousProjects NextPrompt Categories

Last updated 3 days ago