Guides

🖼️ Visual Search

To search by external query image, upload external the image and make it
available as a query image by issuing the following call:

Upload an Image for Search

POST /api/v1/dataset/{dataset-id}/search-image-similarity?entity_type=IMAGES&bounding_box=X,Y,WIDTH,HEIGHT
Headers: Authorization: Bearer <jwt>

Request Parameters:

  • file: Query image file
  • bounding_box (optional): X, Y, Width, Height

Explore Similar Images

Then call exploration endpoint with anchor media id:

GET /api/v1/explore/{dataset-id}?threshold=0&anchor_type={anchor_type}&entity_type={ENTITY_TYPE}&page_number={PAGE_NUMBER}&anchor_media_id={anchor_media_id}
Headers: Authorization: Bearer <jwt>

Where the parameters are:

ENTITY TYPE: either IMAGES or OBJECTS

PAGE NUMBER: results page index. 0 can be a good start for experimentation

anchor_type, anchor_media_id: from previous endpoint response

Example:

curl -H "Authorization: Bearer <jwt>" https://app.visual-layer.com/api/v1/explore/{dataset-id}?threshold=0&entity_type=IMAGES&page_number=0&anchor_media_id={anchor_media_id}

📌 Response: List of VisualLayer image clusters.