# gt: General Translation CLI tool: gt api URL: https://generaltranslation.com/fr/docs/cli/reference/commands/api.mdx Docs index: https://generaltranslation.com/llms.txt Description: Effectuez des requêtes brutes authentifiées ou inspectez le contrat intégré de l'API de General Translation. Référence d'API pour la commande gt api. Utilisez `gt api` lorsque vous avez besoin d'accéder directement à un endpoint sans ajouter de client HTTP à votre projet. La commande permet également de lister les opérations de l’API intégrées ou d’afficher le contrat d’une opération donnée sans charger l’intégralité de la spécification OpenAPI. ## Vue d'ensemble [#overview] ```bash npx gt api [endpoint] [options] ``` Indiquez un chemin d'endpoint tel que `/v2/project/info/PROJECT_ID` pour envoyer une requête. Utilisez `--list` sans endpoint pour découvrir les opérations disponibles, ou passez un ID d'opération, un chemin de spécification ou un chemin de requête concret avec `--spec` pour examiner une portion plus restreinte du contrat. ## Fonctionnement [#how-it-works] * Utilise une clé explicite fournie par `--api-key` ou `GT_API_KEY`, sinon la connexion enregistrée. (Voir [l'ordre de priorité de l'authentification](/docs/cli/guides/configuring#credentials).) * Résout l'ID de projet depuis `--project-id`, `gt.config.json` ou `GT_PROJECT_ID`. * Envoie la requête vers le `baseUrl` configuré, dont la valeur par défaut est `https://api.gtx.dev`. * Écrit le body brut de la réponse sur la sortie standard, sans nouvelle tentative en cas d'échec réseau ou de réponse HTTP 429/5xx. * Écrit un résumé sur la sortie d'erreur standard et se termine avec le code de sortie 1 en cas de réponse non-2xx. Si `gt.config.json` fournit un ID de projet différent de celui indiqué par `--project-id` ou par l'environnement, la commande s'arrête avant d'envoyer la requête. Lorsque seuls l'option et l'environnement fournissent des identifiants différents, l'option est prioritaire. `--list` affiche une ligne délimitée par des tabulations pour chaque opération embarquée : méthode, chemin, ID d'opération et résumé. Si un endpoint est indiqué, `--spec` recherche d'abord un ID d'opération, puis un chemin de spécification exact, et enfin un chemin de requête concret mis en correspondance avec les paramètres de chemin. La commande résout les références de schéma dans la sortie filtrée et conserve les composants et les schémas de sécurité référencés. Les références de schéma récursives sont conservées sous forme de valeurs `$ref`. ## Options [#flags] | Paramètre | Description | Type | Facultatif | Valeur par défaut | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | ---------- | ------------------------------------------- | | `-X, --method ` | Méthode HTTP : `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE` ou `OPTIONS`. | `string` | Oui | `GET` | | `--input ` | Lit le body de la requête depuis un fichier, ou depuis l'entrée standard si la valeur est `-`. | `string` | Oui | — | | `-H, --header
` | Ajoute un header de requête `Key: Value`. À répéter pour plusieurs headers. | `string` | Oui | — | | `-i, --include` | Écrit l'état et les headers de la réponse avant le body. | `boolean` | Oui | `false` | | `--spec` | Affiche la spécification OpenAPI 3.1 intégrée, filtrée sur l’endpoint indiqué, le cas échéant. | `boolean` | Oui | `false` | | `--list` | Affiche toutes les opérations d’API intégrées, avec les champs suivants séparés par des tabulations : méthode, chemin, ID d’opération et résumé. | `boolean` | Oui | `false` | | `-c, --config ` | Chemin vers `gt.config.json`. Le suffixe `.json` peut être omis. | `string` | Oui | Résolu automatiquement | | `--api-key ` | Remplace explicitement la clé d’outillage. | `string` | Oui | `GT_API_KEY`, sinon la session de connexion | | `--project-id ` | Remplace l’ID de projet. | `string` | Oui | Config ou `GT_PROJECT_ID` | `--list` et `--spec` fonctionnent hors ligne, sans session de connexion, clé API, ID de projet ni paramètres de traduction valides. Ces deux options ne peuvent pas être combinées. Si la recherche ciblée dans la spécification ne correspond à aucune opération, la commande se termine avec le code de sortie 1 et suggère d’utiliser `--list`. ## Exemples [#examples] ```bash # Enregistrer l'instantané de l'API livré avec les dépendances du CLI installées npx gt api --spec > openapi.json # Lister les opérations livrées npx gt api --list # Afficher une opération à partir de son ID ou d'un chemin de requête concret npx gt api --spec getProjectInfo npx gt api --spec /v2/project/info/PROJECT_ID # Lire les informations du projet à l'aide de la connexion enregistrée ou d'une clé explicite npx gt api /v2/project/info/PROJECT_ID # Envoyer un body de requête JSON et inclure les métadonnées de la réponse npx gt api /v2/project/info/PROJECT_ID \ --method POST \ --header "Content-Type: application/json" \ --input update.json \ --include # Lire un body depuis l'entrée standard printf '{"defaultLocale":"fr"}' | npx gt api /v2/project/info/PROJECT_ID \ --method POST \ --header "Content-Type: application/json" \ --input - ``` ## Autres remarques [#notes] * `--spec` affiche l'instantané installé ; la commande ne récupère pas la spécification hébergée actuelle. * Une recherche par chemin affiche toutes les méthodes définies pour le chemin correspondant dans la spécification. L'option `--method` ne filtre pas la sortie de la spécification. * La commande ignore la validation des paramètres de fichiers et de paramètres régionaux de la CLI : des paramètres de traduction invalides ne bloquent donc pas une requête API brute. * Consultez la [référence OpenAPI](/docs/platform/openapi/overview) pour trouver les chemins des endpoints, les permissions, les champs de requête et les schémas de réponse. ### Historique des versions | Version | Modifications | | -------- | --------------------------------------------------------------------------------------------------- | | `2.25.0` | Ajout de `--list` et d'une sortie ciblée avec `--spec `. | | `2.20.0` | Ajout de `gt api`, avec prise en charge des requêtes brutes et sortie de la spécification complète. | ## Sitemap See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.