Prompt Answer Comments

Gets all comments for the specified prompt answer.

get

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

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
promptAnswerObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer.

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/{promptAnswerObjectIdentifier}/comments
GET /playbooks/{playbookIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "comment": "text",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2025-12-06T04:16:57.873Z",
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    }
  }
]

Creates a new comment for the specified prompt answer.

post

Creates a new comment for the specified prompt answer.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
promptAnswerObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer.

playbookIdentifierstringRequired
Body
commentstring | nullableRequired
Responses
post
/playbooks/{playbookIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments
POST /playbooks/{playbookIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "comment": "text"
}
{
  "comment": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:16:57.873Z",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Gets the details of a specific comment by its object identifier.

get

Retrieves the details of a comment for the specified prompt answer using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the comment.

playbookIdentifierstringRequired
promptAnswerObjectIdentifierstringRequired
Responses
200

OK

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

{
  "comment": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:16:57.873Z",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Updates an existing comment by its object identifier.

put

Updates the details of an existing comment for the specified prompt answer using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the comment to update.

playbookIdentifierstringRequired
promptAnswerObjectIdentifierstringRequired
Body
commentstring | nullableRequired
Responses
200

OK

put
/playbooks/{playbookIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments/{objectIdentifier}
PUT /playbooks/{playbookIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "comment": "text"
}
{
  "comment": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:16:57.873Z",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Deletes a comment by its object identifier.

delete

Deletes a comment for the specified prompt answer using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the comment to delete.

playbookIdentifierstringRequired
promptAnswerObjectIdentifierstringRequired
Responses
delete
/playbooks/{playbookIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments/{objectIdentifier}
DELETE /playbooks/{playbookIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousPrompt Answer Category EvidenceNextPrompt Answer Evidence

Last updated