🚀 API Документация

📋 Обзор API

CloudAI предоставляет унифицированное API для работы с ИИ. Система использует современные стандарты с возможностью выбора различных эндпоинтов для разных типов задач.

🏷️ Типы эндпоинтов

🎯 Тип	🔧 Код эндпоинта	📖 Описание
💬 Чат/Текст	cloud_chat	Основной чат с ИИ
💬 Чат/Текст	cloudv1_chat	Альтернативный чат с ИИ
💬 Чат/Текст	cloudv3_chat	Дополнительный чат с ИИ
💬 Чат/Текст	cloudv4_chat	Расширенный чат с ИИ
💬 Чат/Текст	cloudv5_chat	Специализированный чат с ИИ
💬 Чат/Текст	google_chat	Google AI чат
🎨 Изображения	frzcloud_tgter	Генерация изображений
🎨 Изображения	cloudv2_image	Альтернативная генерация изображений

🌐 Публичное API

🔗 Базовый URL

https://api.frzcloud.ru

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

📋 Подробная документация: Полную документацию по авторизации, регистрации, управлению токенами и профилем смотрите в разделе 🔐 Авторизация API CloudAI.

📋 Получение токена: Токен можно получить в дашборд в личном кабинете пользователя на сайте frzcloud.ru

🔑 Использование токена:

Authorization: Bearer <YOUR_TOKEN>

🚀 Быстрый старт:

1. Зарегистрируйтесь или войдите
2. Получите токен
3. Используйте токен в заголовке Authorization: Bearer

💬 Чат/Текст - /api/public/v1/chat/completions

📍 Endpoint: POST /api/public/v1/chat/completions

⚙️ Обязательные параметры:

• endpoint или endpoint_code - код эндпоинта
• model - ID модели
• messages - массив сообщений

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

Пример POST запроса к API чата

curl -X POST https://api.frzcloud.ru/api/public/v1/chat/completions \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint_code": "cloud_chat",
    "model": "gpt-4o",
    "messages": [
      {"role": "user", "content": "Hello!"}
    ],
    "temperature": 0.7,
    "max_tokens": 1000
  }'

📤 Пример ответа:

JSON ответ от API

{
  "id": "chatcmpl-123456",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 8,
    "total_tokens": 18
  }
}

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

💬 Пример чата с ИИ

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

// Пример использования API для чата
const response = await fetch('https://api.frzcloud.ru/api/public/v1/chat/completions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    endpoint_code: 'cloud_chat',
    model: 'gpt-4o',
    messages: [
      { role: 'user', content: 'Hello!' }
    ],
    temperature: 0.7,
    max_tokens: 1000
  })
});

const data = await response.json();
console.log(data.choices[0].message.content);

Доступные эндпоинты:

• cloud_chat - Основной чат с ИИ
• cloudv1_chat - Альтернативный чат с ИИ
• cloudv3_chat - Дополнительный чат с ИИ
• google_chat - Google AI чат
• cloudv4_chat - Расширенный чат с ИИ
• cloudv5_chat - Специализированный чат с ИИ

🎨 Генерация изображений - /api/public/v1/images/generations

📍 Endpoint: POST /api/public/v1/images/generations

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

curl -X POST https://api.frzcloud.ru/api/public/v1/images/generations \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint_code": "cloudv2_image",
    "model": "sdxl-turbo",
    "prompt": "A beautiful sunset over mountains",
    "size": "1024x1024",
    "n": 1
  }'

Доступные эндпоинты:

• cloudv2_image - Основная генерация изображений
• frzcloud_tgter - Альтернативная генерация изображений

📋 Получение списка моделей - /api/public/v1/endpoints/{code}/models

📍 Endpoint: GET /api/public/v1/endpoints/{code}/models

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

curl -X GET https://api.frzcloud.ru/api/public/v1/endpoints/cloud_chat/models \
  -H "Authorization: Bearer YOUR_TOKEN"

Ответ:

[
  {
    "model": "gpt-4",
    "display_name": "GPT-4",
    "source_table": "a_i_models"
  },
  {
    "model": "sonar,
    "display_name": "sonar",
    "source_table": "a_i_models"
  }
]

🌐 Публичный список endpoint'ов и моделей - /api/public/v1/models

📍 Endpoint: GET /api/public/v1/models

Описание: Возвращает JSON с массивом доступных endpoint'ов и их моделей. Каждая запись содержит поля endpoint, name, endpoint_type и models (массив объектов с display_name).

Пример структуры ответа:

{
  "success": true,
  "data": [
    {
      "endpoint": "cloudv2_image",
      "name": "Cloud v2 Image",
      "endpoint_type": "image_generation",
      "models": [
        { "display_name": "SDXL-Turbo" },
        { "display_name": "Flux" }
      ]
    }
  ]
}

❌ Обработка ошибок

📊 HTTP статусы

• 200 - Успешный запрос
• 400 - Ошибка валидации / неподдерживаемый эндпоинт
• 401 - Ошибка аутентификации
• 402 - Недостаточно средств / лимита
• 429 - Превышен лимит запросов
• 500 - Внутренняя ошибка сервера

Структура ошибок

{
  "error": {
    "code": "payment_required",
    "message": "Недостаточно средств или лимита"
  }
}