Prompt Categories

Retrieves a paginated list of prompt categories for the specified prompt.

get

Retrieves a paginated list of prompt categories for the specified prompt, optionally prompted and sorted.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

promptObjectIdentifierstring · uuidRequired

The object identifier of the prompt.

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to prompt categories.

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

403

Forbidden

text/plainapplication/jsontext/json

get

/projects/{projectIdentifier}/prompts/{promptObjectIdentifier}/categories

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/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.

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

colourinteger · enumOptionalPossible values:

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/projects/{projectIdentifier}/prompts/{promptObjectIdentifier}/categories

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/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"
}

Retrieves a prompt category by its object identifier.

get

Retrieves a prompt category by its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the prompt category.

projectIdentifierstringRequired

promptObjectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/projects/{projectIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/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 a prompt category by its object identifier.

put

Updates a prompt category by its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the prompt category to update.

projectIdentifierstringRequired

promptObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

colourinteger · enumOptionalPossible values:

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put

/projects/{projectIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /projects/{projectIdentifier}/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 by its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the prompt category to delete.

projectIdentifierstringRequired

promptObjectIdentifierstringRequired

Responses

204

No Content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete

/projects/{projectIdentifier}/prompts/{promptObjectIdentifier}/categories/{objectIdentifier}

HTTPcURLJavaScriptPython

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

No content