---
title: "Search for similar assets"
url: "https://earlyaccess.developers.bynder.com/apis/bynder-asset-similarity-search-api-1/versions/4ea406ce-ed69-40f3-9ed6-96c4fd9a831f/paths/api-1-assets-similarity-search/post"
---

> Full API specification: https://earlyaccess.developers.bynder.com/apis/bynder-asset-similarity-search-api-1/versions/4ea406ce-ed69-40f3-9ed6-96c4fd9a831f.md

# Search for similar assets

`POST` `/api/1/assets/similarity-search/`

Perform a similarity search for assets based on asset IDs, image URL, image data, or text query. <br><br>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](https://api.bynder.com/docs/getting-started#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.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Successful response
- `400` - Bad request

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Bynder Asset Similarity Search API
  version: 1.0.0
servers:
  - url: https://{your-bynder-domain}/
    variables:
      your-bynder-domain:
        default: example.com
        description: Your Bynder domain.
paths:
  /api/1/assets/similarity-search/:
    post:
      description: Perform a similarity search for assets based on asset IDs, image
        URL, image data, or text query. <br><br>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](https://api.bynder.com/docs/getting-started#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.
      requestBody:
        content:
          application/json:
            schema:
              properties:
                assetIds:
                  description: List of asset IDs to search similar assets for.
                  example:
                    - eff9f6c7-ae77-4614-911b-fd238df5bac3
                    - 5af81baa-ee0b-4611-bfa6-fd023c7989b8
                  items:
                    type: string
                  type: array
                imageData:
                  description: Base64 encoded image data for similarity search.
                  example: data:image/jpeg;base64,...
                  type: string
                imageUrl:
                  description: 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
                  type: string
                textQuery:
                  description: A text query describing the image for the search.
                  example: Image of a sunset
                  type: string
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              example:
                assets:
                  - assetId: e0664bc4-4d64-4776-a010-a19d337f7ee9
                    similarityScore: 0.98
                  - assetId: 0e870dbc-c6a4-414a-8467-75fac70c84d9
                    similarityScore: 0.95
              schema:
                properties:
                  assets:
                    items:
                      properties:
                        assetId:
                          example: e0664bc4-4d64-4776-a010-a19d337f7ee9
                          type: string
                        similarityScore:
                          example: 0.98
                          format: float
                          type: number
                      type: object
                    type: array
                type: object
          description: Successful response
        "400":
          content:
            application/json:
              example:
                message: "Multiple search parameters provided. Please provide only one of the
                  following parameters: assetIds, imageUrl, imageData,
                  textQuery."
                reason: MULTIPLE_SEARCH_PARAMETERS
              schema:
                properties:
                  message:
                    example: "Multiple search parameters provided. Please provide only one of the
                      following parameters: assetIds, imageUrl, imageData,
                      textQuery."
                    type: string
                  reason:
                    example: MULTIPLE_SEARCH_PARAMETERS
                    type: string
                type: object
          description: Bad request
      summary: Search for similar assets
      tags:
        - Similarity Search
security:
  - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      bearerFormat: OAuth2
      scheme: bearer
      type: http
```