Skip to main content
PUT
/
v1
/
models
/
{model_id}
/
categories
/
{id}
Update an existing category
curl --request PUT \
  --url https://api.example.com/v1/models/{model_id}/categories/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Opening",
  "description": "Evaluation criteria for call opening and greeting",
  "max_score": 100,
  "order_number": 1
}
'
{
  "id": 1,
  "client_prompt_template_id": 1,
  "name": "Opening",
  "slug": "opening",
  "description": "Evaluation criteria for call opening",
  "max_score": 100,
  "order_number": 1,
  "enabled": true,
  "created_at": "2026-01-11T10:00:00Z",
  "created_by": "client_abc123"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
model_id
integer
required

The analysis model ID

​
id
integer
required

The category ID

Body

application/json

Request body for creating or updating a category.

​
name
string
required

Category name. Must be unique within the model.

Required string length: 1 - 128
Example:

"Opening"

​
description
string
required

Detailed description of the category purpose

Maximum string length: 512
Example:

"Evaluation criteria for call opening and greeting"

​
max_score
integer
required

Maximum score achievable in this category

Required range: x >= 0
Example:

100

​
order_number
integer

Display order within the model. Lower numbers appear first.

Required range: x >= 0
Example:

1

Response

Successful Response

Response model for category.

​
id
integer
required

Unique identifier

Example:

1

​
client_prompt_template_id
integer
required

Parent model ID

Example:

1

​
name
string
required

Category name

Example:

"Opening"

​
slug
string
required

Auto-generated slug from name (kebab-case). Used as variable name in JSON responses.

Example:

"opening"

​
description
string
required

Category description

​
max_score
integer
required

Maximum score achievable in this category

Example:

100

​
enabled
boolean
required

Whether the category is active

​
created_at
string<date-time>
required

Creation timestamp

​
created_by
string
required

Creator identifier

​
order_number
integer

Display order within the model

​
updated_at
string<date-time>

Last update timestamp

​
updated_by
string

Last updater identifier