Prompt Categories

Query prompt categories.

get

Supports non-CRUD reads, such as finding an unused category colour for a prompt.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

promptObjectIdentifierstring · uuidOptional

unusedColourbooleanOptionalDefault: false

Responses

200

OK

text/plainapplication/jsontext/json

string · enumOptionalPossible values:

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/prompt-categories

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/prompt-categories HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

primary

Create a prompt category.

post

Creates a new named, coloured prompt category within the specified project.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableOptional

colourstring · enumOptionalPossible values:

promptObjectIdentifierstring · uuidOptional

resourceOwnerIdstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

colourstring · enumRequiredPossible values:

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/projects/{projectIdentifier}/prompt-categories

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/prompt-categories HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "name": "text",
  "colour": "primary",
  "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "resourceOwnerId": "text"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "colour": "primary"
}

Get a prompt category by id.

get

Returns the prompt category identified by its GUID within the specified project.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

colourstring · enumRequiredPossible values:

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/prompt-categories/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/prompt-categories/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "colour": "primary"
}

Update a prompt category.

put

Updates the name and colour of an existing prompt category in the project.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableOptional

colourstring · enumOptionalPossible values:

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

colourstring · enumRequiredPossible values:

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

put/projects/{projectIdentifier}/prompt-categories/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /projects/{projectIdentifier}/prompt-categories/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "name": "text",
  "colour": "primary"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "colour": "primary"
}

Delete a prompt category.

delete

Permanently removes the specified prompt category from the project.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

delete/projects/{projectIdentifier}/prompt-categories/{objectIdentifier}

HTTPcURLJavaScriptPython

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

No content