Annotation Configs

List annotation configurations

get

Retrieve a paginated list of all annotation configurations in the system.

Query parameters

cursorany ofOptional

Cursor for pagination (base64-encoded annotation config ID)

stringOptional

or

nullOptional

limitintegerOptional

Maximum number of configs to return

Default: 100

Responses

200

A list of annotation configurations with pagination information

application/json

403

Forbidden

text/plain

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/annotation_configs HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "name": "text",
      "type": "text",
      "description": "text",
      "optimization_direction": "MINIMIZE",
      "values": [
        {
          "label": "text",
          "score": 1
        }
      ],
      "id": "text"
    }
  ],
  "next_cursor": "text"
}

Create an annotation configuration

post

Body

one ofOptional

or

or

Responses

200

Successful Response

application/json

403

Forbidden

text/plain

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/annotation_configs HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "name": "text",
  "type": "text",
  "description": "text",
  "optimization_direction": "MINIMIZE",
  "values": [
    {
      "label": "text",
      "score": 1
    }
  ]
}

{
  "data": {
    "name": "text",
    "type": "text",
    "description": "text",
    "optimization_direction": "MINIMIZE",
    "values": [
      {
        "label": "text",
        "score": 1
      }
    ],
    "id": "text"
  }
}

Get an annotation configuration by ID or name

get

Path parameters

config_identifierstringRequired

ID or name of the annotation configuration

Responses

200

Successful Response

application/json

403

Forbidden

text/plain

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /v1/annotation_configs/{config_identifier} HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "name": "text",
    "type": "text",
    "description": "text",
    "optimization_direction": "MINIMIZE",
    "values": [
      {
        "label": "text",
        "score": 1
      }
    ],
    "id": "text"
  }
}

Update an annotation configuration

put

Path parameters

config_idstringRequired

ID of the annotation configuration

Body

one ofOptional

or

or

Responses

200

Successful Response

application/json

403

Forbidden

text/plain

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

PUT /v1/annotation_configs/{config_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "name": "text",
  "type": "text",
  "description": "text",
  "optimization_direction": "MINIMIZE",
  "values": [
    {
      "label": "text",
      "score": 1
    }
  ]
}

{
  "data": {
    "name": "text",
    "type": "text",
    "description": "text",
    "optimization_direction": "MINIMIZE",
    "values": [
      {
        "label": "text",
        "score": 1
      }
    ],
    "id": "text"
  }
}

Delete an annotation configuration

delete

Path parameters

config_idstringRequired

ID of the annotation configuration

Responses

200

Successful Response

application/json

403

Forbidden

text/plain

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/annotation_configs/{config_id} HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "name": "text",
    "type": "text",
    "description": "text",
    "optimization_direction": "MINIMIZE",
    "values": [
      {
        "label": "text",
        "score": 1
      }
    ],
    "id": "text"
  }
}