# 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 a la General Translation API o imprime su especificación OpenAPI incluida. 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. El comando escribe el body de la respuesta sin modificar en la salida estándar, lo que lo hace ideal para scripts y flujos de shell.

## Descripción general [#overview]

```bash
npx gt api [endpoint] [options]
```

Pasa un path de endpoint como `/v2/project/info/PROJECT_ID`, u omite el endpoint al usar `--spec`.

## Cómo funciona [#how-it-works]

* Lee la API Key de `--api-key` o `GT_API_KEY`.
* 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 la solicitud.
* 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 la bandera y el entorno indican IDs distintos, prevalece la bandera.

## Flags [#flags]

| Parámetro               | Descripción                                                                                      | Tipo      | Opcional | Predeterminado           |
| ----------------------- | ------------------------------------------------------------------------------------------------ | --------- | -------- | ------------------------ |
| `-X, --method <method>` | Método HTTP: `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE` u `OPTIONS`.                        | `string`  | Sí       | `GET`                    |
| `--input <file>`        | Lee el body de la solicitud desde un archivo o desde la entrada estándar si se establece en `-`. | `string`  | Sí       | —                        |
| `-H, --header <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.                                                  | `boolean` | Sí       | `false`                  |
| `-c, --config <path>`   | Ruta a `gt.config.json`. Se puede omitir el sufijo `.json`.                                      | `string`  | Sí       | Resuelto automáticamente |
| `--api-key <key>`       | Reemplazo de la API key.                                                                         | `string`  | Sí       | `GT_API_KEY`             |
| `--project-id <id>`     | Reemplazo del project ID.                                                                        | `string`  | Sí       | Config o `GT_PROJECT_ID` |

`--spec` no requiere un endpoint, una API key ni un project ID.

## Ejemplos [#examples]

```bash
# Guarda el snapshot de la API incluido con las dependencias instaladas del CLI
npx gt api --spec > openapi.json

# Lee la información del Project con las credenciales del entorno
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]

* `gt api` está disponible a partir de la versión 2.20.0 de `gt`.
* `--spec` imprime el snapshot instalado; no descarga la especificación alojada actual.
* 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.

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.