RArainbrand
Images

Search Library images

Find Brand Library images by what they depict, such as product photos or packaging. Generated images are excluded.

post/images/search

Request

  • Base URL
    https://www.rainbrand.com/api/v1
  • URL
    https://www.rainbrand.com/api/v1/images/search
  • Auth
    • API key in header x-api-key
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://www.rainbrand.com/api/auth/oauth2/authorize
      Token URL: https://www.rainbrand.com/api/auth/oauth2/token

Request body

brandSessionIdstring uuid required

Brand ID to search within

querystring required

Visual concept to search for. Plain noun phrases work best — e.g., 'drone in flight', 'team working at desks', 'product on white background'.

limitinteger

Max results to return (default 10, max 50)

cursorstring

Pagination cursor from a previous response's nextCursor

maxDistancenumber

Cosine-distance cutoff (smaller = stricter). The default of 0.7 works well for most queries. Use a higher value for broader matching or a lower value for stricter results. Distances above this threshold are excluded.

Example request

{
  "brandSessionId": "e6220a5e-4a68-4d39-8bb9-5105e9a3a164",
  "query": "Atlas Pro product packaging on a white background"
}

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.