Swagger и OpenAPI

Мы предоставляем Swagger UI и OpenAPI-совместимую спецификацию API для быстрой интеграции, тестирования запросов и подключения сторонних инструментов разработки.

Swagger позволяет изучать структуру API, выполнять запросы напрямую из браузера и сразу видеть ответы сервера. Благодаря поддержке OpenAPI спецификацию можно автоматически импортировать в различные API-клиенты и инструменты генерации SDK.

Аутентификация

Все запросы к API выполняются с использованием Bearer-токена:

Authorization: Bearer <ваш токен доступа>

Получить API-ключ можно в панели управления BotHub.

Для OpenAI-совместимого API используется следующий базовый URL:

https://openai.bothub.chat/v1

Пример адреса запроса:

https://openai.bothub.chat/v1/chat/completions

Быстрые ссылки

Ресурс	URL
Swagger UI	https://bothub.chat/api/v2/swagger
OpenAPI JSON	https://bothub.chat/api/v2/swagger.json

OpenAPI совместимость

API соответствует спецификации OpenAPI, благодаря чему его можно использовать практически в любом современном инструменте для работы с REST API.

Спецификация автоматически импортируется в Postman, Insomnia, Bruno, Hoppscotch и другие OpenAPI-совместимые клиенты. После импорта приложение самостоятельно создаёт коллекции запросов, группы методов и параметры авторизации, что значительно упрощает интеграцию и тестирование.

OpenAPI-спецификацию также можно использовать для генерации SDK, клиентских библиотек и серверных шаблонов через Swagger Codegen или OpenAPI Generator.

Использование Swagger UI

Swagger UI позволяет тестировать API без написания кода. После открытия документации выберите нужный метод, нажмите Try it out, заполните параметры запроса и выполните запрос через Execute.

Перед отправкой запросов необходимо авторизоваться через кнопку Authorize, указав токен в формате:

Bearer <ваш токен>

После выполнения запроса Swagger автоматически покажет HTTP-запрос, curl-команду, статус ответа и JSON-ответ сервера.

Интеграция с Postman

Swagger-спецификацию можно импортировать напрямую в Postman. Для этого откройте Import, перейдите во вкладку Link и укажите:

https://bothub.chat/api/v2/swagger.json

После импорта Postman автоматически создаст готовую коллекцию запросов со всеми доступными методами API. Для выполнения запросов останется только указать Bearer-токен в заголовке Authorization.

Интеграция с Insomnia

Insomnia поддерживает прямой импорт OpenAPI-спецификаций. Для подключения создайте новый проект, выберите Import From URL и укажите ссылку на swagger.json.

https://bothub.chat/api/v2/swagger.json

После импорта все методы API и параметры запросов будут доступны автоматически.

Интеграция с Bruno

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

https://bothub.chat/api/v2/swagger.json

После импорта Bruno автоматически создаст структуру запросов и методов.

Пример использования

Ниже приведён пример простого запроса к OpenAI-совместимому API через curl. В примере отправляется сообщение модели и получается текстовый ответ от AI.

Такой формат удобно использовать для быстрой проверки API, тестирования авторизации или интеграции с собственным приложением.

curl 'https://openai.bothub.chat/v1/chat/completions' \
  -H 'Authorization: Bearer <ваш токен доступа>' \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "gpt-5-mini",
    "messages": [
      {
        "role": "user",
        "content": "Привет!"
      }
    ]
  }'

В ответ API вернёт JSON с результатом генерации, включая текст ответа модели, информацию об использовании токенов и технические метаданные запроса.