Prompt Answer Category Evidence

Retrieves a paginated list of evidence entries for the specified prompt answer category.

get

Retrieves a paginated list of evidence entries for the specified prompt answer category, optionally filtered and sorted.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
promptAnswerCategoryObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer category.

projectIdentifierstringRequired
Query parameters
pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to prompt evidence entries.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:
descbooleanOptional

Whether to sort in descending order.

Default: true
Responses
200

OK

get
/projects/{projectIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence
GET /projects/{projectIdentifier}/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:02:48.011Z"
  }
]

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

post

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

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
promptAnswerCategoryObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer category.

projectIdentifierstringRequired
Body
quoteOnlybooleanOptional
textstring | nullableOptional
Responses
200

OK

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

{
  "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:02:48.011Z"
}

Retrieves an evidence entry by its object identifier.

get

Retrieves an evidence entry by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the evidence entry.

projectIdentifierstringRequired
promptAnswerCategoryObjectIdentifierstringRequired
Responses
200

OK

get
/projects/{projectIdentifier}/prompt-answer-categories/{promptAnswerCategoryObjectIdentifier}/evidence/{objectIdentifier}
GET /projects/{projectIdentifier}/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:02:48.011Z"
}

Updates an evidence entry by its object identifier.

put

Updates an evidence entry by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the evidence entry to update.

projectIdentifierstringRequired
promptAnswerCategoryObjectIdentifierstringRequired
Body
quoteOnlybooleanOptional
textstring | nullableOptional
Responses
200

OK

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

{
  "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:02:48.011Z"
}

Deletes an evidence entry by its object identifier.

delete

Deletes an evidence entry by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the evidence entry to delete.

projectIdentifierstringRequired
promptAnswerCategoryObjectIdentifierstringRequired
Responses
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
PreviousProjectsNextPrompt Answer Comments

Last updated