Notify edge image upload
curl --request POST \
--url https://acusight.io/api/data/agent/images/notify \
--header 'Content-Type: application/json' \
--header 'X-Device-Key: <api-key>' \
--data '
{
"device_id": "<string>",
"filename": "<string>",
"height": 123,
"storage_key": "<string>",
"width": 123,
"annotations": [
{
"class_value": "<string>",
"confidence": 123,
"geometry": [
123
],
"type": "<string>"
}
],
"model_id": "<string>",
"model_name": "<string>",
"model_version": "<string>",
"pipeline_id": "<string>"
}
'import requests
url = "https://acusight.io/api/data/agent/images/notify"
payload = {
"device_id": "<string>",
"filename": "<string>",
"height": 123,
"storage_key": "<string>",
"width": 123,
"annotations": [
{
"class_value": "<string>",
"confidence": 123,
"geometry": [123],
"type": "<string>"
}
],
"model_id": "<string>",
"model_name": "<string>",
"model_version": "<string>",
"pipeline_id": "<string>"
}
headers = {
"X-Device-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Device-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
device_id: '<string>',
filename: '<string>',
height: 123,
storage_key: '<string>',
width: 123,
annotations: [{class_value: '<string>', confidence: 123, geometry: [123], type: '<string>'}],
model_id: '<string>',
model_name: '<string>',
model_version: '<string>',
pipeline_id: '<string>'
})
};
fetch('https://acusight.io/api/data/agent/images/notify', 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://acusight.io/api/data/agent/images/notify",
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([
'device_id' => '<string>',
'filename' => '<string>',
'height' => 123,
'storage_key' => '<string>',
'width' => 123,
'annotations' => [
[
'class_value' => '<string>',
'confidence' => 123,
'geometry' => [
123
],
'type' => '<string>'
]
],
'model_id' => '<string>',
'model_name' => '<string>',
'model_version' => '<string>',
'pipeline_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Device-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://acusight.io/api/data/agent/images/notify"
payload := strings.NewReader("{\n \"device_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"height\": 123,\n \"storage_key\": \"<string>\",\n \"width\": 123,\n \"annotations\": [\n {\n \"class_value\": \"<string>\",\n \"confidence\": 123,\n \"geometry\": [\n 123\n ],\n \"type\": \"<string>\"\n }\n ],\n \"model_id\": \"<string>\",\n \"model_name\": \"<string>\",\n \"model_version\": \"<string>\",\n \"pipeline_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Device-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://acusight.io/api/data/agent/images/notify")
.header("X-Device-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"device_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"height\": 123,\n \"storage_key\": \"<string>\",\n \"width\": 123,\n \"annotations\": [\n {\n \"class_value\": \"<string>\",\n \"confidence\": 123,\n \"geometry\": [\n 123\n ],\n \"type\": \"<string>\"\n }\n ],\n \"model_id\": \"<string>\",\n \"model_name\": \"<string>\",\n \"model_version\": \"<string>\",\n \"pipeline_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://acusight.io/api/data/agent/images/notify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Device-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"device_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"height\": 123,\n \"storage_key\": \"<string>\",\n \"width\": 123,\n \"annotations\": [\n {\n \"class_value\": \"<string>\",\n \"confidence\": 123,\n \"geometry\": [\n 123\n ],\n \"type\": \"<string>\"\n }\n ],\n \"model_id\": \"<string>\",\n \"model_name\": \"<string>\",\n \"model_version\": \"<string>\",\n \"pipeline_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"batch_id": 123,
"batch_name": "<string>",
"batch_status": "<string>",
"image_id": 123,
"images_count": 123
},
"error": {
"code": "<string>",
"details": "<string>",
"message": "<string>"
},
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<string>",
"message": "<string>"
},
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<string>",
"message": "<string>"
},
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<string>",
"message": "<string>"
},
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total": 123
},
"success": true
}Datasets & data
Notify edge image upload
Records metadata for an image uploaded by an edge device, updates or creates the working batch, and persists inline annotations when provided.
POST
/
data
/
agent
/
images
/
notify
Notify edge image upload
curl --request POST \
--url https://acusight.io/api/data/agent/images/notify \
--header 'Content-Type: application/json' \
--header 'X-Device-Key: <api-key>' \
--data '
{
"device_id": "<string>",
"filename": "<string>",
"height": 123,
"storage_key": "<string>",
"width": 123,
"annotations": [
{
"class_value": "<string>",
"confidence": 123,
"geometry": [
123
],
"type": "<string>"
}
],
"model_id": "<string>",
"model_name": "<string>",
"model_version": "<string>",
"pipeline_id": "<string>"
}
'import requests
url = "https://acusight.io/api/data/agent/images/notify"
payload = {
"device_id": "<string>",
"filename": "<string>",
"height": 123,
"storage_key": "<string>",
"width": 123,
"annotations": [
{
"class_value": "<string>",
"confidence": 123,
"geometry": [123],
"type": "<string>"
}
],
"model_id": "<string>",
"model_name": "<string>",
"model_version": "<string>",
"pipeline_id": "<string>"
}
headers = {
"X-Device-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Device-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
device_id: '<string>',
filename: '<string>',
height: 123,
storage_key: '<string>',
width: 123,
annotations: [{class_value: '<string>', confidence: 123, geometry: [123], type: '<string>'}],
model_id: '<string>',
model_name: '<string>',
model_version: '<string>',
pipeline_id: '<string>'
})
};
fetch('https://acusight.io/api/data/agent/images/notify', 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://acusight.io/api/data/agent/images/notify",
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([
'device_id' => '<string>',
'filename' => '<string>',
'height' => 123,
'storage_key' => '<string>',
'width' => 123,
'annotations' => [
[
'class_value' => '<string>',
'confidence' => 123,
'geometry' => [
123
],
'type' => '<string>'
]
],
'model_id' => '<string>',
'model_name' => '<string>',
'model_version' => '<string>',
'pipeline_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Device-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://acusight.io/api/data/agent/images/notify"
payload := strings.NewReader("{\n \"device_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"height\": 123,\n \"storage_key\": \"<string>\",\n \"width\": 123,\n \"annotations\": [\n {\n \"class_value\": \"<string>\",\n \"confidence\": 123,\n \"geometry\": [\n 123\n ],\n \"type\": \"<string>\"\n }\n ],\n \"model_id\": \"<string>\",\n \"model_name\": \"<string>\",\n \"model_version\": \"<string>\",\n \"pipeline_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Device-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://acusight.io/api/data/agent/images/notify")
.header("X-Device-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"device_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"height\": 123,\n \"storage_key\": \"<string>\",\n \"width\": 123,\n \"annotations\": [\n {\n \"class_value\": \"<string>\",\n \"confidence\": 123,\n \"geometry\": [\n 123\n ],\n \"type\": \"<string>\"\n }\n ],\n \"model_id\": \"<string>\",\n \"model_name\": \"<string>\",\n \"model_version\": \"<string>\",\n \"pipeline_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://acusight.io/api/data/agent/images/notify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Device-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"device_id\": \"<string>\",\n \"filename\": \"<string>\",\n \"height\": 123,\n \"storage_key\": \"<string>\",\n \"width\": 123,\n \"annotations\": [\n {\n \"class_value\": \"<string>\",\n \"confidence\": 123,\n \"geometry\": [\n 123\n ],\n \"type\": \"<string>\"\n }\n ],\n \"model_id\": \"<string>\",\n \"model_name\": \"<string>\",\n \"model_version\": \"<string>\",\n \"pipeline_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"batch_id": 123,
"batch_name": "<string>",
"batch_status": "<string>",
"image_id": 123,
"images_count": 123
},
"error": {
"code": "<string>",
"details": "<string>",
"message": "<string>"
},
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<string>",
"message": "<string>"
},
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<string>",
"message": "<string>"
},
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total": 123
},
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"details": "<string>",
"message": "<string>"
},
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total": 123
},
"success": true
}Authorizations
Device API key for edge agent authentication. Format: adk_
Body
application/json
Image notification payload
Show child attributes
Show child attributes
Model that generated annotations
Model name
Model version
Pipeline that produced this image (empty = legacy device-scoped)
Was this page helpful?