Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hermai.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Sign up

Create a free account at hermai.ai/register. No credit card required — the registry is fully free to use.

​
2. Create an API key

Go to Dashboard > API Keys and create a new key. Copy it — you’ll need it for authenticated requests. 
hm_sk_abc123...
Anonymous requests work too (5 per hour), but an API key gives you 50/hour and 500/day.

​
3. Query the catalog

Look up all known endpoints for a domain: 
curl -H "Authorization: Bearer hm_sk_abc123..." \
     -H "X-Hermai-Intent: looking up product endpoints on allbirds.com to build a price comparison agent" \
     "https://api.hermai.ai/v1/catalog/allbirds.com"
The response includes every endpoint and action the community has discovered: 
{
  "domain": "allbirds.com",
  "endpoints": [
    {
      "name": "shopify_products",
      "method": "GET",
      "url": "https://www.allbirds.com/products.json",
      "description": "Shopify store product catalog"
    },
    {
      "name": "add_to_cart",
      "method": "POST",
      "url": "https://www.allbirds.com/cart/add.js",
      "headers": { "Content-Type": "application/json" },
      "kind": "api_call",
      "params": [
        { "name": "id", "source": "body", "required": true },
        { "name": "quantity", "source": "body", "required": true }
      ]
    }
  ]
}

​
4. Call the endpoint directly

Use the URL, method, and headers from the catalog response to call the site yourself: 
curl -X POST "https://www.allbirds.com/cart/add.js" \
     -H "Content-Type: application/json" \
     -d '{"id": 41397031600208, "quantity": 1}'
That’s it. No browser, no proxy, no Hermai in the request path. You looked up the schema, you called the site directly.

​
5. Browse the registry

Explore what’s available at hermai.ai/schemas, or via the API: 
# List all schemas
curl "https://api.hermai.ai/v1/schemas"

# Filter by category
curl "https://api.hermai.ai/v1/schemas?category=commerce"

# Only verified schemas
curl "https://api.hermai.ai/v1/schemas?verified=true"

# Browse the intent taxonomy
curl "https://api.hermai.ai/v1/categories"

​
6. Contribute a schema

Found a site that’s missing? Document its endpoints with the CLI and push the schema: 
# Install the CLI
go install github.com/hermai-ai/hermai-cli/cmd/hermai@latest

# Classify the site + find its public paths
hermai detect https://example.com
hermai wellknown example.com

# Pull embedded data from a detail page
hermai probe --body https://example.com/products/123 | hermai extract

# Capture XHR traffic for dynamic pages (search, cart, etc.)
hermai intercept https://example.com/search?q=test

# Author schema.json (see /concepts/schemas), then push
hermai registry push schema.json
Using Claude Code, Codex, or Cursor? Run npx skills add hermai-ai/hermai-skills and your agent will do the discovery and push for you. See the hermai-skills repo for details.
You earn +50 credits per site for contributions. Credits become your starting balance when hosted execution launches.

​
Next steps