> ## 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 de runs et de crédits

> Estimez les crédits d’un run, listez et lisez les runs, et vérifiez le solde de crédits de l’équipe via MCP avant et après un travail payant.

> [!NOTE]
>
> Consultez [Compatibilité des filtres](https://docs.qwairy.co/fr/mcp/tools/filters.md) pour le contrat de filtres de référence et la couverture de chaque outil MCP.

Ces outils lisent l’état des runs et les crédits. Ils ne modifient rien et ne consomment aucun crédit. Lancer un run est une opération d’écriture : consultez [Outil d’écriture des runs](https://docs.qwairy.co/fr/mcp/write/runs.md).

Ils suivent l’accès MCP en lecture et sont disponibles à partir de Starter, sans scope d’écriture.

## estimate\_run

Estime les crédits qu’un run consommerait, sans rien réserver ni débiter.

### Paramètres

| Paramètre | Type | Requis | Description |
| - | - | - | - |
| `brandId` | string | Oui | L’identifiant de marque issu de `list_brands` |
| `promptIds` | string\[] | Non | Prompts à inclure. Par défaut, les prompts actifs du workspace |
| `modelIds` | string\[] | Non | Modèles à inclure. Par défaut, les modèles de suivi du workspace |

### Résultat

| Champ | Description |
| - | - |
| `promptCount`, `modelCount`, `answerCount` | Nombre de cibles utilisables |
| `estimatedCredits` | Coût total des combinaisons utilisables de prompts et de modèles |
| `availableCredits` | Solde observé au moment de l’estimation, pour les Managers et Owners ; `null` pour les autres rôles |
| `sufficientCredits` | Indique si ce solde couvre le coût estimé |
| `unsupportedModels` | Modèles demandés exclus car inconnus, désactivés ou indisponibles sur le marché du workspace |

Une estimation est un instantané. Le lancement du run revalide les cibles et le solde : son résultat peut donc différer.

### Scope OAuth

Requis : `read:prompts`

***

## list\_runs

Liste les runs récents d’un workspace avec leur statut, du plus récent au plus ancien.

### Paramètres

| Paramètre | Type | Requis | Description |
| - | - | - | - |
| `brandId` | string | Oui | L’identifiant de marque issu de `list_brands` |
| `limit` | integer | Non | Nombre de runs par page, de 1 à 20 |
| `cursor` | string | Non | `nextCursor` opaque de la réponse précédente. Un curseur invalide est rejeté |

### Résultat

Chaque run inclut son objectif, le nombre de prompts et de modèles, les nombres demandés et planifiés, un `status` calculé, des `counts` de résultats et `progressPercentage`. La réponse renvoie aussi `nextCursor` (`null` lorsqu’il n’y a plus de page), `totalCount` et `activeCount` pour l’ensemble du workspace.

Le statut vaut `QUEUED`, `PROCESSING`, `COMPLETED`, `COMPLETED_WITH_WARNINGS`, `FAILED`, `CANCELLED` ou `NO_WORK`. La progression ne garantit pas que chaque réponse demandée a réussi : lisez le statut et les nombres de résultats.

### Scope OAuth

Requis : `read:prompts`

***

## get\_run

Récupère le statut et les compteurs d’un run.

### Paramètres

| Paramètre | Type | Requis | Description |
| - | - | - | - |
| `brandId` | string | Oui | L’identifiant de marque issu de `list_brands` |
| `runId` | string | Oui | Identifiant du run issu de `start_run` ou `list_runs` |

### Résultat

Les métadonnées de planification du run : son objectif, le nombre de prompts et de modèles, les nombres demandés et planifiés, le nombre de tentatives enregistrées, si la planification est terminée ou en échec, et les horodatages. La fin de la planification ne signifie pas que chaque réponse est terminée : utilisez `list_runs` pour le statut et la progression calculés.

### Exemples de prompts

```text theme={null}
Combien coûterait l’exécution de tous mes prompts actifs maintenant ?
```

```text theme={null}
Le run que j’ai lancé est-il terminé ?
```

### Scope OAuth

Requis : `read:prompts`

***

## get\_credits

Récupère le solde de crédits d’une équipe, son utilisation récente et son autonomie.
Exige le rôle Manager ou Propriétaire dans cette équipe.

### Paramètres

| Paramètre | Type | Requis | Description |
| - | - | - | - |
| `teamId` | string | Oui | Identifiant de l’équipe, issu de l’objet `team` renvoyé par `list_brands` |

### Résultat

| Champ | Description |
| - | - |
| `balance` | Solde de crédits actuel |
| `usedLast30Days` | Crédits utilisés sur les 30 derniers jours |
| `averageDailyBurn` | Crédits utilisés en moyenne par jour |
| `runwayDays` | Nombre estimé de jours que le solde dure au rythme actuel, ou `null` si rien n’est consommé |
| `subTeams` | Soldes des sous-équipes que ce jeton peut utiliser, pour une organisation parente, sinon `null` |

### Scope OAuth

Requis : `read:brands`


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