API Reference

Brand Protection

V2

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Logos

Insert logo query

client.brandProtection.v2.logos.create(LogoCreateParams { account_id, image_data, similarity_threshold, 2 more } params, RequestOptionsoptions?): LogoCreateResponse { message, success, query_id }

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

Delete logo query

client.brandProtection.v2.logos.delete(stringqueryId, LogoDeleteParams { account_id } params, RequestOptionsoptions?): LogoDeleteResponse { message, success }

DELETE/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id}

Get logo queries

client.brandProtection.v2.logos.get(LogoGetParams { account_id, id, download } params, RequestOptionsoptions?): LogoGetResponse { id, r2_path, similarity_threshold, 4 more }

GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries

ModelsExpand Collapse

LogoCreateResponse { message, success, query_id }

message: string

success: boolean

query_id?: number

LogoDeleteResponse { message, success }

message: string

success: boolean

LogoGetResponse = Array<LogoGetResponseItem>

id: number

r2_path: string

similarity_threshold: number

tag: string

uploaded_at: string | null

content_type?: string

MIME type of the image (only present when download=true)

image_data?: string

Base64-encoded image data (only present when download=true)