# 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 auprès de l'API de General Translation ou affichez sa spécification OpenAPI intégrée. 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 écrit le corps de la réponse tel quel sur la sortie standard, ce qui la rend adaptée aux scripts et aux pipelines shell. ## Vue d'ensemble [#overview] ```bash npx gt api [endpoint] [options] ``` Indiquez un chemin d'endpoint tel que `/v2/project/info/PROJECT_ID`, ou omettez l'endpoint si vous utilisez `--spec`. ## Fonctionnement [#how-it-works] * Lit la clé API depuis `--api-key` ou `GT_API_KEY`. * 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 corps brut de la réponse sur la sortie standard, sans réessayer la requête. * Écrit un résumé sur la sortie d'erreur standard et se termine avec l'état 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. ## Flags [#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. | `boolean` | Oui | `false` | | `-c, --config ` | Chemin vers `gt.config.json`. Le suffixe `.json` peut être omis. | `string` | Oui | Résolu automatiquement | | `--api-key ` | Remplace la clé API. | `string` | Oui | `GT_API_KEY` | | `--project-id ` | Remplace l’ID de projet. | `string` | Oui | Config ou `GT_PROJECT_ID` | `--spec` ne nécessite ni endpoint, ni clé API, ni ID de projet. ## Exemples [#examples] ```bash # Enregistrer l'instantané de l'API livré avec les dépendances du CLI installées npx gt api --spec > openapi.json # Lire les informations du projet avec les credentials issus de l'environnement 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] * `gt api` est disponible à partir de `gt` 2.20.0. * `--spec` affiche l'instantané installé ; la commande ne récupère pas la spécification hébergée actuelle. * 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. ## Sitemap See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.