Skip to main content
POST
/
v1
/
models
/
{model_id}
/
variables
Create a new variable in an analysis model
curl --request POST \
  --url https://api.example.com/v1/models/{model_id}/variables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "greeting_quality",
  "readable_name": "Greeting Quality",
  "description": "Evaluates the quality and professionalism of the greeting",
  "type": "INTEGER",
  "weight": 10,
  "required": true,
  "order_number": 1,
  "category_id": 1
}
'
{
  "id": 1,
  "client_prompt_template_id": 1,
  "client_prompt_template_category_id": 1,
  "key": "greeting_quality",
  "readable_name": "Greeting Quality",
  "description": "Evaluates greeting professionalism",
  "type": "INTEGER",
  "weight": 10,
  "required": true,
  "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

Body

application/json

Request body for creating or updating a variable.

​
key
string
required

Unique identifier key for this variable within the model

Required string length: 1 - 128
Example:

"greeting_quality"

​
type
enum<string>
required

Data type: STRING, INTEGER, DECIMAL, BOOLEAN, DATE, TIME, or DATETIME

Available options:
STRING,
INTEGER,
DECIMAL,
BOOLEAN,
DATE,
TIME,
DATETIME
​
required
boolean
required

Whether this variable must have a value in analysis results

Example:

true

​
readable_name
string

Human-readable display name for UI presentation

Maximum string length: 128
Example:

"Greeting Quality"

​
description
string

Description of what this variable measures

Maximum string length: 256
Example:

"Evaluates the quality and professionalism of the greeting"

​
weight
integer

Weight for scoring calculations. Higher weight = more impact on score.

Required range: x >= 0
Example:

10

​
order_number
integer

Display order within the category or model

Required range: x >= 0
Example:

1

​
category_id
integer

ID of the category this variable belongs to. Must exist in the same model.

Example:

1

Response

Successful Response

Response model for variable.

​
id
integer
required

Unique identifier

Example:

1

​
client_prompt_template_id
integer
required

Parent model ID

Example:

1

​
key
string
required

Variable key

Example:

"greeting_quality"

​
type
enum<string>
required

Data type

Available options:
STRING,
INTEGER,
DECIMAL,
BOOLEAN,
DATE,
TIME,
DATETIME
​
required
boolean
required

Whether this variable is required

​
enabled
boolean
required

Whether the variable is active

​
created_at
string<date-time>
required

Creation timestamp

​
created_by
string
required

Creator identifier

​
client_prompt_template_category_id
integer

Category ID if assigned

​
readable_name
string

Human-readable display name

​
description
string

Variable description

​
weight
integer

Scoring weight

​
order_number
integer

Display order

​
updated_at
string<date-time>

Last update timestamp

​
updated_by
string

Last updater identifier