# Docs for AI coding tools

> Give Claude Code, Cursor, Copilot and other AI tools these docs as plain Markdown, and the OpenAPI schema for generating clients.

If you build your integration with an AI coding tool, give it these docs. Every page is published as plain Markdown, which AI tools read better and more cheaply than web pages.

## The files

| URL                                      | What it is                                                                                                               |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| [/llms.txt](https://hirehappy.io/llms.txt)                   | An index of the docs, with a line on each page, following [llmstxt.org](https://llmstxt.org)                             |
| [/llms-full.txt](https://hirehappy.io/llms-full.txt)         | All the guides and the whole API reference, in one file                                                                  |
| `/docs/{page}.md`                        | Any page as Markdown: [/docs/quickstart.md](https://hirehappy.io/docs/quickstart.md), [/docs/api/applications.md](https://hirehappy.io/docs/api/applications.md) |
| [/docs/openapi.json](https://hirehappy.io/docs/openapi.json) | The API's OpenAPI 3.1 schema                                                                                             |

Every page also has **Copy page** and **View as Markdown** buttons under its title, for pasting into a chat.

## In your prompt

Point your tool at the index, and it fetches the pages it needs:

```text
Build a script that syncs hired candidates from HireHappy to our HR system.
The HireHappy API docs are at https://hirehappy.io/llms.txt; read the pages you need.
```

Or, for a tool that can't fetch, paste in `llms-full.txt` or the pages the task needs.

## Generating a client

The OpenAPI schema describes every endpoint, parameter and field, with descriptions. Generate typed clients from it:


```bash
npx openapi-typescript https://hirehappy.io/docs/openapi.json -o hirehappy.d.ts
```

```bash
uvx openapi-python-client generate --url https://hirehappy.io/docs/openapi.json
```


It imports into Postman, Insomnia and Bruno too. Each operation also carries the scope it needs, as `x-required-scope`.

## Your own AI app

Want your AI assistant itself to work with HireHappy, rather than write code for it? That's the [MCP server](https://hirehappy.io/docs/mcp).
