POST
/
predict
/
classify
/
{model_id}
/
curl --request POST \
  --url https://api.epigos.ai/predict/classify/{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 predictions 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

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:

category
string
required

Predicted category of the image

confidence
number
required

highest predicted confidence score

predictions
object[]

collection of all predicted classes and their associated confidence values for the prediction

Was this page helpful?

IntroductionObject detection