POST
/
v1
/
images
/
{imageId}
/
classify

Description

The classify endpoint allows you to classify an image using a pre-trained model. At the moment, the only supported model is the ResNet50 model, a deep learning model that excels at image classification tasks.

The endpoint will return a list of labels and their probabilities for the image.

Test images may return accurate results due the test watermarks applied to them. If you want to get better results, please use live images. If you just want to test this feature, contact support to temporarily upgrade your account.


Request Parameters

The request path should contain the following parameters:

imageId
string
required

The ID of the image to classify.

Response

The API will return a JSON object with the following fields:

main_label
string

The main label of the image. This is the label with the highest probability.

main_score
number

The score of the main label. The score is a number between 0 and 1, where 1 is the highest probability.

secondary_labels
array

A list of labels and their probabilities for the image.