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

# API Reference

> Base URL, auth, response envelope, and the full endpoint list.

The reference pages below are generated from the Cognizo public OpenAPI spec.
Each endpoint has an interactive console — paste your API key once and call it
live.

## Base URL

```
https://core.cognizo.ai
```

## Authentication

Send your key in the `X-API-KEY` header on every request. See
[Authentication](/guides/authentication).

## Response envelope

* Success (single): `{ "data": { … } }`
* Success (list): `{ "data": [ … ], "meta": { page, page_size, total_items, total_pages } }`
* Error: `{ "error": { "code", "message", "details"? } }`

Timestamps are ISO 8601 strings; JSON keys are `snake_case`.

## The surface

38 operations across 28 paths, all brand-scoped:

| Group                 | Operations                                                                                                                                                                    |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Brands**            | `list_brands`, `create_brand`, `get_brand`, `update_brand`, `delete_brand`                                                                                                    |
| **Brand metrics**     | `get_brand_visibility`, `get_brand_share_of_voice`, `get_brand_sentiment`                                                                                                     |
| **Topics**            | `list_brand_topics`, `create_brand_topics`, `get_brand_topic`, `update_brand_topic`, `delete_brand_topic`                                                                     |
| **Prompts**           | `list_brand_prompts`, `create_brand_prompts`, `update_brand_prompts`, `get_brand_prompt_region` + its `visibility` / `share_of_voice` / `sentiment` variants                  |
| **Citations**         | `list_brand_citations_domains`, `list_brand_citations_pages`, their `overview` variants, plus `get_brand_citations_overview`, `_summary`, `_citation_share`, `_mention_share` |
| **Competitors**       | `list_brand_competitors`, `create_brand_competitor`, `update_brand_competitor`, `delete_brand_competitor`                                                                     |
| **Ads & advertisers** | `list_brand_ads`, `get_brand_ads_breakdown`, `get_brand_ad`, `list_brand_advertisers`, `get_brand_advertiser`, `list_brand_advertiser_ads`                                    |

Those operation ids are also the [MCP tool names](/mcp/tools) — one vocabulary
whether you call the API directly or through an AI client.

Deletes are **soft**. A deleted brand, topic or prompt drops out of the list
endpoints and its history is retained rather than purged. Deleting a topic
also deactivates the prompts under it. Archived prompts keep their metrics and
citations: pass `filter[is_deleted]=true` to list them, and the single-prompt
endpoint still resolves one directly.

<Note>
  Set your API key in the console's **X-API-KEY** field to try requests directly
  from these pages.
</Note>