Annotations
Create Annotation
Create a single annotation.
POST
/
api
/
v1
/
datasets
/
{dataset_id}
/
annotation-sets
/
{annotation_set_id}
/
annotations
Create Annotation
curl --request POST \
--url https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"audio_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifact_type": "<string>",
"start_ms": 1,
"end_ms": 123,
"confidence": 1,
"extra_data": {}
}
'import requests
url = "https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations"
payload = {
"audio_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifact_type": "<string>",
"start_ms": 1,
"end_ms": 123,
"confidence": 1,
"extra_data": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
audio_file_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
artifact_type: '<string>',
start_ms: 1,
end_ms: 123,
confidence: 1,
extra_data: {}
})
};
fetch('https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations', 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/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations",
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([
'audio_file_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'artifact_type' => '<string>',
'start_ms' => 1,
'end_ms' => 123,
'confidence' => 1,
'extra_data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations"
payload := strings.NewReader("{\n \"audio_file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifact_type\": \"<string>\",\n \"start_ms\": 1,\n \"end_ms\": 123,\n \"confidence\": 1,\n \"extra_data\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"audio_file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifact_type\": \"<string>\",\n \"start_ms\": 1,\n \"end_ms\": 123,\n \"confidence\": 1,\n \"extra_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"audio_file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifact_type\": \"<string>\",\n \"start_ms\": 1,\n \"end_ms\": 123,\n \"confidence\": 1,\n \"extra_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"annotation_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audio_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifact_type": "<string>",
"start_ms": 123,
"end_ms": 123,
"confidence": 123,
"extra_data": {},
"created_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Response
Successful Response
⌘I
Create Annotation
curl --request POST \
--url https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"audio_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifact_type": "<string>",
"start_ms": 1,
"end_ms": 123,
"confidence": 1,
"extra_data": {}
}
'import requests
url = "https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations"
payload = {
"audio_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifact_type": "<string>",
"start_ms": 1,
"end_ms": 123,
"confidence": 1,
"extra_data": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
audio_file_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
artifact_type: '<string>',
start_ms: 1,
end_ms: 123,
confidence: 1,
extra_data: {}
})
};
fetch('https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations', 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/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations",
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([
'audio_file_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'artifact_type' => '<string>',
'start_ms' => 1,
'end_ms' => 123,
'confidence' => 1,
'extra_data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations"
payload := strings.NewReader("{\n \"audio_file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifact_type\": \"<string>\",\n \"start_ms\": 1,\n \"end_ms\": 123,\n \"confidence\": 1,\n \"extra_data\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"audio_file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifact_type\": \"<string>\",\n \"start_ms\": 1,\n \"end_ms\": 123,\n \"confidence\": 1,\n \"extra_data\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"audio_file_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"artifact_type\": \"<string>\",\n \"start_ms\": 1,\n \"end_ms\": 123,\n \"confidence\": 1,\n \"extra_data\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"annotation_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"audio_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifact_type": "<string>",
"start_ms": 123,
"end_ms": 123,
"confidence": 123,
"extra_data": {},
"created_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}