POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/search

Submit an image and find the n closest matches from the scanned images index without creating any match records. Returns similarity scores and metadata for each match.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
showHistoric String No

Include scanned images without domain metadata (historic data). Default: false (only show images with domain)

Default value: "false"

download String No

If true, include base64-encoded image data in the response

Request body fields

Name Type Required Description
top_k Integer No

Number of closest matches to return (1-100, default: 10)

Default value: 10

image_data String Yes

Base64 encoded image data. Can include data URI prefix (e.g., 'data:image/png;base64,...') or just the base64 string.

score_threshold Number No

Minimum similarity score threshold for matches (0-1, default: 0)

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.