Skip to main content
POST
/
v1
/
annotation_configs
Create an annotation configuration
curl --request POST \
  --url https://api.example.com/v1/annotation_configs \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "values": [
    {
      "label": "<string>",
      "score": 123
    }
  ],
  "description": "<string>"
}
'
import requests

url = "https://api.example.com/v1/annotation_configs"

payload = {
    "name": "<string>",
    "type": "<string>",
    "values": [
        {
            "label": "<string>",
            "score": 123
        }
    ],
    "description": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    type: '<string>',
    values: [{label: '<string>', score: 123}],
    description: '<string>'
  })
};

fetch('https://api.example.com/v1/annotation_configs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/annotation_configs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'type' => '<string>',
    'values' => [
        [
                'label' => '<string>',
                'score' => 123
        ]
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/annotation_configs"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"values\": [\n    {\n      \"label\": \"<string>\",\n      \"score\": 123\n    }\n  ],\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/annotation_configs")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"values\": [\n    {\n      \"label\": \"<string>\",\n      \"score\": 123\n    }\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/annotation_configs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"values\": [\n    {\n      \"label\": \"<string>\",\n      \"score\": 123\n    }\n  ],\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "name": "<string>",
    "type": "<string>",
    "values": [
      {
        "label": "<string>",
        "score": 123
      }
    ],
    "id": "<string>",
    "description": "<string>"
  }
}
"<string>"
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json
​
name
string
required
​
type
string
required
Allowed value: "CATEGORICAL"
​
optimization_direction
enum<string>
required
Available options:
MINIMIZE,
MAXIMIZE,
NONE
​
values
CategoricalAnnotationValue · object[]
required
​
description
string | null

Response

Successful Response

​
data
CategoricalAnnotationConfig · object
required