annotations
Create annotations tasks
Requires scopes: eval:write
POST
/
api
/
annotations
/
tasks
Create annotations tasks
curl --request POST \
--url https://evalgate.com/api/annotations/tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "<string>",
"name": "<string>",
"description": "<string>",
"config": {
"taskType": "<string>",
"fields": [
true
]
},
"annotationSettings": {
"multipleAnnotators": {
"annotatorsPerItem": 123,
"minAgreementScore": 123
},
"qualityControl": {
"minAnnotationsPerItem": 123,
"maxAnnotationsPerAnnotator": 123
}
},
"instructions": "<string>",
"template": "<string>",
"templateId": "<string>",
"fields": [
{
"type": "text",
"name": "<string>",
"label": "<string>",
"options": [
"<string>"
],
"id": "<string>",
"description": "<string>",
"required": false,
"scale": 123,
"scaleLowLabel": "<string>",
"scaleHighLabel": "<string>",
"allowUnableToJudge": false,
"allowNotApplicable": false
}
]
}
'import requests
url = "https://evalgate.com/api/annotations/tasks"
payload = {
"type": "<string>",
"name": "<string>",
"description": "<string>",
"config": {
"taskType": "<string>",
"fields": [True]
},
"annotationSettings": {
"multipleAnnotators": {
"annotatorsPerItem": 123,
"minAgreementScore": 123
},
"qualityControl": {
"minAnnotationsPerItem": 123,
"maxAnnotationsPerAnnotator": 123
}
},
"instructions": "<string>",
"template": "<string>",
"templateId": "<string>",
"fields": [
{
"type": "text",
"name": "<string>",
"label": "<string>",
"options": ["<string>"],
"id": "<string>",
"description": "<string>",
"required": False,
"scale": 123,
"scaleLowLabel": "<string>",
"scaleHighLabel": "<string>",
"allowUnableToJudge": False,
"allowNotApplicable": False
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: '<string>',
name: '<string>',
description: '<string>',
config: {taskType: '<string>', fields: [true]},
annotationSettings: {
multipleAnnotators: {annotatorsPerItem: 123, minAgreementScore: 123},
qualityControl: {minAnnotationsPerItem: 123, maxAnnotationsPerAnnotator: 123}
},
instructions: '<string>',
template: '<string>',
templateId: '<string>',
fields: [
{
type: 'text',
name: '<string>',
label: '<string>',
options: ['<string>'],
id: '<string>',
description: '<string>',
required: false,
scale: 123,
scaleLowLabel: '<string>',
scaleHighLabel: '<string>',
allowUnableToJudge: false,
allowNotApplicable: false
}
]
})
};
fetch('https://evalgate.com/api/annotations/tasks', 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://evalgate.com/api/annotations/tasks",
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([
'type' => '<string>',
'name' => '<string>',
'description' => '<string>',
'config' => [
'taskType' => '<string>',
'fields' => [
true
]
],
'annotationSettings' => [
'multipleAnnotators' => [
'annotatorsPerItem' => 123,
'minAgreementScore' => 123
],
'qualityControl' => [
'minAnnotationsPerItem' => 123,
'maxAnnotationsPerAnnotator' => 123
]
],
'instructions' => '<string>',
'template' => '<string>',
'templateId' => '<string>',
'fields' => [
[
'type' => 'text',
'name' => '<string>',
'label' => '<string>',
'options' => [
'<string>'
],
'id' => '<string>',
'description' => '<string>',
'required' => false,
'scale' => 123,
'scaleLowLabel' => '<string>',
'scaleHighLabel' => '<string>',
'allowUnableToJudge' => false,
'allowNotApplicable' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://evalgate.com/api/annotations/tasks"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"taskType\": \"<string>\",\n \"fields\": [\n true\n ]\n },\n \"annotationSettings\": {\n \"multipleAnnotators\": {\n \"annotatorsPerItem\": 123,\n \"minAgreementScore\": 123\n },\n \"qualityControl\": {\n \"minAnnotationsPerItem\": 123,\n \"maxAnnotationsPerAnnotator\": 123\n }\n },\n \"instructions\": \"<string>\",\n \"template\": \"<string>\",\n \"templateId\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"text\",\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false,\n \"scale\": 123,\n \"scaleLowLabel\": \"<string>\",\n \"scaleHighLabel\": \"<string>\",\n \"allowUnableToJudge\": false,\n \"allowNotApplicable\": false\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://evalgate.com/api/annotations/tasks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"taskType\": \"<string>\",\n \"fields\": [\n true\n ]\n },\n \"annotationSettings\": {\n \"multipleAnnotators\": {\n \"annotatorsPerItem\": 123,\n \"minAgreementScore\": 123\n },\n \"qualityControl\": {\n \"minAnnotationsPerItem\": 123,\n \"maxAnnotationsPerAnnotator\": 123\n }\n },\n \"instructions\": \"<string>\",\n \"template\": \"<string>\",\n \"templateId\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"text\",\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false,\n \"scale\": 123,\n \"scaleLowLabel\": \"<string>\",\n \"scaleHighLabel\": \"<string>\",\n \"allowUnableToJudge\": false,\n \"allowNotApplicable\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/annotations/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"taskType\": \"<string>\",\n \"fields\": [\n true\n ]\n },\n \"annotationSettings\": {\n \"multipleAnnotators\": {\n \"annotatorsPerItem\": 123,\n \"minAgreementScore\": 123\n },\n \"qualityControl\": {\n \"minAnnotationsPerItem\": 123,\n \"maxAnnotationsPerAnnotator\": 123\n }\n },\n \"instructions\": \"<string>\",\n \"template\": \"<string>\",\n \"templateId\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"text\",\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false,\n \"scale\": 123,\n \"scaleLowLabel\": \"<string>\",\n \"scaleHighLabel\": \"<string>\",\n \"allowUnableToJudge\": false,\n \"allowNotApplicable\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"type": "<string>",
"id": 123,
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"createdBy": "<string>",
"totalItems": 123,
"completedItems": 123,
"questionSetVersion": 123,
"writeRevision": 123,
"annotationSettings": {
"guidelines": "<string>",
"labelSchema": {},
"questionSet": {},
"allowMultipleAnnotators": false,
"labelTaxonomyVersion": "<string>",
"requiredEvidence": false,
"assignment": "<string>",
"enableReview": false
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}Authorizations
Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes.
Body
application/json
Response
Successful response
Show child attributes
Show child attributes
⌘I
Create annotations tasks
curl --request POST \
--url https://evalgate.com/api/annotations/tasks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "<string>",
"name": "<string>",
"description": "<string>",
"config": {
"taskType": "<string>",
"fields": [
true
]
},
"annotationSettings": {
"multipleAnnotators": {
"annotatorsPerItem": 123,
"minAgreementScore": 123
},
"qualityControl": {
"minAnnotationsPerItem": 123,
"maxAnnotationsPerAnnotator": 123
}
},
"instructions": "<string>",
"template": "<string>",
"templateId": "<string>",
"fields": [
{
"type": "text",
"name": "<string>",
"label": "<string>",
"options": [
"<string>"
],
"id": "<string>",
"description": "<string>",
"required": false,
"scale": 123,
"scaleLowLabel": "<string>",
"scaleHighLabel": "<string>",
"allowUnableToJudge": false,
"allowNotApplicable": false
}
]
}
'import requests
url = "https://evalgate.com/api/annotations/tasks"
payload = {
"type": "<string>",
"name": "<string>",
"description": "<string>",
"config": {
"taskType": "<string>",
"fields": [True]
},
"annotationSettings": {
"multipleAnnotators": {
"annotatorsPerItem": 123,
"minAgreementScore": 123
},
"qualityControl": {
"minAnnotationsPerItem": 123,
"maxAnnotationsPerAnnotator": 123
}
},
"instructions": "<string>",
"template": "<string>",
"templateId": "<string>",
"fields": [
{
"type": "text",
"name": "<string>",
"label": "<string>",
"options": ["<string>"],
"id": "<string>",
"description": "<string>",
"required": False,
"scale": 123,
"scaleLowLabel": "<string>",
"scaleHighLabel": "<string>",
"allowUnableToJudge": False,
"allowNotApplicable": False
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: '<string>',
name: '<string>',
description: '<string>',
config: {taskType: '<string>', fields: [true]},
annotationSettings: {
multipleAnnotators: {annotatorsPerItem: 123, minAgreementScore: 123},
qualityControl: {minAnnotationsPerItem: 123, maxAnnotationsPerAnnotator: 123}
},
instructions: '<string>',
template: '<string>',
templateId: '<string>',
fields: [
{
type: 'text',
name: '<string>',
label: '<string>',
options: ['<string>'],
id: '<string>',
description: '<string>',
required: false,
scale: 123,
scaleLowLabel: '<string>',
scaleHighLabel: '<string>',
allowUnableToJudge: false,
allowNotApplicable: false
}
]
})
};
fetch('https://evalgate.com/api/annotations/tasks', 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://evalgate.com/api/annotations/tasks",
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([
'type' => '<string>',
'name' => '<string>',
'description' => '<string>',
'config' => [
'taskType' => '<string>',
'fields' => [
true
]
],
'annotationSettings' => [
'multipleAnnotators' => [
'annotatorsPerItem' => 123,
'minAgreementScore' => 123
],
'qualityControl' => [
'minAnnotationsPerItem' => 123,
'maxAnnotationsPerAnnotator' => 123
]
],
'instructions' => '<string>',
'template' => '<string>',
'templateId' => '<string>',
'fields' => [
[
'type' => 'text',
'name' => '<string>',
'label' => '<string>',
'options' => [
'<string>'
],
'id' => '<string>',
'description' => '<string>',
'required' => false,
'scale' => 123,
'scaleLowLabel' => '<string>',
'scaleHighLabel' => '<string>',
'allowUnableToJudge' => false,
'allowNotApplicable' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://evalgate.com/api/annotations/tasks"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"taskType\": \"<string>\",\n \"fields\": [\n true\n ]\n },\n \"annotationSettings\": {\n \"multipleAnnotators\": {\n \"annotatorsPerItem\": 123,\n \"minAgreementScore\": 123\n },\n \"qualityControl\": {\n \"minAnnotationsPerItem\": 123,\n \"maxAnnotationsPerAnnotator\": 123\n }\n },\n \"instructions\": \"<string>\",\n \"template\": \"<string>\",\n \"templateId\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"text\",\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false,\n \"scale\": 123,\n \"scaleLowLabel\": \"<string>\",\n \"scaleHighLabel\": \"<string>\",\n \"allowUnableToJudge\": false,\n \"allowNotApplicable\": false\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://evalgate.com/api/annotations/tasks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"taskType\": \"<string>\",\n \"fields\": [\n true\n ]\n },\n \"annotationSettings\": {\n \"multipleAnnotators\": {\n \"annotatorsPerItem\": 123,\n \"minAgreementScore\": 123\n },\n \"qualityControl\": {\n \"minAnnotationsPerItem\": 123,\n \"maxAnnotationsPerAnnotator\": 123\n }\n },\n \"instructions\": \"<string>\",\n \"template\": \"<string>\",\n \"templateId\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"text\",\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false,\n \"scale\": 123,\n \"scaleLowLabel\": \"<string>\",\n \"scaleHighLabel\": \"<string>\",\n \"allowUnableToJudge\": false,\n \"allowNotApplicable\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/annotations/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"config\": {\n \"taskType\": \"<string>\",\n \"fields\": [\n true\n ]\n },\n \"annotationSettings\": {\n \"multipleAnnotators\": {\n \"annotatorsPerItem\": 123,\n \"minAgreementScore\": 123\n },\n \"qualityControl\": {\n \"minAnnotationsPerItem\": 123,\n \"maxAnnotationsPerAnnotator\": 123\n }\n },\n \"instructions\": \"<string>\",\n \"template\": \"<string>\",\n \"templateId\": \"<string>\",\n \"fields\": [\n {\n \"type\": \"text\",\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": false,\n \"scale\": 123,\n \"scaleLowLabel\": \"<string>\",\n \"scaleHighLabel\": \"<string>\",\n \"allowUnableToJudge\": false,\n \"allowNotApplicable\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"type": "<string>",
"id": 123,
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"createdBy": "<string>",
"totalItems": 123,
"completedItems": 123,
"questionSetVersion": 123,
"writeRevision": 123,
"annotationSettings": {
"guidelines": "<string>",
"labelSchema": {},
"questionSet": {},
"allowMultipleAnnotators": false,
"labelTaxonomyVersion": "<string>",
"requiredEvidence": false,
"assignment": "<string>",
"enableReview": false
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}