> ## 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.

# Introduction

> Hermai is a community-driven schema registry for website APIs.

Hermai is a schema registry and hosted fetch API for website workflows. Look up a domain to find callable endpoints, then either execute the endpoint yourself or call Hermai's hosted `/v1/fetch` API.

Use it as a shared package index for website APIs.

## How it works

<CardGroup cols={2}>
  <Card title="Contribute with the CLI" icon="terminal">
    Use the discovery toolkit (`hermai detect`, `probe`, `extract`, `intercept`) to document a site's endpoints, then `hermai registry push` to add them to the catalog.
  </Card>

  <Card title="Look up from the registry" icon="magnifying-glass">
    Call `GET /v1/catalog/{domain}` to get known endpoints for a site. Community schemas let callers reuse prior discovery work.
  </Card>

  <Card title="Run hosted fetch" icon="cloud-arrow-down">
    Call `POST /v1/fetch` with a site, endpoint, and params. Hermai executes the registered endpoint and returns structured JSON.
  </Card>
</CardGroup>

<Tip>
  **Using Claude Code, Codex, Cursor, or another coding agent?** Install the [Hermai skills](https://github.com/hermai-ai/hermai-skills) with `npx skills add hermai-ai/hermai-skills` to give it the registry workflow.
</Tip>

## Start here

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Create an API key and run one hosted fetch.
  </Card>

  <Card title="How Hermai works" icon="wand-magic-sparkles" href="/concepts/how-hermai-works">
    What runs locally, what Hermai stores, and when hosted fetch runs.
  </Card>

  <Card title="Hosted fetch" icon="cloud-arrow-down" href="/concepts/hosted-fetch">
    Run registered endpoints through Hermai.
  </Card>

  <Card title="Schemas" icon="database" href="/concepts/schemas">
    What schemas are, how to contribute them, and the verified badge.
  </Card>

  <Card title="Catalog" icon="compass" href="/concepts/catalog">
    The lookup API for runtime schema access.
  </Card>

  <Card title="Actions" icon="hand-pointer" href="/concepts/actions">
    Read and write actions that schemas expose.
  </Card>

  <Card title="API keys" icon="key" href="/concepts/api-keys">
    Authenticate requests and manage access.
  </Card>
</CardGroup>

## Open source

The [hermai-cli](https://github.com/hermai-ai/hermai-cli) is open source under AGPL-3.0. You can run discovery locally without an account. The platform registry adds browse, search, and hosted fetch on top.