Detect an Object

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

Headers

x-api-keystringRequired

Your active API Key

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.

Errors