Docs/Brand

GET/v1/brand15 credits

Brand

The curated brand identity: named color roles (primary, accent, background, text), the clean brand palette, primary fonts, the logo, and the social share image. The opinionated view - start here. Add &fields= to return only the parts you need.

  • Build UI "in the style of" a reference site - feed the colors and fonts to your generator.
  • Pre-fill a brand kit or theme from just a domain.
  • Power "trusted by" logo strips with a live logo URL.
Parameters
urlrequiredThe page to extract from. With or without protocol (https:// is assumed).
fieldsoptionalComma-separated list of fields to return (e.g. fields=logo,palette). Omit for the full object. url is always included. Trims the response only - the credit cost is unchanged. see the fields table below
fields values
titlePage / og:title - usually the brand name.
descriptionMeta / og:description of the site.
siteNameog:site_name, when the page declares one.
themeColorThe <meta name="theme-color"> the site declares about itself, when present.
colorsNamed color roles: primary, accent, background, text.
paletteFull brand palette, each { color, count }, most-used first.
fontsPrimary font families, most-prominent first.
logoBest single logo / icon URL.
logosAll logo / icon candidates, each tagged by source.
ogImageThe og:image social share URL, when present.

Build a request

GEThttps://miromiro.app/api/v1/v1/brand?url=stripe.com

urlrequired
fields

Nothing selected returns the full response.

Options at their default are left out of the URL - the API assumes them. Auth isn't shown here: send your key as an Authorization: Bearer header (see the example below).

Response

Authorization: Bearer mm_live_…
Response fields
urlstringThe resolved URL that was extracted.
titlestring | nullPage / og:title - usually the brand name.
descriptionstring | nullMeta / og:description of the site.
siteNamestring | nullog:site_name, when the page declares one.
themeColorstring | nullThe <meta name="theme-color"> the site declares, when present. A vivid theme-color also outranks usage-count guessing when picking colors.primary.
colors.primarystring | nullThe dominant brand color, as hex.
colors.accentstring | nullSecondary / accent color.
colors.backgroundstring | nullPage background color.
colors.textstring | nullPrimary body-text color.
palette[]arrayFull brand palette (up to 12 colors), each { color, count }, most-used first.
fonts[]string[]Primary font families (up to 4), most-prominent first.
logostring | nullBest-guess logo / icon URL.
logos[]arrayEvery logo / icon candidate, each { url, source, sizes }. source ∈ icon, apple-touch-icon, mask-icon, og.
ogImagestring | nullThe og:image social share URL, when present.
usageobjectMetering for this call: credits spent this month, your monthly cap (null = unlimited), credits remaining, what this call cost (0 on cache hits), and whether it was served from the 24-hour cache.

Example request

https://miromiro.app/api/v1/extract?url=stripe.com&access_key=mm_live_…