# Build with AI

Drop Ideal Postcodes into any AI workflow, from coding agents driving a repo to chat-driven app builders generating a frontend.

## Quick start

1. **Give your agent the docs.** Paste [llms.txt](https://docs.ideal-postcodes.co.uk/llms.txt) into the model's context.

2. **Get an API key.**

   * **Quick test:** use `ak_test`. Public, capped at 5 lookups/day, will break in production.
   * **Real testing:** [sign up](https://account.ideal-postcodes.co.uk/users/sign_up) for a free trial key with a real test balance. There are three ways to sign up: MCP (coming soon), CLI (`idpc keys create`) or the [web dashboard](https://account.ideal-postcodes.co.uk/users/sign_up).

3. **Lock it down before going live.** Restrict the key to your origin via [Allowed URLs](/docs/guides/allowed-urls.md).

## Resources

Ordered by what an agent should reach for first.

* **[llms.txt](https://docs.ideal-postcodes.co.uk/llms.txt)**: full API reference, integration guides and widget docs as one file. Paste into a model's context, or wire into a docs MCP server like [Context7](https://context7.com/).
* **MCP server**: **coming soon.** Will surface API docs, dataset metadata and key management as MCP tools.
* **[CLI](/docs/cli.md)**: `npm install -g @ideal-postcodes/cli`. Built for agents: JSON output in non-TTY, stable exit codes, no interactive prompts under pipes. Subcommands: `auth`, `keys`, `cleanse`, `find`, `lookup`. Use a backend key (no Allowed URLs).
* **[Address Finder](/docs/address-finder.md)**: address autocomplete widget. Works in the UK and internationally. Use when users type the address directly into the form.
* **[Postcode Lookup](/docs/postcode-lookup.md)**: postcode → address dropdown. Supports countries with efficient postcode systems (UK, Ireland, Singapore, Netherlands). Use when users enter a postcode first.
* **Per-page markdown**: append `.md` to any docs URL for the plain-text version (e.g. [`/docs/address-finder.md`](https://docs.ideal-postcodes.co.uk/docs/address-finder.md)).

## AI builder guides

Per-platform setup, prompts and key-storage instructions live in [Build with AI integrations](/docs/integrations/build-with-ai.md).

| Coding agents                                          | AI app builders                                              |
| ------------------------------------------------------ | ------------------------------------------------------------ |
| [Claude Code](/docs/integrations/claude-code.md)       | [Lovable](/docs/integrations/lovable.md)                     |
| [Cursor](/docs/integrations/cursor.md)                 | [Bolt](/docs/integrations/bolt.md)                           |
| [Codex](/docs/integrations/codex.md)                   | [v0](/docs/integrations/v0.md)                               |
| [Windsurf](/docs/integrations/windsurf.md)             | [Replit](/docs/integrations/replit.md)                       |
| [GitHub Copilot](/docs/integrations/github-copilot.md) | [base44](/docs/integrations/base44.md)                       |
|                                                        | [Leap.new](/docs/integrations/leap-new.md)                   |
|                                                        | [shadcn registry](/docs/integrations/shadcn.md), coming soon |

## Need help?

* File an issue: [github.com/ideal-postcodes/feedback](https://github.com/ideal-postcodes/feedback/issues)
* Email: <support@ideal-postcodes.co.uk>