# Build with AI

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

## Prerequisite: API key[​](#prerequisite-api-key "Direct link to Prerequisite: API key")

* **Quick test:** use `ak_test`. Public, capped at 5 lookups/day, will break in production.
* **Real testing:** [sign up](https://ideal-postcodes.co.uk/signup) for a free trial key with a real test balance.
* **Three ways to sign up:** MCP (coming soon), CLI (`idpc keys create`), or the [web dashboard](https://ideal-postcodes.co.uk/signup).
* **Lock it down before going live:** restrict the key to your origin via [Allowed URLs](/docs/guides/allowed-urls.md).

## Resources[​](#resources "Direct link to 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](https://github.com/ideal-postcodes/cli)** — `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)** — multi-country address autocomplete widget. Use when the form takes international addresses.
* **[Postcode Lookup](/docs/postcode-lookup.md)** — UK postcode → address dropdown. Use when the form is UK-only and the user enters 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[​](#ai-builder-guides "Direct link to 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[​](#coding-agents "Direct link to Coding Agents")

* [Claude Code](/docs/integrations/claude-code.md)
* [Cursor](/docs/integrations/cursor.md)
* [Codex](/docs/integrations/codex.md)
* [Windsurf](/docs/integrations/windsurf.md)
* [GitHub Copilot](/docs/integrations/github-copilot.md)

### AI App Builders[​](#ai-app-builders "Direct link to AI App Builders")

* [Lovable](/docs/integrations/lovable.md)
* [Bolt](/docs/integrations/bolt.md)
* [v0](/docs/integrations/v0.md)
* [Replit](/docs/integrations/replit.md)
* [base44](/docs/integrations/base44.md)
* [Leap.new](/docs/integrations/leap-new.md)
* [Anychat](/docs/integrations/anychat.md)
* [shadcn registry](/docs/integrations/shadcn.md) — coming soon

## Need help?[​](#need-help "Direct link to Need help?")

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