Create Annotation Criteria

Creates a new annotation criteria that defines how future annotations should be structured.

POST

/v1/annotation-criteria

Authorization

`X-API-KEY`<token>

In: header

Request Body

application/jsonRequired

`project_id`
Required
Project Id

Project this criteria will belong to

Format: "uuid"

`name`
Required
Name

Unique name for the criteria within the project

Minimum length: 1Maximum length: 100

`description`Description

Optional description explaining what this criteria measures

`annotation_type`
Required
AnnotationCriteriaType

Type of annotation data this criteria will collect

Value in: "binary" | "continuous" | "discrete" | "categorical" | "text_annotation"

`categories`Categories

Category options for discrete/categorical types

`resource_types`Resource Types

Entity types this criteria can annotate (empty means all types)

curl -X POST "https://api.patronus.ai/v1/annotation-criteria" \
  -H "X-API-KEY: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "name": "string",
    "description": "string",
    "annotation_type": "binary",
    "categories": [
      {
        "label": "string",
        "score": 0
      }
    ],
    "resource_types": [
      "trace"
    ]
  }'

Successful Response

{
  "annotation_criteria": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "name": "string",
    "description": "string",
    "annotation_type": "string",
    "categories": [
      {
        "label": "string",
        "score": 0
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "resource_types": [
      "trace"
    ],
    "locked": false
  }
}

Create Annotation Criteria

Authorization

X-API-KEY<token>

Request Body

project_idRequiredProject Id

nameRequiredName

descriptionDescription

annotation_typeRequiredAnnotationCriteriaType

categoriesCategories

Object 1

resource_typesResource Types