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

# Référence de l’API

> URL de base, endpoints, réponses, erreurs et limites d’utilisation.

## Vue d’ensemble

Cette page résume connexion, endpoints, réponses, erreurs et limites communes de l’API Developer Platform. Obtenez schémas et tarifs actuels de chaque outil avec `GET /tools`.

## URL de base et en-têtes

Ajoutez tous les chemins à cette URL de base.

```text theme={null}
https://api.noimosai.com/noimosToolBridge
```

Authentifiez-vous avec une clé Developer Platform. Ajoutez Content-Type pour un corps JSON.

```http theme={null}
Authorization: Bearer nmp_...
Content-Type: application/json
```

L’exécution payante nécessite aussi cet en-tête.

```http theme={null}
Idempotency-Key: request-unique-id
```

## Endpoints

Voici les principaux endpoints de l’API publique.

| Méthode et chemin | Autorisation requise | Usage |
| - | - | - |
| `GET /tools/project` | `project:read` | Consulter organisation et projet de la clé |
| `GET /tools/usage` | `usage:read` | Consulter requêtes facturées et frais du mois UTC courant |
| `GET /tools` | `tools:read` | Récupérer outils, schémas, exemples, disponibilité et tarifs |
| `POST /tools/quote` | `tools:read` | Estimer gratuitement la réservation maximale pour l’entrée |
| `POST /tools/upload` | `tools:execute` | Stocker les entrées explicites en privé dans le projet |
| `POST /tools/{tool}` | `tools:execute` | Réserver le plafond et enregistrer le traitement payant |
| `GET /tools/executions` | `executions:read` | Lister les exécutions du projet |
| `GET /tools/executions/{id}` | `executions:read` | Récupérer état, résultats et frais définitifs |
| `POST /tools/executions/{id}/cancel` | `tools:execute` | Demander une annulation |
| `GET /tools/executions/{id}/artifacts/{artifactId}/download` | `executions:read` | Obtenir une URL temporaire du fichier généré |

Filtrez `GET /tools/executions` avec `limit`, `before`, `status` et `tool`. `limit` accepte 1–100, avec 20 par défaut.

## Catalogue d’outils

Le `data` de `GET /tools` contient version tarifaire, devise, disponibilité d’exécution et outils du catalogue.

Chaque outil fournit :

* `name` — Nom à utiliser dans l’URL d’exécution et le corps
* `description` et `category` — Usage et classification
* `available` — Services externes nécessaires configurés et outil disponible
* `inputSchema` et `example` — JSON Schema d’entrée et exemple
* `models` — Modèles sélectionnables avec exemples, disponibilité et tarifs par modèle
* `price` — Coût minimal, unité de facturation et description tarifaire

`available: true` ne garantit pas l’exécution. `executionEnabled`, autorisations, solde et plafonds mensuels s’appliquent aussi.

## Format des réponses

Les réponses réussies placent généralement le résultat dans `data`.

```json theme={null}
{
  "data": {}
}
```

Les erreurs placent statut et message dans `error`.

```json theme={null}
{
  "error": {
    "status": "PERMISSION_DENIED",
    "message": "platform_api_key_scope_required"
  }
}
```

Toutes les réponses utilisent `Cache-Control: no-store`. Ne stockez pas clés, résultats ou URL temporaires dans des caches partagés.

## Traiter les erreurs

Vérifiez la cause selon le statut avant toute nouvelle tentative.

| HTTP | Signification | Action |
| - | - | - |
| `200` | Lecture réussie ou même exécution terminée | Traiter `data` |
| `202` | Traitement asynchrone accepté | Enregistrer l’identifiant et attendre au moins cinq secondes |
| `400` | Entrée, devis ou état invalide | Vérifier catalogue et devis |
| `401` | Échec d’authentification | Vérifier Authorization, expiration et révocation |
| `403` | Accès refusé | Vérifier autorisations de clé et de projet |
| `404` | Endpoint, opération ou artefact indisponible | Vérifier chemin, disponibilité et expiration |
| `409` | Clé d’idempotence utilisée pour une autre requête | Vérifier corps et clé d’origine ; éviter une autre exécution |
| `429` | Limite de requêtes, solde ou plafond atteint | Vérifier limite et solde concernés |
| `503` | Exécution ou service externe temporairement indisponible | Vérifier l’acceptation du traitement payant avant de réessayer |

## Limites d’utilisation

Tenez compte de ces limites dans votre client.

| Ressource | Limite |
| - | - |
| Requête JSON normale | 64 KiB en UTF-8 |
| Fichier téléversé | 12 MiB |
| Formats acceptés | JPEG, PNG, WAV, MP3, MP4 |
| Requêtes | 120 par clé API et fenêtre fixe d’une minute |
| Intervalle d’interrogation | Au moins cinq secondes |
| Étapes par exécution | Jusqu’à 20 |
| Conservation des fichiers générés | 30 jours |
| Validité des URL de téléchargement | Jusqu’à cinq minutes |

Catalogue, devis, téléversements, exécutions, interrogations et nouvelles tentatives comptent dans la limite. Évitez les interrogations trop fréquentes pour prévenir les réponses 429.

## Téléverser des entrées

Pour des images, sons ou vidéos locaux, envoyez type MIME et données Base64 à `POST /tools/upload`.

```json theme={null}
{
  "mimeType": "audio/wav",
  "data": "BASE64_DATA"
}
```

La réponse fournit un `id` utilisable comme `fileId`, format, taille, SHA-256 et expiration. Indiquez-le dans des champs comme `source` selon le catalogue. Un contenu identique dans le même projet renvoie le même ID ; la conservation ne se prolonge pas au-delà du premier téléversement.

## Pages associées

Consultez ces pages pour l’authentification et l’exécution.

* [Authentifier les requêtes](https://docs.noimosai.com/fr/developers/api/authentication.md)
* [Gérer exécution et facturation](https://docs.noimosai.com/fr/developers/api/execution-and-billing.md)
* [Documentation](https://platform.noimosai.com/docs)


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