v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
Tiers

Retrieves multiple tiers.

get/api/v1/tiers

Query parameters

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

pageNumbernumber

The page number.

The page number.

pageSizenumber

The page size.

The page size.

searchstring

Search term to filter tiers by name or description.

Search term to filter tiers by name or description.

Headers

authorizationstring required

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Response

Retrieves all tiers for the workspace.

createdAtstring date-time required
idstring uuid required

A UUID v4 string that identifies an entity.

updatedAtstring date-time required
descriptionstring required

A description of the tier.

maxAssistantMessagesinteger nullable required

The maximum number of assistant messages allowed for this tier.

namestring required

The name of the tier.

promptstring nullable required

The prompt associated with the tier to be injected into the agent.

workspaceIdstring uuid required

The ID of the workspace this tier belongs to.