Hermai Brand API · Schema
BrandEnvelope
The full POST /v1/brand/retrieve response. status=pending carries an empty brand object plus a poll token in pending.token; repost the token to POST /v1/brand/poll.
CompanyBrandingMarketingSoftware-as-a-Service
Properties
| Name | Type | Description |
|---|---|---|
| application_theme | object | |
| assembled_at | string | |
| brand | object | |
| pending | object | |
| refresh | object | |
| requested | object | |
| resolved | object | |
| status | string | ok: full profile. partial: some fields missing. pending: still running, poll with the returned token. personal_email/disposable_email: the input email was rejected before lookup. not_found: the domain |
| usage | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hermai/main/json-schema/hermai-brand-envelope-schema.json",
"title": "BrandEnvelope",
"description": "The full POST /v1/brand/retrieve response. status=pending carries an empty brand object plus a poll token in pending.token; repost the token to POST /v1/brand/poll.",
"x-generated": "2026-10-18",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/_original/hermai-api-openapi.json#/components/schemas/BrandEnvelope",
"properties": {
"application_theme": {
"$ref": "#/$defs/BrandApplicationTheme"
},
"assembled_at": {
"format": "date-time",
"type": "string"
},
"brand": {
"$ref": "#/$defs/BrandObject"
},
"pending": {
"anyOf": [
{
"properties": {
"poll_after_ms": {
"type": "integer"
},
"token": {
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"refresh": {
"properties": {
"clamped": {
"type": "boolean"
},
"state": {
"enum": [
"fresh",
"refreshing",
"stale"
],
"type": "string"
}
},
"type": "object"
},
"requested": {
"properties": {
"domain": {
"type": "string"
},
"input_type": {
"enum": [
"domain",
"email"
],
"type": "string"
}
},
"type": "object"
},
"resolved": {
"properties": {
"ambiguity": {
"anyOf": [
{
"enum": [
"parked",
"multi_brand",
"unresolved"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonical_domain": {
"type": "string"
},
"redirect_terminal": {
"type": "string"
}
},
"type": "object"
},
"status": {
"description": "ok: full profile. partial: some fields missing. pending: still running, poll with the returned token. personal_email/disposable_email: the input email was rejected before lookup. not_found: the domain does not resolve to a live site. fetch_failed: the site could not be fetched.",
"enum": [
"ok",
"partial",
"pending",
"personal_email",
"disposable_email",
"not_found",
"fetch_failed"
],
"type": "string"
},
"usage": {
"$ref": "#/$defs/BrandUsage"
}
},
"type": "object",
"$defs": {
"BrandApplicationTheme": {
"properties": {
"colors": {
"anyOf": [
{
"description": "Present only when a usable accent was observed.",
"properties": {
"action": {
"type": "string"
},
"border": {
"type": "string"
},
"data_primary": {
"type": "string"
},
"focus": {
"type": "string"
},
"on_action": {
"type": "string"
},
"on_tint": {
"type": "string"
},
"text_accent": {
"type": "string"
},
"tint": {
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"fallback": {
"anyOf": [
{
"properties": {
"reason": {
"type": "string"
},
"strategy": {
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"identity": {
"properties": {
"compact": {
"properties": {
"asset": {
"anyOf": [
{
"$ref": "#/$defs/BrandLogoAsset"
},
{
"type": "null"
}
]
},
"fallback": {
"type": "string"
},
"show_company_name": {
"type": "boolean"
}
},
"type": "object"
},
"on_dark": {
"properties": {
"asset": {
"anyOf": [
{
"$ref": "#/$defs/BrandLogoAsset"
},
{
"type": "null"
}
]
},
"fallback": {
"type": "string"
},
"show_company_name": {
"type": "boolean"
}
},
"type": "object"
},
"standard": {
"properties": {
"asset": {
"anyOf": [
{
"$ref": "#/$defs/BrandLogoAsset"
},
{
"type": "null"
}
]
},
"fallback": {
"type": "string"
},
"show_company_name": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"mode": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"BrandColorEntry": {
"properties": {
"brightness": {
"description": "WCAG relative luminance, 0 to 1.",
"type": "number"
},
"derivation": {
"description": "declared: found explicitly on the page (theme-color, manifest). derived: computed from an asset (for example quantized from a logo).",
"enum": [
"declared",
"derived"
],
"type": "string"
},
"hex": {
"type": "string"
},
"observed_at": {
"format": "date-time",
"type": "string"
},
"origin": {
"enum": [
"observed",
"inferred",
"synthesized",
"corrected"
],
"type": "string"
},
"role": {
"enum": [
"accent",
"background",
"text",
"neutral"
],
"type": "string"
},
"source": {
"properties": {
"signal": {
"description": "The extraction signal that produced this value.",
"enum": [
"bimi",
"json_ld",
"manifest",
"apple_touch_icon",
"link_icon",
"header_dom",
"meta_og",
"meta_theme_color",
"css_var",
"render_computed",
"llm_classified",
"manual_correction",
"page_title",
"registrable_domain",
"logo_derived",
"meta_description"
],
"type": "string"
},
"url": {
"description": "The page or record this value was observed on.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"BrandFont": {
"properties": {
"name": {
"type": "string"
},
"observed_at": {
"format": "date-time",
"type": "string"
},
"origin": {
"enum": [
"observed",
"inferred",
"synthesized",
"corrected"
],
"type": "string"
},
"source": {
"properties": {
"signal": {
"description": "The extraction signal that produced this value.",
"enum": [
"bimi",
"json_ld",
"manifest",
"apple_touch_icon",
"link_icon",
"header_dom",
"meta_og",
"meta_theme_color",
"css_var",
"render_computed",
"llm_classified",
"manual_correction",
"page_title",
"registrable_domain",
"logo_derived",
"meta_description"
],
"type": "string"
},
"url": {
"description": "The page or record this value was observed on.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"BrandLinks": {
"properties": {
"blog": {
"$ref": "#/$defs/BrandNullableStringField"
},
"careers": {
"$ref": "#/$defs/BrandNullableStringField"
},
"contact": {
"$ref": "#/$defs/BrandNullableStringField"
},
"pricing": {
"$ref": "#/$defs/BrandNullableStringField"
},
"privacy": {
"$ref": "#/$defs/BrandNullableStringField"
},
"terms": {
"$ref": "#/$defs/BrandNullableStringField"
}
},
"type": "object"
},
"BrandLogoAsset": {
"properties": {
"asset_version": {
"type": "string"
},
"format": {
"enum": [
"svg",
"png",
"webp",
"jpeg"
],
"type": "string"
},
"height": {
"type": "integer"
},
"kind": {
"enum": [
"icon",
"wordmark",
"symbol",
"unknown"
],
"type": "string"
},
"observed_at": {
"format": "date-time",
"type": "string"
},
"origin": {
"enum": [
"observed",
"inferred",
"synthesized",
"corrected"
],
"type": "string"
},
"source": {
"properties": {
"signal": {
"description": "The extraction signal that produced this value.",
"enum": [
"bimi",
"json_ld",
"manifest",
"apple_touch_icon",
"link_icon",
"header_dom",
"meta_og",
"meta_theme_color",
"css_var",
"render_computed",
"llm_classified",
"manual_correction",
"page_title",
"registrable_domain",
"logo_derived",
"meta_description"
],
"type": "string"
},
"url": {
"description": "The page or record this value was observed on.",
"type": "string"
}
},
"type": "object"
},
"theme": {
"anyOf": [
{
"enum": [
"light",
"dark",
"universal"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "null when theme classification is uncertain, never a guess."
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
}
},
"type": "object"
},
"BrandNullableStringField": {
"anyOf": [
{
"properties": {
"observed_at": {
"format": "date-time",
"type": "string"
},
"origin": {
"enum": [
"observed",
"inferred",
"synthesized",
"corrected"
],
"type": "string"
},
"source": {
"properties": {
"signal": {
"description": "The extraction signal that produced this value.",
"enum": [
"bimi",
"json_ld",
"manifest",
"apple_touch_icon",
"link_icon",
"header_dom",
"meta_og",
"meta_theme_color",
"css_var",
"render_computed",
"llm_classified",
"manual_correction",
"page_title",
"registrable_domain",
"logo_derived",
"meta_description"
],
"type": "string"
},
"url": {
"description": "The page or record this value was observed on.",
"type": "string"
}
},
"type": "object"
},
"value": {
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"BrandObject": {
"properties": {
"colors": {
"items": {
"$ref": "#/$defs/BrandColorEntry"
},
"type": "array"
},
"description": {
"$ref": "#/$defs/BrandNullableStringField"
},
"favicon": {
"anyOf": [
{
"$ref": "#/$defs/BrandLogoAsset"
},
{
"type": "null"
}
]
},
"fonts": {
"items": {
"$ref": "#/$defs/BrandFont"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/BrandLinks"
},
"logos": {
"items": {
"$ref": "#/$defs/BrandLogoAsset"
},
"type": "array"
},
"name": {
"$ref": "#/$defs/BrandNullableStringField"
},
"socials": {
"items": {
"$ref": "#/$defs/BrandSocial"
},
"type": "array"
}
},
"type": "object"
},
"BrandSocial": {
"properties": {
"observed_at": {
"format": "date-time",
"type": "string"
},
"origin": {
"enum": [
"observed",
"inferred",
"synthesized",
"corrected"
],
"type": "string"
},
"source": {
"properties": {
"signal": {
"description": "The extraction signal that produced this value.",
"enum": [
"bimi",
"json_ld",
"manifest",
"apple_touch_icon",
"link_icon",
"header_dom",
"meta_og",
"meta_theme_color",
"css_var",
"render_computed",
"llm_classified",
"manual_correction",
"page_title",
"registrable_domain",
"logo_derived",
"meta_description"
],
"type": "string"
},
"url": {
"description": "The page or record this value was observed on.",
"type": "string"
}
},
"type": "object"
},
"type": {
"enum": [
"twitter",
"facebook",
"instagram",
"linkedin",
"youtube",
"tiktok",
"github",
"discord",
"pinterest",
"threads",
"mastodon",
"other"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"BrandUsage": {
"properties": {
"credits_consumed": {
"type": "integer"
},
"credits_remaining": {
"type": "integer"
}
},
"type": "object"
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/hermai-brand-envelope"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.