Zatomic API

Creating scoring criteria

Creating new scoring criteria requires a name and at least 1 criterion in the criterion_set. For each criterion given, all fields are required.

A successful call returns a 201 status code with a response that contains the scoring criteria object.

Endpoint
POST https://api.zatomic.ai/v1/prompts/scoring/criteria

Request Properties
name
string
The criteria name.
use_case
string, optional
The use case for the criteria.
criterion_set
list of criterion objects

Properties for the criterion object:

slug
string
The slug for the criterion. Can only contain lowercase letters and underscores.
label
string
The criterion label.
description
string
The criterion description.
questions
string
The question or questions the criterion is trying to answer.
weight
integer
The weight assigned to the criterion. Must be a whole number between 1 and 999.
Request Body
{
   "name": "Criteria name",
   "use_case": "The criteria use case.",
   "criterion_set": [
      {
         "slug": "criterion_slug",
         "label": "The label of the criterion.",
         "description": "The criterion description.",
         "questions": "The question or questions the criterion is trying to answer.",
         "weight": 0
      }
   ]
}