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": "https://example.org/image.jpg"
}'

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

You can POST a base64 encoded image directly to your model endpoint. Or you can pass a URL as the image parameter in the request body if image is already hosted elsewhere

​
image
string
required

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

​
confidence
number

The confidence threshold used to filter out predictions

Required range: 0 < x < 1
​
annotate
boolean
default: true

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

​
show_prob
boolean | null
default: true

Indicate whether to show prediction confidences on each bounding box

​
stroke_width
number | null

Bounding box border width

Required range: 1 < x < 5

Response

200 - application/json

The API inference route hosted by us returns a JSON object that includes a predictions array. Each prediction within this array comprises the following attributes:

​
detections
object[]

collection of all detected objects for the prediction

​
image
string | null

Base64-encoded string of the annotated image.

​
labelsCount
object[]

aggregate of count of all detected objects

Was this page helpful?

Image classification