Prompt Answer Comments

Retrieves a paginated list of comments for the specified prompt answer.

get

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

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
promptAnswerObjectIdentifierstring · uuidRequired

The object identifier of the prompt answer.

projectIdentifierstringRequired
Query parameters
pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to prompt comments.

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/{promptAnswerObjectIdentifier}/comments
GET /projects/{projectIdentifier}/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-06T03:54:32.848Z",
    "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.

projectIdentifierstringRequired
Body
commentstring | nullableRequired
Responses
200

OK

post
/projects/{projectIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments
POST /projects/{projectIdentifier}/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-06T03:54:32.848Z",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Retrieves a comment by its object identifier.

get

Retrieves a comment by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the comment.

projectIdentifierstringRequired
promptAnswerObjectIdentifierstringRequired
Responses
200

OK

get
/projects/{projectIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments/{objectIdentifier}
GET /projects/{projectIdentifier}/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-06T03:54:32.848Z",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Updates a comment by its object identifier.

put

Updates a comment by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the comment to update.

projectIdentifierstringRequired
promptAnswerObjectIdentifierstringRequired
Body
commentstring | nullableRequired
Responses
200

OK

put
/projects/{projectIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/comments/{objectIdentifier}
PUT /projects/{projectIdentifier}/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-06T03:54:32.848Z",
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  }
}

Deletes a comment by its object identifier.

delete

Deletes a comment by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the comment to delete.

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

No content

Last updated