Brand retrieval from email or domain
Send a work email or company domain to the Brand API to resolve a customer’s company identity during signup or account setup.
Hermai Brand API
Freemium
Hermai Brand API helps B2B SaaS products apply a customer’s identity during signup. A single API request can return the company name, description, logo, source evidence, and an accessible application theme from a work email or company domain.
Hermai Brand APIとは？
Hermai Brand API is a white-labeling and onboarding API for B2B SaaS products. A work email or company domain can be used to retrieve a customer’s company identity and an application theme that the SaaS product can apply to its own interface.
The response can include the company name, description, logo delivery, source evidence, and theme colors. The documented example returns brand fields with source URLs and signals, plus colors for actions, text on actions, tints, and focus states. Applications decide which supported surfaces to brand.
The API is intended for signup and account-provisioning flows. It can recognize a customer without asking them to upload a logo or configure branding manually, and the returned description can prefill editable profile fields. Hermai’s documented flow reads the email domain rather than retaining the mailbox name.
Branding is bounded by application guardrails: customer identity can shape selected interface surfaces, while status meaning, semantic colors, body text, code, API keys, layout, type, and behavior remain fixed. Returned colors are contrast checked, and a fallback can keep the product’s existing theme.
Hermai Brand APIでできること
Structured company profile data
The documented response can provide a company name and description, with source evidence including the originating URL and detection signal for returned fields.
Application theme output
The response includes an application theme with colors such as action, on-action, tint, and focus values that a SaaS product can map to its own theme system.
Brand-safe application rules
The site specifies where customer branding belongs, including logos, company names, selected navigation, primary actions, focus states, and subtle context surfaces, while preserving semantic product meaning.
Contrast checking and fallback
Colors are contrast checked before delivery, and a fallback is available so the application can retain its own theme when a customer theme is unavailable.
Local preview workflow
The `brand-preview` skill for Claude Code and Codex lets teams preview five branded versions of their own application before connecting the live API.
利用シーン
“Signup personalization”
Call the API when a new customer registers, then use the returned identity and theme to make the first session reflect that customer instead of showing a generic trial experience.
“Profile form prefill”
Use the returned company description to prefill an editable customer profile field, reducing manual setup while leaving the customer in control of the final text.
“White-labeled customer workspaces”
Apply the customer logo, company name, selected colors, and approved interface surfaces to workspaces, portals, dashboards, or other account-level views.
“Preview before implementation”
Run the local preview skill from an application root to inspect how multiple real brand results appear across a dashboard before enabling production retrieval.
よくある質問
What input does the Brand API accept?
The documented request uses a work email, and the site also describes sending a company domain. In the email workflow, Hermai reads the domain portion; the mailbox name is stated not to be stored.
What can a completed brand retrieval return?
The documented response includes a company name, company description, source evidence, and an application theme with color values. The product page also describes logo delivery as part of the workflow.
Where should customer branding be applied?
The site recommends customer branding for identity and selected interface surfaces such as the logo, company name, primary actions, selected navigation, focus states, and one nonsemantic data series. Errors, warnings, destructive actions, semantic data colors, body text, code, API keys, layout, type, and behavior should retain product meaning.
How is Brand API usage billed?
The pricing page states that one completed brand profile costs one credit from the shared Hermai credit pool. Pending checks, unsuccessful results, and logo delivery are not billed. Public plans include Free, Starter, and Pro allowances; custom or private sources and enterprise requirements are handled through sales.
Can a team test the result before using the live API?
Yes. Hermai provides a `brand-preview` skill for Claude Code and Codex. The documented workflow runs it from the application root to preview branded versions before the live API is connected.
クイック情報
- Product type
- Branding and onboarding API for B2B SaaS
- Primary input
- Work email or company domain
- Documented endpoint
- POST /v1/brand/retrieve
- Core outputs
- Company identity, description, application theme, and source evidence
- Preview tools
- Claude Code and Codex via the brand-preview skill
- Billing unit
- One credit per completed brand profile
Hermai Brand API のトラフィック分析
トラフィックデータは参考情報としてご利用ください。
- ドメイン評価
- 27
