Filter Categories
Retrieves a paginated list of all prompt categories for the specified prompt, with optional search and sorting.
Bearer authentication with JWT
The object identifier of the prompt.
The page number for paginated results.
The number of items per page.
Optional search text to filter results.
The sorting option for the results.
Whether to sort in descending order.
trueOK
Forbidden
GET /playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}
]Creates a new prompt category for the specified prompt.
Bearer authentication with JWT
The object identifier of the prompt.
Created
Bad Request
Forbidden
POST /playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"name": "text",
"colour": 0
}{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}Retrieves the details of a prompt category using its object identifier.
Bearer authentication with JWT
The object identifier of the prompt category.
OK
Forbidden
Not Found
GET /playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}Updates the details of an existing prompt category using its object identifier.
Bearer authentication with JWT
The object identifier of the prompt category to update.
OK
Bad Request
Forbidden
Not Found
PUT /playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"name": "text",
"colour": 0
}{
"name": "text",
"colour": 0,
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"colourHex": "text"
}Deletes a prompt category using its object identifier.
Bearer authentication with JWT
The object identifier of the prompt category to delete.
No Content
Forbidden
Not Found
DELETE /playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated