Filter Categories

Gets all prompt categories for the specified prompt.

get

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptObjectIdentifierstring · uuidRequired

The object identifier of the prompt.

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

text/plainapplication/jsontext/json

namestring · nullableRequired

colourinteger · enumOptionalPossible values:

objectIdentifierstring · uuidOptional

colourHexstring · nullableRead-onlyOptional

403

Forbidden

text/plainapplication/jsontext/json

get/playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories

HTTPcURLJavaScriptPython

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.

post

Creates a new prompt category for the specified prompt.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptObjectIdentifierstring · uuidRequired

The object identifier of the prompt.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

colourinteger · enumOptionalPossible values:

Responses

201

Created

text/plainapplication/jsontext/json

namestring · nullableRequired

colourinteger · enumOptionalPossible values:

objectIdentifierstring · uuidOptional

colourHexstring · nullableRead-onlyOptional

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories

HTTPcURLJavaScriptPython

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
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "colour": 0,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "colourHex": "text"
}

Gets the details of a specific prompt category by its object identifier.

get

Retrieves the details of a prompt category using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the prompt category.

playbookIdentifierstringRequired

promptObjectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

colourinteger · enumOptionalPossible values:

objectIdentifierstring · uuidOptional

colourHexstring · nullableRead-onlyOptional

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get/playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier}

HTTPcURLJavaScriptPython

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 an existing prompt category by its object identifier.

put

Updates the details of an existing prompt category using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the prompt category to update.

playbookIdentifierstringRequired

promptObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

colourinteger · enumOptionalPossible values:

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

colourinteger · enumOptionalPossible values:

objectIdentifierstring · uuidOptional

colourHexstring · nullableRead-onlyOptional

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put/playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier}

HTTPcURLJavaScriptPython

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
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "colour": 0,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "colourHex": "text"
}

Deletes a prompt category by its object identifier.

delete

Deletes a prompt category using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the prompt category to delete.

playbookIdentifierstringRequired

promptObjectIdentifierstringRequired

Responses

204

No Content

No content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete/playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier}

HTTPcURLJavaScriptPython

DELETE /playbooks/{playbookIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content