GigaChat API

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

Скачать спецификацию

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

О стоимости и условиях использования GigaChat API вы можете узнать в разделе Тарифы и оплата.

Получение токена доступа и авторизация запросов

Запросы к GigaChat API авторизуются с помощью токена доступа по протоколу OAuth 2.0. Токен доступа передается в заголовке Authorization:

curl -L -X GET 'https://gigachat.devices.sberbank.ru/api/v1/models' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <токен_доступа>'

Чтобы получить токен, отправьте запрос POST /api/v2/oauth:

curl -L -X POST 'https://ngw.devices.sberbank.ru:9443/api/v2/oauth' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'RqUID: <идентификатор_запроса>' \
-H 'Authorization: Basic <авторизационные_данные>' \
--data-urlencode 'scope=GIGACHAT_API_PERS'

Где:

• RqUID — обязательный заголовок, в котором нужно передать уникальный идентификатор запроса в формате uuid4.
• Authorization — обязательный заголовок, в котором нужно передать авторизационные данные — строку, полученную в результате кодирования в base64 идентификатора (Client ID) и клиентского ключа (Client Secret) API.
• scope — обязательное поле в теле запроса, которое указывает к какой версии API выполняется запрос. Возможные значения:
  • GIGACHAT_API_PERS — доступ для физических лиц.
  • GIGACHAT_API_CORP — доступ для ИП и юридических лиц.

При успешном выполнении запроса GigaChat API вернет токен доступа, который действует в течение 30 минут:

{
  "access_token": "eyJhbGci3iJkaXIiLCJlbmMiOiJBMTI4R0NNIiwidHlwIjoiSldUIn0..Dx7iF7cCxL8SSTKx.Uu9bPK3tPe_crdhOJqU3fmgJo_Ffvt4UsbTG6Nn0CHghuZgA4mD9qiUiSVC--okoGFkjO77W.vjYrk3T7vGM6SoxytPkDJw",
  "expires_at": 1679471442
}

Как получить токен и авторизационные данные (Client Id и Client Secret) читайте в разделах Быстрый старт для физических лиц и Быстрый старт для ИП и юридических лиц.

Способы аутентификации

• HTTP: Basic Auth
• HTTP: Bearer Auth

Базовая (Basic) аутентификация с помощью авторизационных данных — строки, полученной в результате кодирования в base64 идентификатора (Client ID) и клиентского ключа (Client Secret) пользователя API.

Авторизационные данные передаются в заголовке Authorization, в запросе на получение токена доступа.

Как получить токен и авторизационные данные (Client Id и Client Secret) читайте в разделах Быстрый старт для физических лиц и Быстрый старт для ИП и юридических лиц.

Security Scheme Type:	http
HTTP Authorization Scheme:	basic

Аутентификация с помощью токена доступа. Используется во всех запросах к GigaChat API, кроме запроса на получение токена доступа.

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer
Bearer format:	JWT