> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qwairy.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoint catalog

> Find every REST API v1 operation by method, path and reference page: reads and write commands for prompts, webhooks and site diagnostics.

The REST reference contains **79 operations: 51 GET reads and 28 commands**.
Each operation below has its own reference page. Download the [OpenAPI specification](https://docs.qwairy.co/openapi.json) for client generation.

Reads start at Growth and Agency Growth; individual endpoints can require additional capabilities.
Commands require Business, Agency Business or Enterprise, and an API token with write access enabled.
The estimate command uses POST without starting work.
Webhook endpoint management, reads included, requires Business, Agency Business or Enterprise.
See [Authentication](https://docs.qwairy.co/developers/authentication.md) and [Writing data](https://docs.qwairy.co/developers/writing-data.md).

| Method | Endpoint | Reference |
| - | - | - |
| GET | `/api/v1/brands` | [List brands](https://docs.qwairy.co/developers/endpoints/brands/list.md) |
| GET | `/api/v1/brands/{brandId}` | [Get brand](https://docs.qwairy.co/developers/endpoints/brands/get.md) |
| POST | `/api/v1/brands` | [Create a workspace](https://docs.qwairy.co/developers/endpoints/brands/create.md) |
| PATCH | `/api/v1/brands/{brandId}` | [Update a workspace](https://docs.qwairy.co/developers/endpoints/brands/update.md) |
| GET | `/api/v1/brands/{brandId}/monitoring` | [Get monitoring](https://docs.qwairy.co/developers/endpoints/brands/monitoring.md) |
| PATCH | `/api/v1/brands/{brandId}/monitoring` | [Update monitoring](https://docs.qwairy.co/developers/endpoints/brands/update-monitoring.md) |
| GET | `/api/v1/brands/{brandId}/keywords` | [List topics](https://docs.qwairy.co/developers/endpoints/keywords/list.md) |
| GET | `/api/v1/brands/{brandId}/keywords/{keywordId}` | [Get a topic](https://docs.qwairy.co/developers/endpoints/keywords/get.md) |
| POST | `/api/v1/brands/{brandId}/keywords` | [Create a topic](https://docs.qwairy.co/developers/endpoints/keywords/manage.md) |
| PATCH | `/api/v1/brands/{brandId}/keywords/{keywordId}` | [Update a topic](https://docs.qwairy.co/developers/endpoints/keywords/update.md) |
| DELETE | `/api/v1/brands/{brandId}/keywords/{keywordId}` | [Delete a topic](https://docs.qwairy.co/developers/endpoints/keywords/delete.md) |
| GET | `/api/v1/brands/{brandId}/keywords/{keywordId}/evolution` | [Topic evolution](https://docs.qwairy.co/developers/endpoints/keywords/evolution.md) |
| GET | `/api/v1/brands/{brandId}/tags` | [List tags](https://docs.qwairy.co/developers/endpoints/tags/list.md) |
| GET | `/api/v1/brands/{brandId}/tags/{tagId}` | [Get a tag](https://docs.qwairy.co/developers/endpoints/tags/get.md) |
| POST | `/api/v1/brands/{brandId}/tags` | [Create a tag](https://docs.qwairy.co/developers/endpoints/tags/create.md) |
| PATCH | `/api/v1/brands/{brandId}/tags/{tagId}` | [Update a tag](https://docs.qwairy.co/developers/endpoints/tags/update.md) |
| DELETE | `/api/v1/brands/{brandId}/tags/{tagId}` | [Delete a tag](https://docs.qwairy.co/developers/endpoints/tags/delete.md) |
| GET | `/api/v1/brands/{brandId}/tags/{tagId}/evolution` | [Tag evolution](https://docs.qwairy.co/developers/endpoints/tags/evolution.md) |
| GET | `/api/v1/brands/{brandId}/prompt-suggestions` | [Get prompt suggestions](https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get.md) |
| POST | `/api/v1/brands/{brandId}/prompt-suggestions/runs` | [Generate prompt suggestions](https://docs.qwairy.co/developers/endpoints/prompt-suggestions/generate.md) |
| GET | `/api/v1/brands/{brandId}/prompt-suggestions/runs/{suggestionRunId}` | [Get a suggestion generation](https://docs.qwairy.co/developers/endpoints/prompt-suggestions/get-run.md) |
| POST | `/api/v1/brands/{brandId}/prompt-suggestions/accept` | [Accept prompt suggestions](https://docs.qwairy.co/developers/endpoints/prompt-suggestions/accept.md) |
| POST | `/api/v1/brands/{brandId}/runs/estimate` | [Estimate a run](https://docs.qwairy.co/developers/endpoints/runs/estimate.md) |
| POST | `/api/v1/brands/{brandId}/runs` | [Start a run](https://docs.qwairy.co/developers/endpoints/runs/manage.md) |
| GET | `/api/v1/brands/{brandId}/runs` | [List runs](https://docs.qwairy.co/developers/endpoints/runs/list.md) |
| GET | `/api/v1/brands/{brandId}/runs/{runId}` | [Get a run](https://docs.qwairy.co/developers/endpoints/runs/get.md) |
| GET | `/api/v1/credits` | [Credits](https://docs.qwairy.co/developers/endpoints/credits.md) |
| GET | `/api/v1/brands/{brandId}/performance` | [Get performance snapshot](https://docs.qwairy.co/developers/endpoints/performance.md) |
| GET | `/api/v1/brands/{brandId}/matrix` | [Get GEO matrix](https://docs.qwairy.co/developers/endpoints/matrix.md) |
| GET | `/api/v1/brands/{brandId}/prompts` | [List prompts](https://docs.qwairy.co/developers/endpoints/prompts/list.md) |
| GET | `/api/v1/brands/{brandId}/prompts/{promptId}` | [Get prompt](https://docs.qwairy.co/developers/endpoints/prompts/get.md) |
| GET | `/api/v1/brands/{brandId}/prompts/{promptId}/answers` | [Prompt answers](https://docs.qwairy.co/developers/endpoints/prompts/answers.md) |
| GET | `/api/v1/brands/{brandId}/prompts/{promptId}/evolution` | [Prompt evolution](https://docs.qwairy.co/developers/endpoints/prompts/evolution.md) |
| POST | `/api/v1/brands/{brandId}/prompts` | [Create a prompt](https://docs.qwairy.co/developers/endpoints/prompts/manage.md) |
| PATCH | `/api/v1/brands/{brandId}/prompts/{promptId}` | [Update a prompt](https://docs.qwairy.co/developers/endpoints/prompts/update.md) |
| POST | `/api/v1/brands/{brandId}/prompts/bulk` | [Bulk update prompts](https://docs.qwairy.co/developers/endpoints/prompts/bulk.md) |
| GET | `/api/v1/brands/{brandId}/answers` | [List answers](https://docs.qwairy.co/developers/endpoints/answers/list.md) |
| GET | `/api/v1/brands/{brandId}/answers/{answerId}` | [Get answer](https://docs.qwairy.co/developers/endpoints/answers/get.md) |
| GET | `/api/v1/brands/{brandId}/competitors` | [List competitors](https://docs.qwairy.co/developers/endpoints/competitors/list.md) |
| GET | `/api/v1/brands/{brandId}/competitors/{competitorId}` | [Get competitor](https://docs.qwairy.co/developers/endpoints/competitors/get.md) |
| GET | `/api/v1/brands/{brandId}/competitors/{competitorId}/evolution` | [Competitor evolution](https://docs.qwairy.co/developers/endpoints/competitors/evolution.md) |
| GET | `/api/v1/brands/{brandId}/source-domains` | [List source domains](https://docs.qwairy.co/developers/endpoints/source-domains/list.md) |
| GET | `/api/v1/brands/{brandId}/source-domains/{sourceId}` | [Get source domain](https://docs.qwairy.co/developers/endpoints/source-domains/get.md) |
| GET | `/api/v1/brands/{brandId}/source-domains/{sourceId}/evolution` | [Source domain evolution](https://docs.qwairy.co/developers/endpoints/source-domains/evolution.md) |
| GET | `/api/v1/brands/{brandId}/source-urls` | [List source URLs](https://docs.qwairy.co/developers/endpoints/source-urls.md) |
| GET | `/api/v1/brands/{brandId}/search` | [List query fan-out records](https://docs.qwairy.co/developers/endpoints/search.md) |
| GET | `/api/v1/brands/{brandId}/follow-ups` | [List follow-ups](https://docs.qwairy.co/developers/endpoints/follow-ups.md) |
| GET | `/api/v1/brands/{brandId}/shopping` | [List shopping results](https://docs.qwairy.co/developers/endpoints/shopping.md) |
| GET | `/api/v1/brands/{brandId}/local` | [List local business insights](https://docs.qwairy.co/developers/endpoints/local.md) |
| GET | `/api/v1/brands/{brandId}/social` | [List social signals](https://docs.qwairy.co/developers/endpoints/social.md) |
| GET | `/api/v1/brands/{brandId}/sponsored` | [List sponsored content](https://docs.qwairy.co/developers/endpoints/sponsored.md) |
| GET | `/api/v1/brands/{brandId}/crawler-analytics` | [Get crawler analytics](https://docs.qwairy.co/developers/endpoints/crawler-analytics.md) |
| GET | `/api/v1/brands/{brandId}/perception` | [List perception snapshots](https://docs.qwairy.co/developers/endpoints/perception/list.md) |
| GET | `/api/v1/brands/{brandId}/perception/{snapshotId}` | [Get perception snapshot](https://docs.qwairy.co/developers/endpoints/perception/get.md) |
| GET | `/api/v1/brands/{brandId}/actions` | [List actions](https://docs.qwairy.co/developers/endpoints/actions/list.md) |
| PATCH | `/api/v1/brands/{brandId}/actions/{actionId}` | [Update an action status](https://docs.qwairy.co/developers/endpoints/actions/update-status.md) |
| GET | `/api/v1/brands/{brandId}/content` | [List content](https://docs.qwairy.co/developers/endpoints/content/list.md) |
| GET | `/api/v1/brands/{brandId}/content/{articleId}` | [Get content](https://docs.qwairy.co/developers/endpoints/content/get.md) |
| GET | `/api/v1/brands/{brandId}/technical-analysis` | [Get Site Readiness analysis](https://docs.qwairy.co/developers/endpoints/technical-analysis.md) |
| GET | `/api/v1/brands/{brandId}/site-diagnostics` | [List monitored pages](https://docs.qwairy.co/developers/endpoints/site-diagnostics/list.md) |
| GET | `/api/v1/brands/{brandId}/site-diagnostics/{pageId}` | [Get a monitored page](https://docs.qwairy.co/developers/endpoints/site-diagnostics/get.md) |
| POST | `/api/v1/brands/{brandId}/site-diagnostics/pages` | [Add pages to monitor](https://docs.qwairy.co/developers/endpoints/site-diagnostics/add-pages.md) |
| POST | `/api/v1/brands/{brandId}/site-diagnostics/audits` | [Start a page audit](https://docs.qwairy.co/developers/endpoints/site-diagnostics/start-audit.md) |
| GET | `/api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId}` | [Get a page audit](https://docs.qwairy.co/developers/endpoints/site-diagnostics/get-audit.md) |
| POST | `/api/v1/pitch-audits` | [Create a Pitch Audit](https://docs.qwairy.co/developers/endpoints/pitch-audits/create.md) |
| PATCH | `/api/v1/pitch-audits/{auditId}/prompts` | [Save Pitch Audit prompts](https://docs.qwairy.co/developers/endpoints/pitch-audits/save-prompts.md) |
| POST | `/api/v1/pitch-audits/{auditId}/confirm` | [Confirm a Pitch Audit](https://docs.qwairy.co/developers/endpoints/pitch-audits/confirm.md) |
| GET | `/api/v1/pitch-audits` | [List Pitch Audits](https://docs.qwairy.co/developers/endpoints/pitch-audits/list.md) |
| GET | `/api/v1/pitch-audits/{auditId}` | [Get Pitch Audit](https://docs.qwairy.co/developers/endpoints/pitch-audits/get.md) |
| GET | `/api/v1/pitch-audits/{auditId}/reports/{subjectId}` | [Get Pitch Audit subject report](https://docs.qwairy.co/developers/endpoints/pitch-audits/get-report.md) |
| GET | `/api/v1/webhooks` | [List webhook endpoints](https://docs.qwairy.co/developers/endpoints/webhooks/list.md) |
| POST | `/api/v1/webhooks` | [Create a webhook endpoint](https://docs.qwairy.co/developers/endpoints/webhooks/create.md) |
| GET | `/api/v1/webhooks/{webhookId}` | [Get a webhook endpoint](https://docs.qwairy.co/developers/endpoints/webhooks/get.md) |
| PATCH | `/api/v1/webhooks/{webhookId}` | [Update a webhook endpoint](https://docs.qwairy.co/developers/endpoints/webhooks/update.md) |
| DELETE | `/api/v1/webhooks/{webhookId}` | [Delete a webhook endpoint](https://docs.qwairy.co/developers/endpoints/webhooks/delete.md) |
| POST | `/api/v1/webhooks/{webhookId}/rotate-secret` | [Rotate the signing secret](https://docs.qwairy.co/developers/endpoints/webhooks/rotate-secret.md) |
| POST | `/api/v1/webhooks/{webhookId}/test` | [Send a test event](https://docs.qwairy.co/developers/endpoints/webhooks/test.md) |
| GET | `/api/v1/webhooks/{webhookId}/deliveries` | [List deliveries](https://docs.qwairy.co/developers/endpoints/webhooks/deliveries.md) |
| POST | `/api/v1/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver` | [Redeliver an event](https://docs.qwairy.co/developers/endpoints/webhooks/redeliver.md) |

## Related interfaces

[Integration webhooks](https://docs.qwairy.co/developers/integration-webhooks/overview.md) deliver signed completion events to your HTTPS endpoint. You manage their endpoints with the webhook operations above.
[Outbound webhooks](https://docs.qwairy.co/developers/webhooks.md) are separate, dashboard-configured notifications for white-label teams, not REST API v1 endpoints.
[Crawler ingestion connectors](https://docs.qwairy.co/documentation/measure/crawler-analytics/connectors/generic-http.md) have separate authentication and delivery contracts.
Undefined paths return 404 and are not operations in this catalog.

Team membership, roles, invitations, credit transfers, top-ups and public API-key management remain outside this REST surface.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.