latestOpenAPI 3.1.02026-08-10134648.5 KB

5c100d640e2e

ITEMS_CHARACTERISTICS

Queue an image for Items & Characteristics classification

This endpoint queues job that predicts the Items & Characteristics categories of a single image.

The request must contain either file (a multi-part form encoded image file) or url (a string containing a url to a image file)

Example CURL:

curl -i -X POST -H "Authorization: Bearer {API_TOKEN}" -H "Content-Type: multipart/form-data"          -F "file=@image.jpg;type=image/jpeg"  https://api.unitary.ai/v1/classify/items-characteristics/image

A job ID will be returned in the response.

If callback_url is included in the request then results will be POST'd to this URL once the image has been classified.

Alternatively results can be obtained by making a GET request to results endpoint using the job ID.

Webhooks should be implemented for any use of this endpoint at scale to prevent unnecessary polling of the results endpoint.

post/classify/items-characteristics/image

Response

Successful Response

job_idstring uuid4 required