Detect an Object

Detects an object within an uploaded image file. Make sure to load the model you’re using for detection first!

Request

This endpoint expects a multipart form.

organization_idstringRequired

Your organization identifier

fileanyRequired

Response

200 - Detection successful

statusstringOptional

A status code denoting success or failure.

detectionslist of anyOptional

The detections response includes 3 elements: the bbox array, a confidence value, and a class. The bbox array is an array of numbers describing the bounding box coordinates for your objects listed in order as [x1, y1, x2, y2]. The confidence score is a value between 0 and 1 rating how confident the object detection output is based on your model and the image provided. The class is the class name of the detected object.

1	import requests
2
3	url = "https://tytbrazyv9.execute-api.us-east-1.amazonaws.com/prod/inference/detect"
4
5	payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"organization_id\"\r\n\r\nstring\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n{}\r\n-----011000010111000001101001--\r\n"
6	headers = {
7	"x-api-key": "string",
8	"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"
9	}
10
11	response = requests.post(url, data=payload, headers=headers)
12
13	print(response.json())

Headers

Request

Response

Errors

1	{
2	"status": "string",
3	"detections": [
4	{}
5	]
6	}