> ## 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.

# Introduction

> Get started with the Qwairy API v1 and integrate GEO data into your workflows

Build custom dashboards, integrate with your marketing stack, or create automated reports using your GEO (Generative Engine Optimization) data.

<Note>
  The API is available for **Growth**, **Business**, and **Enterprise** plans. [Upgrade your plan](https://qwairy.co/dashboard/team/subscription) to get access.
</Note>

## Base URL

All API endpoints are relative to:

```
https://www.qwairy.co/api/v1
```

## Available Endpoints

The API provides access to all your GEO monitoring data:

| Resource                                                       | Description                                              |
| -------------------------------------------------------------- | -------------------------------------------------------- |
| [Brands](/api-reference/endpoints/brands/list)                 | List all brands in your account                          |
| [Performance](/api-reference/endpoints/performance)            | Get performance snapshots (Audit FLASH format)           |
| [Competitors](/api-reference/endpoints/competitors/list)       | Track competitor mentions and share of voice             |
| [Source Domains](/api-reference/endpoints/source-domains/list) | Monitor domains cited by AI platforms                    |
| [Source URLs](/api-reference/endpoints/source-urls)            | Track individual pages cited in AI responses             |
| [Prompts](/api-reference/endpoints/prompts/list)               | Access your monitored prompts/queries                    |
| [Answers](/api-reference/endpoints/answers/list)               | Retrieve AI-generated responses                          |
| [Search](/api-reference/endpoints/search)                      | Discover web queries AI models trigger before responding |

## Quick Start

<Steps>
  <Step title="Get your API token">
    Go to **Team Management** → **API Access** and create a new API token.
  </Step>

  <Step title="Make your first request">
    ```bash theme={null}
    curl -X GET "https://www.qwairy.co/api/v1/brands" \
      -H "Authorization: Bearer qw-api-your-token-here"
    ```
  </Step>

  <Step title="Explore your data">
    Use the brand ID to access performance metrics, competitors, sources, and more.
  </Step>
</Steps>

## Response Format

All responses are JSON formatted with a consistent structure:

```json theme={null}
{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 10,
    "limit": 10,
    "offset": 0
  },
  "prompts": [ ... ]
}
```

Most list endpoints include a `pagination` object with:

* `total`: Total items matching the query
* `count`: Items in this response
* `limit`: Max items per page
* `offset`: Items skipped

The `/brands` endpoint is the exception: it returns the full list with a top-level `total` count and no `pagination` object.

See [Entities](/api-reference/entities) for detailed data structures.

Error responses include machine-readable codes:

```json theme={null}
{
  "error": {
    "code": "BRAND_NOT_FOUND",
    "message": "Brand not found or not accessible"
  }
}
```

See [Error Codes](/api-reference/errors) for the complete list.

## Need Help?

* Check the [Authentication](/api-reference/authentication) guide
* Review [Rate Limits](/api-reference/rate-limits)
* See [Error Codes](/api-reference/errors)
* Contact us at [team@qwairy.co](mailto:team@qwairy.co)