Prompt Answer Category Evidence

Gets all prompt answer category evidence for the specified prompt answer category.

get

Retrieves a paginated list of all prompt answer category evidence for the specified prompt answer category, with optional search and sorting.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptAnswerCategoryObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer category.

playbookIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number for paginated results.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter results.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

OK

text/plainapplication/jsontext/json

quoteOnlybooleanOptional

textstring · nullableOptional

paragraphObjectIdentifierstring · uuid · nullableOptional

polygonPointsnumber · float[] · nullableOptional

pageNumberinteger · int32 · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

403

Forbidden

text/plainapplication/jsontext/json

get/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "quoteOnly": true,
    "text": "text",
    "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "polygonPoints": [
      1
    ],
    "pageNumber": 1,
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-07-11T01:56:44.178Z"
  }
]

Creates a new prompt answer category evidence for the specified prompt answer category.

post

Creates a new prompt answer category evidence for the specified prompt answer category.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptAnswerCategoryObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer category.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

quoteOnlybooleanOptional

textstring · nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

quoteOnlybooleanOptional

textstring · nullableOptional

paragraphObjectIdentifierstring · uuid · nullableOptional

polygonPointsnumber · float[] · nullableOptional

pageNumberinteger · int32 · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence

HTTPcURLJavaScriptPython

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

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

application/jsontext/jsonapplication/*+json

{
  "quoteOnly": true,
  "text": "text",
  "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "polygonPoints": [
    1
  ],
  "pageNumber": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-11T01:56:44.178Z"
}

Gets the details of a specific prompt answer category evidence by its object identifier.

get

Retrieves the details of a prompt answer category evidence using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the evidence.

playbookIdentifierstringRequired

promptAnswerCategoryObjectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

quoteOnlybooleanOptional

textstring · nullableOptional

paragraphObjectIdentifierstring · uuid · nullableOptional

polygonPointsnumber · float[] · nullableOptional

pageNumberinteger · int32 · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier}

HTTPcURLJavaScriptPython

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

{
  "quoteOnly": true,
  "text": "text",
  "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "polygonPoints": [
    1
  ],
  "pageNumber": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-11T01:56:44.178Z"
}

Updates an existing prompt answer category evidence by its object identifier.

put

Updates the details of an existing prompt answer category evidence using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the evidence to update.

playbookIdentifierstringRequired

promptAnswerCategoryObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

quoteOnlybooleanOptional

textstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

quoteOnlybooleanOptional

textstring · nullableOptional

paragraphObjectIdentifierstring · uuid · nullableOptional

polygonPointsnumber · float[] · nullableOptional

pageNumberinteger · int32 · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier}

HTTPcURLJavaScriptPython

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

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

application/jsontext/jsonapplication/*+json

{
  "quoteOnly": true,
  "text": "text",
  "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "polygonPoints": [
    1
  ],
  "pageNumber": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-11T01:56:44.178Z"
}

Deletes a prompt answer category evidence by its object identifier.

delete

Deletes a prompt answer category evidence using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the evidence to delete.

playbookIdentifierstringRequired

promptAnswerCategoryObjectIdentifierstringRequired

Responses

204

No Content

No content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier}

HTTPcURLJavaScriptPython

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

No content