Skip to navigation

List similar images

View as Markdown

List the organization’s images that look most like an image, most similar first.

Each result has a similarity from -1 to 1, where higher means more alike. Pass min_similarity to leave out weaker matches. Similarity values can change when the platform updates how it compares images, so use them to rank results and not as stored thresholds.

The file must be a processed image that has been analyzed for similarity.

Each result also has a signed thumbnail_url. Signed URLs expire, so download thumbnails soon after listing them. Returns 409 when the image has not been analyzed for similarity.

Requires an API key with the read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

file_idstringRequired

Query parameters

limitintegerOptional1-100Defaults to 10
min_similaritydouble or nullOptional-1-1

Response

OK
imageslist of objects
The most similar images, most similar first.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error