Коротко
API ChatGPT это способ обращаться к модели из вашей программы по сети. Вы отправляете запрос с текстом и ключом доступа, а в ответ получаете готовый текст.
API это мост между вашей программой и моделью. Если вы уже знаете, что такое API простыми словами, дальше будет легко. На этой странице мы разберём, как устроен запрос, зачем нужен ключ и где новички чаще всего ошибаются. Точные имена методов и моделей всегда сверяйте с официальной документацией, потому что они меняются.
Что такое API ChatGPT
API это набор правил, по которым одна программа общается с другой. Вместо того чтобы открывать сайт и печатать вручную, ваш код отправляет вопрос и получает ответ.
Это удобно, когда задач много и делать их руками долго.
Где это пригодится
Через API модель легко встроить в свои сервисы. Главная разница с сайтом в том, что тут всё делает код, а не человек за клавиатурой.
- Чат поддержки, который отвечает клиентам.
- Скрипт, который обрабатывает много текста подряд.
- Сервис, который переводит или сокращает письма.
Как устроен запрос
Запрос это обычное сообщение по сети к серверу OpenAI. В нём вы указываете модель, текст вопроса и ключ доступа. Длину текста удобно прикинуть, если понимать, что такое токены.
Ответ приходит обратно тем же путём и содержит готовый текст. Если какой то части не хватает, сервер вернёт ошибку с пояснением, что именно не так.
- Адрес сервера, куда идёт запрос.
- Название модели, которую вы хотите использовать.
- Сам текст вопроса или задачи.
- Ключ доступа, который подтверждает, что запрос ваш.
Что приходит в ответе
В ответе лежит готовый текст и немного служебных данных. Если чего то не хватило, сервер вернёт ошибку с понятным пояснением, что именно не так.
Зачем нужен ключ
Ключ это секретная строка, которая связывает запрос с вашим аккаунтом. По нему сервер понимает, кто отправил запрос и сколько списать за работу.
Как обращаться с ключом
Ключ нельзя показывать другим и нельзя класть в открытый код. Подробно про хранение мы рассказали в материале про безопасность ключа API. Если ключ виден посторонним, его сразу нужно заменить.
Относитесь к ключу как к паролю от своего счёта.
Совет. Если ключ хоть раз попал в чужие руки или в скриншот, не тяните. Сразу создайте новый, а старый отзовите.
Минимальный пример на Python
Ниже простой пример как обычный текст. Настоящий ключ в код не пишут, его читают из переменной окружения. Это и есть безопасный способ:
import os
from openai import OpenAI
client = OpenAI(apikey=os.environ.get("OPENAIAPI_KEY"))
# дальше вызов модели и чтение текста из ответа
Здесь YOURAPIKEY заменяет os.environ.get, то есть значение берётся из системы, а не из файла. Точные имена методов смотрите в документации, потому что они могут отличаться от примера.
- Импортируйте os и официальную библиотеку.
- Прочитайте ключ через os.environ.get.
- Создайте клиента и передайте ему ключ.
- Вызовите модель и достаньте текст ответа.
Шаги первого запроса
Чтобы первый запрос прошёл гладко, идите по порядку. Сначала аккаунт и ключ, потом установка библиотеки, потом короткий код. Готовый разбор кода есть в нашем материале с примерами на Python.
Когда простой запрос заработал, можно добавлять обработку ошибок и считать расход. Вернуться к общему обзору можно через раздел про API.
- Заведите аккаунт и создайте ключ в личном кабинете.
- Установите официальную библиотеку для Python.
- Задайте переменную окружения с ключом.
- Отправьте короткий запрос и прочитайте ответ.
- Проверьте, что текст пришёл и не пустой.
Частые ошибки и как их избежать
Новички часто путают сайт и API и ждут, что запрос будет работать так же, как чат в браузере. На деле всё делает код, и любую мелочь нужно прописать явно.
Ещё одна частая беда это ключ прямо в файле, который потом случайно попадает в репозиторий. Чтобы этого избежать, держите ключ в окружении, читайте документацию перед стартом и следите за расходом токенов. Безопасность данных это отдельная важная тема, про неё есть материал про защиту чувствительной информации.
Если тема близкая, загляните в Основы вебхуков.
По соседнему вопросу смотрите Автоматизация через API.
- Не вписывайте настоящий ключ в код.
- Не считайте, что API ведёт себя как сайт.
- Не пропускайте чтение документации.
- Следите за числом токенов и запросов.
Части простого запроса к API
| Часть | Что это | Пример значения |
|---|---|---|
| Адрес | Куда идёт запрос | Сервер OpenAI |
| Модель | Какую модель вызвать | Название из docs |
| Сообщение | Текст вашего вопроса | Переведи этот текст |
| Ключ | Подтверждает аккаунт | YOUR_API_KEY |
Где чаще применяют API (простая иллюстрация)
Путь одного запроса
Готовите запрос
Указываете модель, текст и ключ.
Отправляете
Запрос уходит на сервер по сети.
Сервер считает
Модель обрабатывает ваш текст.
Получаете ответ
В ответ приходит готовый текст.
Чеклист
- Завести аккаунт и создать ключ.
- Прочитать официальную документацию.
- Понять, как считаются токены.
- Сделать первый простой запрос.
- Спрятать ключ в переменную окружения.
- Проверить, что ответ пришёл и не пустой.
- Добавить простую обработку ошибок.
Частые ошибки
- Показывать ключ в скриншоте или коде.
- Думать, что API и сайт работают одинаково.
- Не читать документацию перед стартом.
- Не следить за расходом токенов.
- Копировать чужой код без понимания.
Частые вопросы
На сайте вы печатаете вручную. Через API запрос отправляет ваша программа и получает ответ автоматически.
Да. Ключ нужно передавать с каждым запросом, чтобы сервер понял, что запрос ваш.
Ключ создаётся в личном кабинете на платформе OpenAI. Подробности есть в официальной документации.
Базовое понимание кода поможет. Но даже короткий пример на Python можно повторить по шагам, если действовать аккуратно.
Чаще всего дело в неверном имени модели, пустом ключе или опечатке. Прочитайте текст ошибки, он обычно подсказывает причину.
Да, со временем они обновляются. Поэтому сверяйтесь с официальной документацией, а не со старыми примерами из сети.
Источники
Мы опираемся на официальную документацию. Цены и состав моделей могут меняться, проверяйте важные факты по первоисточникам.