Skip to main content
POST
brand.profile.read

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by brand.profile.get.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
includeAssets
boolean
default:false

Copy available images to file storage. When false, return metadata only.

assetSize
integer
default:800

Copied image size in pixels, 1 to 800. Default 800.

Required range: 1 <= x <= 800
assetFormat
enum<string>
default:png

Copied image format. Default png.

Available options:
png,
jpg,
webp
theme
enum<string>
default:light

Rendered image theme. Default light.

Available options:
light,
dark
bannerLimit
integer
default:10

Maximum banners to project, 0 to 25. Default 10; copies total at most 50 MiB.

Required range: 0 <= x <= 25

Response

The result

name
string
required

Brand display name.

socials
object[]
required

Published social profile links.

palette
object[]
required

Logo palette, dominant colors first; not website style roles.

banners
object[]
required

Projected social banner metadata and optional copies.

bannersOmitted
boolean
required

Whether bannerLimit omitted additional banners.

domain
string

Brand website domain, when available.

description
string

Public brand description.

indexedAt
string

When the profile was refreshed.

containsProfanity
boolean

Whether the brand may include explicit imagery.

Primary logo metadata and optional copy.

brandmark
object

Wide logo lockup metadata and optional copy.

resolution
object

Lookup resolution, when available.