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

# Outils d’écriture des workspaces et du suivi

> Créez un workspace, modifiez son profil et son cycle de vie, et la fréquence et les modèles du suivi via MCP, avec confirmation de chaque modification.

Ces outils créent et configurent des workspaces. Lisez d’abord [Accès en écriture MCP](https://docs.qwairy.co/fr/mcp/write/overview.md) pour les offres, scopes, rôles, `dryRun`, `expectedVersion` et jetons de confirmation. Tous les exemples utilisent des données synthétiques.

| Outil | Scope | Rôle minimal | Confirmation | Équivalent REST |
| - | - | - | - | - |
| `create_workspace` | `write:workspaces` | Manager | `always` | [`POST /brands`](https://docs.qwairy.co/fr/developers/endpoints/brands/create) |
| `update_workspace` | `write:workspaces` | Manager | `always` | [`PATCH /brands/{brandId}`](https://docs.qwairy.co/fr/developers/endpoints/brands/update) |
| `update_monitoring` | `write:monitoring` | Manager | `always` | [`PATCH /brands/{brandId}/monitoring`](https://docs.qwairy.co/fr/developers/endpoints/brands/update-monitoring) |

## create\_workspace

Crée un workspace au statut `DRAFT` dans une équipe. Il utilise un emplacement de workspace de l’offre. Rien n’est généré ni suivi tant que le workspace n’est pas `LIVE`.

### Paramètres

| Paramètre | Type | Requis | Description |
| - | - | - | - |
| `teamId` | string | Oui | Équipe propriétaire du nouveau workspace. Ce doit être une équipe que votre jeton peut utiliser |
| `name` | string | Oui | Nom affiché, jusqu’à 120 caractères |
| `domain` | string | Oui | Nom d’hôte seul, sans schéma ni chemin, jusqu’à 253 caractères |
| `description` | string | Non | Description du workspace |
| `languageCode` | string | Non | Code de langue sur deux lettres |
| `countryCode` | string | Non | Code de pays sur deux lettres |
| `dryRun` | boolean | Non | Aperçu sans création |
| `confirmationToken` | string | Non | Jeton renvoyé par l’aperçu |

### Exemple

```text theme={null}
Vous : Crée un workspace pour Acme Analytics, acme.example, dans mon équipe agence.

Assistant : appelle create_workspace avec
  {"teamId": "team_01", "name": "Acme Analytics", "domain": "acme.example", "countryCode": "US"}

Qwairy : renvoie un aperçu. Le workspace est créé en DRAFT et utilise un
emplacement de workspace. Il renvoie un confirmationToken.

Vous : Vas-y.

Assistant : appelle de nouveau create_workspace avec les mêmes arguments et le jeton.
Le workspace est créé au statut DRAFT. Rien n’est encore suivi.
```

***

## update\_workspace

Modifie le profil d’un workspace, ou le fait passer entre `DRAFT`, `LIVE` et `ARCHIVED`. N’envoyez que les champs à modifier.

### Paramètres

| Paramètre | Type | Requis | Description |
| - | - | - | - |
| `brandId` | string | Oui | Identifiant du workspace issu de `list_brands` |
| `expectedVersion` | integer | Oui | `version` du workspace que vous avez lue en dernier |
| `name` | string | Non | Nom affiché |
| `description` | string | Non | Description |
| `languageCode` | string | Non | Code de langue sur deux lettres |
| `countryCode` | string | Non | Code de pays sur deux lettres |
| `status` | string | Non | `DRAFT`, `LIVE` ou `ARCHIVED` |
| `url` | string | Non | URL du workspace, jusqu’à 2048 caractères |
| `countryCodes` | string\[] | Non | Catalogue de pays du workspace, jusqu’à 50 codes. Le pays par défaut reste en premier. Retirer un pays le retire des prompts qui l’avaient sélectionné |
| `autoDetectCompetitors` | boolean | Non | Indique si Qwairy détecte automatiquement les concurrents dans les réponses |
| `selfHostScope` | string | Non | `REGISTRABLE` compte tous les hôtes du domaine enregistrable comme la marque. `EXACT_HOST` ne compte que l’hôte configuré et ses sous-domaines |
| `dryRun` | boolean | Non | Aperçu sans modification |
| `confirmationToken` | string | Non | Jeton renvoyé par l’aperçu |

Le domaine, le type de workspace et le profil d’onboarding confirmé ne peuvent pas être modifiés.

### Cycle de vie et confirmation

Chaque modification exige un jeton de confirmation issu d’un aperçu. Un passage en `LIVE` chiffre aussi la collecte qu’il déclenche.

| De | Vers | Autorisé |
| - | - | - |
| `DRAFT` | `LIVE` | Oui |
| `DRAFT` | `ARCHIVED` | Oui |
| `LIVE` | `ARCHIVED` | Oui, une fois la génération inactive |
| `ARCHIVED` | `LIVE` | Oui, il est restauré |
| `LIVE` ou `ARCHIVED` | `DRAFT` | Non |

Comme dans le dashboard, l’archivage est réservé aux agences, ou à toute équipe qui a plus de workspaces actifs que son offre n’en inclut. La restauration est refusée si un autre workspace actif suit le même domaine pour la même langue et le même pays.

Activer un workspace ne lance pas de run, mais le prochain passage du planificateur collecte les prompts dus : ceux jamais collectés quand les réponses automatiques sont actives, et ceux que le calendrier collecte ce jour-là (par exemple le jour d’analyse d’un workspace hebdomadaire). L’aperçu chiffre cette collecte dans `credits.oneOff`. Pour collecter tout de suite, utilisez [`start_run`](https://docs.qwairy.co/fr/mcp/write/runs).

### Exemple

```text theme={null}
Vous : Ajoute le Canada aux pays d’Acme Analytics.

Assistant : lit le workspace, puis appelle update_workspace avec
  {"brandId": "brand_01", "expectedVersion": 3, "countryCodes": ["US", "CA"], "dryRun": true}

Qwairy : prévisualise la modification. Les prompts existants gardent leurs pays.

Assistant : une fois l’aperçu approuvé, répète l’appel sans dryRun et avec
son confirmationToken.
```

***

## update\_monitoring

Modifie la fréquence, le calendrier et les modèles du suivi d’un workspace, ou arrête son calendrier avec la fréquence `NONE`.

### Paramètres

| Paramètre | Type | Requis | Description |
| - | - | - | - |
| `brandId` | string | Oui | Identifiant du workspace |
| `expectedVersion` | integer | Oui | `version` du suivi que vous avez lue en dernier |
| `frequency` | string | Non | `NONE`, `DAILY`, `WEEKLY` ou `MONTHLY` |
| `analysisWeekDay` | integer | Non | Jour de 1 à 7 pour le suivi hebdomadaire |
| `analysisMonthDay` | integer | Non | Jour de 1 à 28 pour le suivi mensuel |
| `autoGenerateAnswers` | boolean | Non | Indique si l’analyse planifiée génère automatiquement les réponses |
| `models` | string\[] | Non | Liste de remplacement d’au plus 20 codes de modèle |
| `dryRun` | boolean | Non | Aperçu sans modification |
| `confirmationToken` | string | Non | Jeton renvoyé par l’aperçu |

Chaque modification exige un jeton de confirmation issu d’un aperçu, qui indique tout changement de la consommation récurrente de crédits, par exemple le passage d’un suivi hebdomadaire à quotidien ou une liste de modèles plus longue. `NONE` arrête les prompts qui héritent du calendrier du workspace ; ceux qui ont leur propre fréquence continuent, comme dans le dashboard. Le réglage de suivi de chaque prompt est conservé, et le travail déjà accepté peut encore se terminer. Un workspace sans réglage enregistré n’a aucun modèle et ne génère pas de réponses automatiquement.

### Exemple

```text theme={null}
Vous : Passe Acme Analytics en suivi quotidien.

Assistant : appelle update_monitoring avec
  {"brandId": "brand_01", "expectedVersion": 4, "frequency": "DAILY"}

Qwairy : renvoie un aperçu. La modification augmente la consommation récurrente
de crédits. Il renvoie un confirmationToken et n’exécute rien.

Vous : C’est prévu. Confirme.

Assistant : appelle de nouveau update_monitoring avec les mêmes arguments et le jeton.
```

## Voir aussi

* [Outils de runs et de crédits](https://docs.qwairy.co/fr/mcp/tools/runs.md) pour vérifier le solde avant d’augmenter la fréquence.
* [Écrire des données](https://docs.qwairy.co/fr/developers/writing-data.md) pour les équivalents REST.


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