Quickstart

Create a free account at hermai.ai/register. The registry is free to browse.

2. Create an API key

Go to Dashboard > API Keys and create a new key. Copy it once you create it. You need it for authenticated requests.

hm_sk_abc123...

Some registry browsing requests work anonymously, but hosted fetch requires an API key. Brand retrieval bills one ordinary credit per completed profile, from the same credit pool as every other endpoint. Pending checks and failed results are free. See the Brand API page for the full request and response contract.

3. Run hosted fetch

Call a registered endpoint through Hermai:

export HERMAI_API_KEY="hm_sk_abc123..."

curl -sS -X POST "https://api.hermai.ai/v1/fetch" \
  -H "Authorization: Bearer ${HERMAI_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "site": "semanticscholar.org",
    "endpoint": "get_paper",
    "params": {
      "paper_id": "ARXIV:1706.03762",
      "fields": "paperId,externalIds,title,authors,venue,year,referenceCount,citationCount,openAccessPdf"
    }
  }'

Response:

{
  "success": true,
  "data": {
    "paperId": "204e3073870fae3d05bcbc2f6a8e263d9b72e776",
    "title": "Attention is All you Need",
    "year": 2017
  },
  "meta": {
    "site": "semanticscholar.org",
    "endpoint": "get_paper",
    "method": "GET",
    "source": "gateway",
    "latency_ms": 1234,
    "credits_used": 1,
    "credits_remaining": 999,
    "cached": false
  }
}

4. Browse available schemas

Explore what’s available at hermai.ai/schemas, or via the API:

# List all schemas
curl "https://api.hermai.ai/v1/schemas"

# Get one public schema card
curl "https://api.hermai.ai/v1/schemas/semanticscholar.org"

Public schema cards show the site, description, endpoint names, methods, purposes, and user-facing readiness signals.

5. Pull a package or self execute

If you want your own agent or server to execute requests directly, pull the catalog or full package with an intent:

curl -H "Authorization: Bearer ${HERMAI_API_KEY}" \
     -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"

curl -H "Authorization: Bearer ${HERMAI_API_KEY}" \
     -H "X-Hermai-Intent: downloading Semantic Scholar metadata routes for citation enrichment" \
     "https://api.hermai.ai/v1/schemas/semanticscholar.org/package"

The catalog and package routes return the endpoint recipe. POST /v1/fetch executes a registered endpoint through Hermai.

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 to add the Hermai registry workflow. See the hermai-skills repo for details.

You earn +50 credits per site for contributions. Credits are tracked in your dashboard and can be used for hosted execution where available.

Next steps

How Hermai works: the runtime model
Hosted fetch: run registered endpoints through Hermai
Schemas: format, verification, contributing
Catalog: the lookup API in detail
API keys: scopes and rate limits

Getting started

Core concepts

2. Create an API key

3. Run hosted fetch

4. Browse available schemas

5. Pull a package or self execute

6. Contribute a schema

Next steps

​1. Sign up

​2. Create an API key

​3. Run hosted fetch

​4. Browse available schemas

​5. Pull a package or self execute

​6. Contribute a schema

​Next steps

1. Sign up

2. Create an API key

3. Run hosted fetch

4. Browse available schemas

5. Pull a package or self execute

6. Contribute a schema

Next steps