Hermai Brand API

Product Introduction

1. Definition: The Hermai Brand API is a specialized B2B SaaS API (Application Programming Interface) that automates brand data retrieval and theming. It is a technical tool that accepts a work email address or company domain as input and returns structured JSON data containing the company's verified logo, accessible color palette, official description, and a pre-configured application theme object.
2. Core Value Proposition: It exists to enable instant, automated white-labeling and personalization for B2B software platforms. Its core value is eliminating the manual, time-consuming process of collecting and applying customer branding, thereby allowing SaaS products to deliver a personalized, on-brand experience from the user's first login without any manual input from the customer or internal teams.

Main Features

1. Automated Brand Data Retrieval: The API performs real-time web scraping and structured data parsing from a company's official website. It extracts key brand identity elements, including the company name, logo URL, and meta description. Each returned data field includes a source object with the origin URL and signal type (e.g., json_ld, html_meta), providing transparency and evidence for the data's origin.
2. Accessible Application Theme Generation: Beyond simple data fetching, the API's core technical feature is its theme engine. It processes the extracted brand colors to generate a complete, WCAG-compliant application_theme object. This includes semantically named color variables (action, on_action, tint, focus) that have been automatically contrast-checked for accessibility, ensuring the generated theme is usable and safe by default for integration into any dashboard UI.
3. Privacy-Centric Email Processing: The system is engineered for data privacy. It only reads and processes the domain portion of a submitted work email (e.g., graza.co from [email protected]). The local-part (the mailbox name) is never stored or analyzed, aligning with modern data protection standards and reducing compliance overhead for implementers.

Problems Solved

1. Pain Point: It solves the operational inefficiency and poor user experience caused by manual brand onboarding. Traditional methods require customers to upload logos, define hex codes, and fill out company profiles—steps that are often skipped, leading to generic, unbranded accounts. This creates a disjointed experience and can become a barrier in enterprise sales cycles where white-labeling is a requirement.
2. Target Audience: Primary users are Product Managers and Engineering Leads at B2B SaaS companies building client-facing dashboards, portals, or internal tools. Secondary users include UX/UI Designers tasked with implementing consistent theming systems and Growth Marketers focused on improving onboarding conversion and perceived product value.
3. Use Cases: Essential for automated white-labeling of customer accounts upon signup; intelligent form pre-filling for company profiles during onboarding; brand-consistent UI theming for client portals and proposal tools; and agentic enrichment where AI assistants within an app use the company description for contextual reasoning and personalized suggestions.

Unique Advantages

1. Differentiation: Unlike generic logo APIs or manual processes, Hermai Brand API is a purpose-built pipeline for SaaS onboarding. It differs from manual collection by being fully automated, and from basic favicon/fetch services by returning a production-ready, accessible theme object with source-verified data, not just a single asset.
2. Key Innovation: Its key innovation is the synthesis of brand intelligence and applied design systems. The API doesn't just find data; it interprets and structures it into a theming schema that maps directly to a SaaS application's component library (buttons, nav bars, data visualizations). The built-in "guardrails" that dictate where customer branding should and should not be applied is a unique framework for maintaining product integrity.

Frequently Asked Questions (FAQ)

1. How does the Hermai Brand API handle incorrect or missing brand data? The API includes a robust fallback system. If a logo cannot be reliably found or colors fail accessibility checks, the application_theme object will contain a fallback value, and your application can default to your own safe, product-specific theme, ensuring UI consistency is never broken.
2. Is the Hermai Brand API suitable for high-volume signup platforms? Yes, it is architected for scalability. With a free tier of 1,000 brand retrievals per month and clear, consumption-based pricing (one credit per successful result), it is designed to handle volume efficiently. Unsuccessful lookups or pre-flight checks do not consume credits, making it cost-effective for automated pipelines.
3. Can I test the API's output on my application before integration? Absolutely. Hermai provides "local skills" for Claude Code and Codex (e.g., npx skills add hermai-ai/hermai-skills). These allow developers to run a command from their app's root directory to generate a live preview of their own dashboard styled with five different real-world company brands, facilitating rapid prototyping.
4. What makes the Hermai API more reliable than a simple web scraper I could build? Reliability comes from its specialized schema catalog and evidence-based sourcing. It doesn't just scrape; it looks for structured data signals (like JSON-LD), verifies sources, and performs validation (e.g., color contrast checking). This focused approach on brand-specific data points yields higher accuracy than a general-purpose scraper for this specific use case.