# gt: General Translation CLI tool: gt api
URL: https://generaltranslation.com/ru/docs/cli/reference/commands/api.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Выполняйте аутентифицированные raw-запросы к API General Translation или выводите встроенную спецификацию OpenAPI. Справочник по команде gt api.

Используйте `gt api`, когда нужен прямой доступ к эндпоинту без добавления HTTP-клиента в проект. Команда выводит неизменённое тело ответа в стандартный поток вывода, что удобно для скриптов и конвейеров командной оболочки.

## Обзор [#overview]

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

Передайте путь эндпоинта, например `/v2/project/info/PROJECT_ID`, либо не указывайте эндпоинт, если используете `--spec`.

## Как это работает [#how-it-works]

* Читает API-ключ из `--api-key` или `GT_API_KEY`.
* Разрешает ID проекта из `--project-id`, `gt.config.json` или `GT_PROJECT_ID`.
* Отправляет запрос на заданный `baseUrl`, по умолчанию — `https://api.gtx.dev`.
* Пишет необработанное тело ответа в стандартный поток вывода, не повторяя запрос.
* Пишет сводку в стандартный поток ошибок и завершается со статусом 1, если ответ не из диапазона 2xx.

Если в `gt.config.json` указан ID проекта, отличающийся от значения в `--project-id` или в окружении, команда прерывается до отправки запроса. Если же разные идентификаторы заданы только флагом и окружением, приоритет имеет флаг.

## Флаги [#flags]

| Параметр                | Описание                                                                                                  | Тип       | Необязательный | По умолчанию               |
| ----------------------- | --------------------------------------------------------------------------------------------------------- | --------- | -------------- | -------------------------- |
| `-X, --method <method>` | HTTP-метод: `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE` или `OPTIONS`.                                | `string`  | Да             | `GET`                      |
| `--input <file>`        | Читает тело запроса из файла или из стандартного ввода, если указано `-`.                                 | `string`  | Да             | —                          |
| `-H, --header <header>` | Добавляет заголовок запроса в формате `Key: Value`. Укажите флаг несколько раз для нескольких заголовков. | `string`  | Да             | —                          |
| `-i, --include`         | Выводит статус и заголовки ответа перед телом.                                                            | `boolean` | Да             | `false`                    |
| `--spec`                | Выводит встроенную спецификацию OpenAPI 3.1.                                                              | `boolean` | Да             | `false`                    |
| `-c, --config <path>`   | Путь к `gt.config.json`. Суффикс `.json` можно опустить.                                                  | `string`  | Да             | Определяется автоматически |
| `--api-key <key>`       | Переопределение API-ключа.                                                                                | `string`  | Да             | `GT_API_KEY`               |
| `--project-id <id>`     | Переопределение ID проекта.                                                                               | `string`  | Да             | Конфиг или `GT_PROJECT_ID` |

Для `--spec` не требуются ни эндпоинт, ни API-ключ, ни ID проекта.

## Примеры [#examples]

```bash
# Сохранить снимок API, поставляемый с установленными зависимостями CLI
npx gt api --spec > openapi.json

# Получить информацию о проекте, используя учётные данные из окружения
npx gt api /v2/project/info/PROJECT_ID

# Отправить тело запроса в формате JSON и вывести метаданные ответа
npx gt api /v2/project/info/PROJECT_ID \
  --method POST \
  --header "Content-Type: application/json" \
  --input update.json \
  --include

# Прочитать тело запроса из стандартного ввода
printf '{"defaultLocale":"fr"}' |
  npx gt api /v2/project/info/PROJECT_ID \
    --method POST \
    --header "Content-Type: application/json" \
    --input -
```

## Прочие заметки [#notes]

* `gt api` доступна в `gt` версии 2.20.0 и выше.
* `--spec` выводит установленный снимок; текущая размещённая спецификация при этом не загружается.
* Команда пропускает проверку настроек файлов и локалей в CLI, поэтому некорректные настройки перевода не блокируют raw-запрос к API.
* Используйте [справочник OpenAPI](/docs/platform/openapi/overview), чтобы найти пути эндпоинтов, разрешения, поля запроса и схемы ответов.

## Sitemap

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