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

> Démarrez avec l’API v1 de Qwairy : authentification, formats de réponse, pagination et principaux endpoints.

Utilisez l’API v1 pour lire les données de suivi accessibles à votre équipe : réponses, citations, concurrents et indicateurs agrégés.

<Note>
  L’API v1 exige une offre **Growth**, **Business** ou **Enterprise** active, ou une offre **Agency Growth** ou **Agency Business**. [Vérifiez votre abonnement](https://www.qwairy.co/dashboard/team/billing) si l’authentification signale une offre insuffisante.
</Note>

## URL de base

Tous les endpoints de l’API sont relatifs à :

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

## Endpoints disponibles

L’API expose ces ressources de suivi :

| Ressource | Description |
| - | - |
| [Marques](/fr/developers/endpoints/brands/list) | Lister toutes les marques de votre compte |
| [Performance](/fr/developers/endpoints/performance) | Lire les indicateurs de visibilité au niveau des réponses |
| [Concurrents](/fr/developers/endpoints/competitors/list) | Suivre les mentions des concurrents et la part de voix |
| [Domaines sources](/fr/developers/endpoints/source-domains/list) | Suivre les domaines cités par les plateformes IA |
| [URL sources](/fr/developers/endpoints/source-urls) | Suivre chaque page citée dans les réponses IA |
| [Prompts](/fr/developers/endpoints/prompts/list) | Accéder aux prompts suivis |
| [Réponses](/fr/developers/endpoints/answers/list) | Récupérer les réponses IA enregistrées |
| [Recherche](/fr/developers/endpoints/search) | Lister le Query Fan-Out conservé associé aux réponses enregistrées |

## Démarrage rapide

<Steps>
  <Step title="Obtenez votre jeton d’API">
    Ouvrez **Gestion de l’équipe** → **API REST** et créez un nouveau jeton d’API.
  </Step>

  <Step title="Faites votre première requête">
    ```bash theme={null}
    curl -X GET "https://www.qwairy.co/api/v1/brands" \
      -H "Authorization: Bearer qw-api-your-token-here"
    ```
  </Step>

  <Step title="Explorez vos données">
    Utilisez l’identifiant de marque pour accéder aux indicateurs de performance, aux concurrents, aux sources, etc.
  </Step>
</Steps>

## Format des réponses

Les réponses sont au format JSON. Les endpoints de liste renvoient en général un tableau de ressources et un objet `pagination` :

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

La plupart des endpoints de liste incluent un objet `pagination` avec :

* `total` : nombre total d’éléments correspondant à la requête
* `count` : éléments de cette réponse
* `limit` : nombre maximal d’éléments par page
* `offset` : éléments ignorés

L’endpoint `/brands` fait exception : il renvoie la liste complète avec un `total` au premier niveau et sans objet `pagination`.

Consultez [Entités](/fr/developers/entities) pour le détail des structures de données.

Les erreurs de validation et de ressource incluent des codes exploitables par programme :

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

Les erreurs d’authentification et de limite de débit ont une forme plate. Consultez [Codes d’erreur](/fr/developers/errors) avant de mettre en place la gestion des erreurs.

## Obtenir de l’aide

* Consultez le guide [Authentification](/fr/developers/authentication)
* Lisez [Limites de débit](/fr/developers/rate-limits)
* Consultez [Codes d’erreur](/fr/developers/errors)
* Écrivez-nous à [team@qwairy.co](mailto:team@qwairy.co)


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