Bynder Asset Similarity Search

Bynder Asset Similarity Search API

1.0.0OAS 3.0

API for searching similar assets in Bynder using AI-powered similarity search.

API Base URL
  • Server 1:https://{your-bynder-domain}/
    Variables
    your-bynder-domain:
Security
bearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Search for similar assets

Perform a similarity search for assets based on asset IDs, image URL, image data, or text query.

This endpoint uses the newer, standard UUID format of 8-4-4-4-12, and letters are lowercase. See the example for assetIds, and Note on identifiers for more information. Additionally, only one of the search parameters (assetIds, imageUrl, imageData, textQuery) should be provided per request. Providing multiple parameters will result in a 400 Bad request response. Only OAuth2 authentication is supported for this endpoint, and permanent tokens are not accepted.

post
https://example.com/api/1/assets/similarity-search/

Body

application/json
assetIdsarray[string]

List of asset IDs to search similar assets for.

Example:["eff9f6c7-ae77-4614-911b-fd238df5bac3","5af81baa-ee0b-4611-bfa6-fd023c7989b8"]

imageDatastring

Base64 encoded image data for similarity search.

Example:data:image/jpeg;base64,...

imageUrlstring

URL of the image to find similar assets.

Example:https://d2csxpduxe849s.cloudfront.net/media/A7148429-45E9-45C9-98BABD031228C0E2/0A1C48A2-2523-440C-81DD9DFA221D28FC/webimage-5FE11596-1C5D-4FC1-9C216A240BA53979.png

textQuerystring

A text query describing the image for the search.

Example:Image of a sunset

Response

application/json

Successful response

assetsarray[object]
Show Child Parameters
post/api/1/assets/similarity-search/

Body

{}
 
application/json