# gt: General Translation CLI tool: gt api
URL: https://generaltranslation.com/it/docs/cli/reference/commands/api.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Esegui richieste non elaborate autenticate alla General Translation API oppure stampa la specifica OpenAPI inclusa. Riferimento API per il comando gt api.

Usa `gt api` quando ti serve accedere direttamente a un endpoint senza aggiungere un client HTTP al tuo progetto. Il comando scrive il body della risposta non modificato sullo standard output, il che lo rende adatto a script e pipeline della shell.

## Panoramica [#overview]

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

Passa un percorso di endpoint come `/v2/project/info/PROJECT_ID`, oppure ometti l'endpoint se usi `--spec`.

## Come funziona [#how-it-works]

* Legge la chiave API da `--api-key` o `GT_API_KEY`.
* Determina l'ID progetto da `--project-id`, `gt.config.json` o `GT_PROJECT_ID`.
* Invia la richiesta al `baseUrl` configurato, che per impostazione predefinita è `https://api.gtx.dev`.
* Scrive il body non elaborato della risposta sullo standard output senza ritentare la richiesta.
* Scrive un riepilogo sullo standard error ed esce con stato 1 in caso di risposta non 2xx.

Se `gt.config.json` fornisce un ID progetto diverso da quello indicato in `--project-id` o nell'ambiente, il comando si interrompe prima di inviare la richiesta. Se invece gli ID differenti provengono solo dal flag e dall'ambiente, prevale il flag.

## Flag [#flags]

| Parametro               | Descrizione                                                                                | Tipo      | Facoltativo | Predefinito                   |
| ----------------------- | ------------------------------------------------------------------------------------------ | --------- | ----------- | ----------------------------- |
| `-X, --method <method>` | Metodo HTTP: `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE` oppure `OPTIONS`.             | `string`  | Sì          | `GET`                         |
| `--input <file>`        | Legge il body della richiesta da un file, oppure dallo standard input se impostato su `-`. | `string`  | Sì          | —                             |
| `-H, --header <header>` | Aggiunge un header di richiesta `Key: Value`. Ripeti il flag per più header.               | `string`  | Sì          | —                             |
| `-i, --include`         | Scrive lo status e gli header della risposta prima del body.                               | `boolean` | Sì          | `false`                       |
| `--spec`                | Stampa la specifica OpenAPI 3.1 inclusa nel bundle.                                        | `boolean` | Sì          | `false`                       |
| `-c, --config <path>`   | Percorso di `gt.config.json`. Il suffisso `.json` può essere omesso.                       | `string`  | Sì          | Risolto automaticamente       |
| `--api-key <key>`       | Override della chiave API.                                                                 | `string`  | Sì          | `GT_API_KEY`                  |
| `--project-id <id>`     | Override dell&#39;ID progetto.                                                             | `string`  | Sì          | Config oppure `GT_PROJECT_ID` |

`--spec` non richiede alcun endpoint, chiave API o ID progetto.

## Esempi [#examples]

```bash
# Salva lo snapshot dell'API incluso nelle dipendenze della CLI installata
npx gt api --spec > openapi.json

# Legge le informazioni del progetto usando le credenziali dell'ambiente
npx gt api /v2/project/info/PROJECT_ID

# Invia un body della richiesta in JSON e include i metadati della risposta
npx gt api /v2/project/info/PROJECT_ID \
  --method POST \
  --header "Content-Type: application/json" \
  --input update.json \
  --include

# Legge un body dallo standard input
printf '{"defaultLocale":"fr"}' |
  npx gt api /v2/project/info/PROJECT_ID \
    --method POST \
    --header "Content-Type: application/json" \
    --input -
```

## Altre note [#notes]

* `gt api` è disponibile in `gt` 2.20.0 e versioni successive.
* `--spec` stampa lo snapshot installato; non recupera la specifica attualmente ospitata.
* Il comando ignora la convalida delle impostazioni di file e delle impostazioni regionali della CLI, quindi eventuali impostazioni di traduzione non valide non bloccano una request API non elaborata.
* Consulta il [riferimento OpenAPI](/docs/platform/openapi/overview) per individuare i percorsi degli endpoint, le autorizzazioni, i field della request e gli schemi delle risposte.

## Sitemap

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