# agentled API

> Programmatic access to the agentled AI Search monitor.

- [Introduction](https://docs.agentled.co/introduction.md): The agentled API — manage brands and prompts and read AI Search results programmatically.
- [Authentication](https://docs.agentled.co/authentication.md): Create an API key and send it with every request.
- [Quickstart](https://docs.agentled.co/quickstart.md): Create a brand, add a prompt, and read its results in a few calls.
- [Concepts](https://docs.agentled.co/concepts.md): Brands, prompts, location, and plan limits.
- [Errors & pagination](https://docs.agentled.co/errors.md): The error shape, status codes, and how to page through lists.
- [Get the account's plan](https://docs.agentled.co/api-reference/plan/get-the-accounts-plan.md): The account's plan and the capability limits it grants.
- [List brands](https://docs.agentled.co/api-reference/brands/list-brands.md): The account's brands, newest first.
- [Create a brand](https://docs.agentled.co/api-reference/brands/create-a-brand.md): Create a brand from a website. The name, description and logo are enriched automatically in the background. **No prompts are created** — add them with `POST /brands/{id}/prompts`, and note that a brand with no active prompts is never scanned.
- [Get a brand](https://docs.agentled.co/api-reference/brands/get-a-brand.md)
- [Set a brand's location](https://docs.agentled.co/api-reference/brands/set-a-brands-location.md): Update the brand's measurement location — the market the AI answers are measured from. Send `mode: "worldwide"` to clear any country/city scope. Use the Geo endpoints to discover valid `country` and `city` values.
- [List a brand's prompts](https://docs.agentled.co/api-reference/prompts/list-a-brands-prompts.md): The brand's prompts. Returns both active and disabled prompts by default; filter with `?active=true` or `?active=false`. Disabling a prompt is a soft delete — it is kept for history and can be re-enabled.
- [Add a prompt](https://docs.agentled.co/api-reference/prompts/add-a-prompt.md): Add an active prompt to the brand. Counts against your account-wide prompt limit (across all brands); exceeding it returns 409.
- [Edit or enable/disable a prompt](https://docs.agentled.co/api-reference/prompts/edit-or-enabledisable-a-prompt.md): Change a prompt's `text`, its `active` state, or both. Send at least one. Prompts are never hard-deleted: `active:false` disables (keeps scan history), `active:true` re-enables (and counts against your prompt limit again).
- [List a prompt's answers](https://docs.agentled.co/api-reference/answers/list-a-prompts-answers.md): The answer this prompt got in each completed scan, newest first, with the brands named and the domains cited. Pages over completed scan runs, so a page can hold fewer than `limit` answers when a run had no answer for this prompt.
- [Get a brand's metrics](https://docs.agentled.co/api-reference/metrics/get-a-brands-metrics.md): AI-visibility metrics for the brand over a trailing window: how often it is named, the leaderboard against competitors, citation share, per-prompt detail and a trend series.
- [List a brand's scans](https://docs.agentled.co/api-reference/scans/list-a-brands-scans.md): The brand's scan runs, newest first. Default page size here is 90.
- [Get a scan](https://docs.agentled.co/api-reference/scans/get-a-scan.md)
- [List countries](https://docs.agentled.co/api-reference/geo/list-countries.md): Every country a brand can be scoped to. Each `code` is the value to send as `location.country` on `PATCH /brands/{id}`.
- [List a country's cities](https://docs.agentled.co/api-reference/geo/list-a-countrys-cities.md): Cities that can be sent as `location.city` for the country (major cities, population ≥ 100k). An empty list means only country-level scope is available.

## OpenAPI Specs

- [openapi](https://agentled.co/api/v1/openapi.json)