# gt: General Translation CLI tool: gt api URL: https://generaltranslation.com/es/docs/cli/reference/commands/api.mdx Docs index: https://generaltranslation.com/llms.txt Description: Realiza solicitudes raw autenticadas o inspecciona el contrato incluido de la General Translation API. Referencia de API del comando gt api. Usa `gt api` cuando necesites acceso directo a un endpoint sin añadir un cliente HTTP a tu proyecto. También permite listar las operaciones de API incluidas o imprimir el contrato de una sola operación sin cargar la especificación OpenAPI completa. ## Descripción general [#overview] ```bash npx gt api [endpoint] [options] ``` Pasa una ruta de endpoint como `/v2/project/info/PROJECT_ID` para hacer una solicitud. Usa `--list` sin un endpoint para descubrir las operaciones disponibles, o pasa un ID de operación, una ruta de especificación o una ruta de solicitud concreta con `--spec` para inspeccionar un contrato más acotado. ## Cómo funciona [#how-it-works] * Usa una clave explícita de `--api-key` o `GT_API_KEY`; si no se proporciona, usa el login guardado. (Consulta la [precedencia de autenticación](/docs/cli/guides/configuring#credentials)). * Resuelve el project ID a partir de `--project-id`, `gt.config.json` o `GT_PROJECT_ID`. * Envía la solicitud a la `baseUrl` configurada, cuyo valor predeterminado es `https://api.gtx.dev`. * Escribe el body raw de la respuesta en la salida estándar, sin reintentar ante fallos de red ni respuestas HTTP 429/5xx. * Escribe un resumen en el error estándar y termina con status 1 si la respuesta no es 2xx. Si `gt.config.json` proporciona un project ID distinto al de `--project-id` o al del entorno, el comando se detiene antes de enviar la solicitud. Cuando solo el flag y el entorno indican IDs distintos, prevalece el flag. `--list` imprime una línea separada por tabulaciones por cada operación incluida: método, ruta, ID de operación y resumen. Si se indica un endpoint, `--spec` busca primero un ID de operación, luego una ruta exacta de la especificación y, por último, una ruta de solicitud concreta que coincida con los parámetros de ruta. Resuelve las referencias de esquema en la salida filtrada y conserva los componentes y esquemas de seguridad referenciados. Las referencias de esquema recursivas se mantienen como valores `$ref`. ## Flags [#flags] | Parámetro | Descripción | Tipo | Opcional | Predeterminado | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------- | --------- | -------- | --------------------------------------- | | `-X, --method ` | Método HTTP: `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE` u `OPTIONS`. | `string` | Sí | `GET` | | `--input ` | Lee el body de la solicitud desde un archivo o desde la entrada estándar si se establece en `-`. | `string` | Sí | — | | `-H, --header
` | Añade una cabecera `Key: Value` a la solicitud. Repítelo para varias cabeceras. | `string` | Sí | — | | `-i, --include` | Escribe el status y las cabeceras de la respuesta antes del body. | `boolean` | Sí | `false` | | `--spec` | Imprime la especificación OpenAPI 3.1 incluida, filtrada por el endpoint si se indica uno. | `boolean` | Sí | `false` | | `--list` | Imprime cada operación de la API incluida como campos separados por tabulaciones: método, ruta, ID de operación y resumen. | `boolean` | Sí | `false` | | `-c, --config ` | Ruta a `gt.config.json`. Se puede omitir el sufijo `.json`. | `string` | Sí | Resuelto automáticamente | | `--api-key ` | Reemplazo explícito de la tooling key. | `string` | Sí | `GT_API_KEY` o, en su defecto, el login | | `--project-id ` | Reemplazo del project ID. | `string` | Sí | Config o `GT_PROJECT_ID` | `--list` y `--spec` funcionan sin conexión y no requieren un login, una API key, un project ID ni una configuración de traducción válida. No se pueden combinar. Si una búsqueda acotada en la especificación no coincide con ninguna operación, el comando finaliza con el código de salida 1 y sugiere `--list`. ## Ejemplos [#examples] ```bash # Guarda el snapshot de la API incluido con las dependencias instaladas del CLI npx gt api --spec > openapi.json # Lista las operaciones incluidas npx gt api --list # Imprime una operación por su ID de operación o por una ruta de solicitud concreta npx gt api --spec getProjectInfo npx gt api --spec /v2/project/info/PROJECT_ID # Lee la información del proyecto con el login guardado o una clave explícita npx gt api /v2/project/info/PROJECT_ID # Envía un body JSON en la solicitud e incluye los metadatos de la respuesta npx gt api /v2/project/info/PROJECT_ID \ --method POST \ --header "Content-Type: application/json" \ --input update.json \ --include # Lee un body desde la entrada estándar printf '{"defaultLocale":"fr"}' | npx gt api /v2/project/info/PROJECT_ID \ --method POST \ --header "Content-Type: application/json" \ --input - ``` ## Otras notas [#notes] * `--spec` imprime el snapshot instalado; no descarga la especificación alojada actual. * Una búsqueda por ruta imprime todos los métodos de la ruta de la especificación que coincida. El flag `--method` no filtra la salida de la especificación. * El comando omite la validación de la configuración de archivos y configuraciones regionales de la CLI, por lo que una configuración de traducción no válida no bloquea una solicitud raw a la API. * Consulta la [referencia de OpenAPI](/docs/platform/openapi/overview) para conocer las rutas de los endpoints, los permisos, los campos de la solicitud y los esquemas de respuesta. ### Historial de versiones | Versión | Cambios | | -------- | --------------------------------------------------------------------------------------- | | `2.25.0` | Se añadieron `--list` y la salida específica de `--spec `. | | `2.20.0` | Se añadió `gt api` con solicitudes raw y salida de la especificación completa. | ## Sitemap See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.