ВВЕДЕНИЕ
API F5AI позволяет обращаться к моделям OpenAI без необходимости использования VPN, так как все запросы проходят через наши сервера. Работа с API аналогична OpenAI: используются те же запросы, параметры и формат ответов. Оплата возможна российской картой или через счет юридического лица, что удобно для пользователей в России.
Почему стоит использовать API F5AI?
Доступность
Используя сервис F5AI, вы получаете возможность обойти ограничения, присущие доступу к API OpenAI в России, без использования VPN или других методов обхода блокировок.
Безопасность
Управление ключами API с соблюдением стандартов безопасности гарантирует, что ваши данные и разработки останутся защищенными.
Гибкость и масштабируемость
Поддержка множества моделей с выдающимися возможностями позволяет настраивать интеграцию под конкретные нужды вашего проекта.
Удобство оплаты
Возможность производить оплату в рублях делает сервис более доступным для российских пользователей.
НАЧАЛО РАБОТЫ
Получите API-ключ

Чтобы получить токен доступа F5AI, вам необходимо авторизоваться войти в https://app.f5ai.ru и перейти по адресу https://app.f5ai.ru/keys/


Введите имя ключа и выберите вендор - Open AI.

Теперь вы можете скопировать этот ключ и использовать наш API.

КОЛЛЕКЦИЯ ЗАПРОСОВ POSTMAN
С F5AI API можно работать с помощью подготовленной коллекции запросов Postman.
Для использования коллекции запросов Postman:
1
Войдите в свою учетную запись Postman
2
Нажмите кнопку → ▶ Run in Postman
3
Нажмите Fork Collection, чтобы скопировать коллекцию запросов в свое рабочее пространство в Postman.
В открывшемся окне укажите название копии и рабочего пространства, в котором будет создана копия коллекции. Установите флажок Watch original collection, если хотите получать уведомления об изменении в оригинальной коллекции запросов.
4
Нажмите Fork Collection.
СОВЕРШЕНИЕ ЗАПРОСОВ
Отправить синхронный запрос и получить ответ от ChatGPT
🚩 Чтобы отправлять авторизованные запросы нужно получить API ключ, как это сделать написано в разделе «Начало работы»
POST
https://api.f5ai.ru/v1/chat/completions
Синхронный запрос к моделям ChatGPT
Headers
Name
Type
Description
X-Auth-Token*
string
API ключ
Request Body
Name
Type
Description
model*
string
ID модели чата
messages*
array
Контекст сообщений
max_tokens
number
Длина ответа (MAX 4096)
temperature
number
Креативность (от 0 до 1)
Пример запроса, который можно отправить с помощью curl:
curl https://api.f5ai.ru/v1/chat/completions \
-H "Content-Type: application/json" \
-H "X-Auth-Token: $F5AI_API_KEY" \
-d '{

	"model": "gpt-4o-mini",
	"max_tokens": "16383",
	"messages": [
		{
			"role": "system",
			"content": "Твое имя Андрей."
		},
		{
			"role": "user",
			"content": "Как тебя зовут?"
		}
	]
}'
В ответ вы получите JSON-структуру с результатами обработки вашего запроса, который выглядит вот так:
{
 "id": "chatcmpl-8FheRf68Hi4pnuiRqYPHyZJr3UlAU",
 "object": "chat.completion",
 "created": 1698753407,
 "model": "gpt-4о-mini-2024-07-18",
 "choices": [
   {
     "index": 0,
     "message": {
     	"role": "assistant",
       "content": ""Меня зовут Андрей, чем я могу сегодня помочь?"
     },
     "finish_reason": "stop"
   }
 ],
 "usage": {
   "prompt_tokens": 24,
   "completion_tokens": 8,
   "total_tokens": 32,
   "prompt_cost": 0.01608,
   "completion_cost": 0.007200000000000001,
   "total_cost": 0.023280000000000002
   }
}
Если вы хотите указать чату конкретную роль, профессию или дать четкую инструкцию, то используйте следующий content:
content= [
    {
        "role": "system",
        "content": "Ты программист, отвечай на все вопросы только как программист. Твои ответы должны быть в виде кода на python или на js."
    },
    {
        "role": "user",
        "content": "Расскажи о своих навыках"
    }
]
и вы получите следующий ответ:
 "role": "assistant",
        "content": "Я искусственный интеллект, программируемый на Python и JS. Могу помочь с написанием кода, отладкой, объяснением алгоритмов и учебой программирования.",
Возможные ошибки
Код: 400
Сообщение: Invalid key
Описание: Неверный формат ключа
Код: 404
Сообщение: Key not found
Описание: Ключ с таким id не найден
Код: 409
Сообщение: Key is revoked
Описание: Ключ был удалён
Код: 404
Сообщение: Key secret not found
Описание: Cекретный ключ API ключа отсутствует
Код: 404
Сообщение: Account not found
Описание: Аккаунт ключа не найден
Код: 402
Сообщение: Payment required
Описание: На аккаунте недостаточно средств
Код: 401
Сообщение: Unauthorized
Описание: Процесс авторизации завершился с ошибкой
Код: 405
Сообщение: Vendor not supported
Описание: Вендор ключа не поддерживает запросы через API
Код: 400
Сообщение: Model not available
Описание: Данная модель не поддерживается сервисом F5AI
СПИСОК МОДЕЛЕЙ
Получить список доступных моделей
🚩 Чтобы отправлять авторизованные запросы нужно получить API ключ, как это сделать написано в разделе «Начало работы»
Запрос списка моделей
GET
https://api.f5ai.ru/v1/models
Возвращает список всех доступных моделей
Name
Type
Description
X-Auth-Token*
string
API ключ
Пример запроса
{
    "status": true,
    "response": {
        "models": [
            {
                "code": "whisper-1",
                "type": "audio",
                "available": true,
                "vision": false
            },
            {
                "code": "gpt-3.5-turbo",
                "max_tokens": 4096,
                "type": "text",
                "available": true,
                "vision": false
            },
            {
                "code": "gpt-4-turbo",
                "max_tokens": 4096,
                "type": "text",
                "available": true,
                "vision": false
            },
            {
                "code": "gpt-4o",
                "max_tokens": 4096,
                "type": "text",
                "available": true,
                "vision": true
            },
            {
                "code": "gpt-4o-mini",
                "max_tokens": 16383,
                "type": "text",
                "available": true,
                "vision": true

            }
        ]
    }
}
Возможные ошибки
{
 "error": {
   "message": "Unauthorized",
   "type": "unauthorized_request_error",
   "param": null,
   "code": null,
 }
}
Если у Вас остались вопросы, пожалуйста, напишите нам на info@comf5.ru