Upload Image API

🚧

Beta Release

This endpoint is currently in beta and is subject to change. Request and response formats and behavior may change without prior notice.

Uploads an image for visual search analysis. The response returns an imageId to include as attachedImageId in a subsequent imageSearch request to the Send API.

Image search must be enabled for the site (features.imageSearch.enabled in the Status API); otherwise the call returns HTTP 403 with VS_007. Supported formats are JPEG, PNG, WebP, HEIC and HEIF, from 10 KB to 10 MB and at least 224×224 pixels.

Query Params
string
required

Site identifier

Body Params
file
required

Image file

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json