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
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

get
/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence
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": "2025-12-06T04:07:51.966Z"
  }
]

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
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
promptAnswerCategoryObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer category.

playbookIdentifierstringRequired
Body
quoteOnlybooleanOptional
textstring | nullableOptional
Responses
post
/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence
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"
}
{
  "quoteOnly": true,
  "text": "text",
  "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "polygonPoints": [
    1
  ],
  "pageNumber": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:07:51.966Z"
}

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
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the evidence.

playbookIdentifierstringRequired
promptAnswerCategoryObjectIdentifierstringRequired
Responses
200

OK

get
/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier}
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": "2025-12-06T04:07:51.966Z"
}

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
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the evidence to update.

playbookIdentifierstringRequired
promptAnswerCategoryObjectIdentifierstringRequired
Body
quoteOnlybooleanOptional
textstring | nullableOptional
Responses
200

OK

put
/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier}
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"
}
{
  "quoteOnly": true,
  "text": "text",
  "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "polygonPoints": [
    1
  ],
  "pageNumber": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:07:51.966Z"
}

Deletes a prompt answer category evidence by its object identifier.

delete

Deletes a prompt answer category evidence using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the evidence to delete.

playbookIdentifierstringRequired
promptAnswerCategoryObjectIdentifierstringRequired
Responses
delete
/playbooks/{playbookIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier}
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
PreviousPlaybooksNextPrompt Answer Comments

Last updated