Коллекции запросов

Обновлено 27 марта 2025

С GigaChat API можно работать с помощью подготовленных коллекций запросов различных REST-клиентов.

Postman

С помощью коллекций запросов Postman вы можете отправлять запросы как к REST, так и к gRPC API GigaChat.

• HTTP
• gRPC

Для использования коллекции запросов Postman:

1. Войдите в свою учетную запись Postman.

2. Нажмите кнопку:

   Запустить в Postman

3. Нажмите Fork Collection, чтобы скопировать коллекцию запросов в свое рабочее пространство в Postman.

   В открывшемся окне укажите название копии и рабочего пространства, в котором будет создана копия коллекции. Установите флажок Watch original collection, если хотите получать уведомления об изменении в оригинальной коллекции запросов.

4. Нажмите Fork Collection.

   Коллекцию можно скопировать только в публичный профиль Postman.

В описании коллекции вы найдете краткую инструкцию о работе с переменными и выполнении запросов в Postman.

Подробнее о том, как пользоваться GigaChat API в Postman:

Отправлять запросы к gRPC API можно только из приложения Postman, установленного на компьютер. Веб-версия Postman не поддерживает работу с gRPC.

Вы можете скопировать коллекцию gRPC-запросов из публичного пространства Postman.

Для работы с коллекцией понадобится proto-файл, который вы можете скачать или скопировать из документации.

Как подключить proto-файл в коллекцию — в официальной документации.

Для авторизации запросов:

1. Откройте Postman-коллекцию.

2. Перейдите на вкладку Variables.

3. В переменной authorization_key, в поле Current Value укажите ключ авторизации, полученный в личном кабинете.

   О том как получить ключ авторизации — в разделах Быстрый старт для физических лиц и Быстрый старт для ИП и юрлиц.

4. В переменной scope, в поле Current Value укажите версию API, к которой будет выполняться запрос:

   • GIGACHAT_API_PERS;
   • GIGACHAT_API_B2B;
   • GIGACHAT_API_CORP.

Коллекция запросов Insomnia

С помощью коллекции запросов Insomnia вы можете отправлять запросы к REST API GigaChat.

Для корректной работы запроса токена доступа используются сертификаты НУЦ.

Вы можете подключить сертификаты в интерфейсе Insomnia или отключить проверку сертификатов в параметрах программы (флажок Validate certificates в секции Request / Response)

Чтобы начать работу с коллекцией запросов:

1. Нажмите кнопку:

Запустить в Insomnia

2. В открывшемся окне нажмите кнопку Run in Insomnia.

3. Откройте параметры Base Environment и укажите переменные:

   • scope — указывает к какой версии API выполняется запрос. Возможные значения:

     • GIGACHAT_API_PERS — доступ для физических лиц.
     • GIGACHAT_API_B2B — доступ для ИП и юридических лиц по платным пакетам.
     • GIGACHAT_API_CORP — доступ для ИП и юридических лиц по схеме pay-as-you-go.

     По умолчанию задано значение GIGACHAT_API_PERS.

   • authorization_key — ключ авторизации — строку, полученную в результате кодирования в base64 идентификатора (Client ID) и клиентского ключа (Client Secret) API.

Смотрите также

Описание API и авторизация запросов

Справочная документация по REST API нейросетевой модели GigaChat