POST
/
predict
/
detect
/
{model_id}
/
curl --request POST \
  --url https://api.epigos.ai/predict/detect/{model_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "image": "base64"
}'
{
  "detections": [
    {
      "confidence": 0.954,
      "height": 36,
      "label": "car",
      "width": 46,
      "x": 281,
      "y": 187
    },
    {
      "confidence": 0.854,
      "height": 30,
      "label": "person",
      "width": 40,
      "x": 21,
      "y": 87
    }
  ],
  "image": "base64"
}

Authorizations

X-API-Key
string
headerrequired

Your API key (obtained via your workspace API settings page)

Path Parameters

model_id
string
required

The unique ID of your model deployed on Epigos AI. You can find it in the web dashboard by viewing the model details.

Body

application/json
annotate
boolean
default: true

Indicate whether to draw bounding boxes on the image for the detected objects

confidence
number

The confidence threshold used to filter out predictions

image
string
required

Image path to run detections on. It can be base64 encoded string or URL to the image.

show_prob
boolean | null
default: true

Indicate whether to show prediction confidences on each bounding box

stroke_width
number | null

Bounding box border width

Response

200 - application/json
detections
object[]

collection of all detected objects for the prediction

image
string | null

Base64-encoded string of the annotated image.