Valorum AI
Быстрый старт
Начните использовать Valorum AI API за несколько минут
1

Получите API ключ

Создайте ключ в разделе API Ключи

2

Загрузите документы

Добавьте ваши документы в Базу знаний

3

Отправьте первый запрос

Используйте endpoint /api/v1/query для RAG запросов

POST/api/v1/query
Выполнить запрос с использованием RAG и получить AI ответ

Параметры

НазваниеТипОбязательныйОписание
querystringДаТекст запроса
knowledgeBaseIdnumberНетID базы знаний
modelstringНетМодель AI (по умолчанию: openai/gpt-4o-mini)
maxTokensnumberНетМаксимум токенов (по умолчанию: 1000)
temperaturenumberНетТемпература (по умолчанию: 0.7)
systemPromptstringНетКастомный системный промпт
topKnumberНетКоличество результатов поиска (по умолчанию: 5)
streambooleanНетВключить стриминг (по умолчанию: false)

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

curl -X POST https://api.valorum.ai/v1/query \
  -H "Authorization: Bearer vl_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Как настроить интеграцию?",
    "knowledgeBaseId": 1,
    "topK": 3
  }'

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

{
  "success": true,
  "data": {
    "response": "Для настройки интеграции...",
    "sources": [
      {
        "content": "Документация по интеграции...",
        "score": 0.92,
        "documentId": 123
      }
    ],
    "usage": {
      "promptTokens": 150,
      "completionTokens": 200,
      "totalTokens": 350
    },
    "latencyMs": 450
  }
}
Коды ошибок
КодОписание
400Bad Request - Неверные параметры запроса
401Unauthorized - Отсутствует или неверный API ключ
403Forbidden - Недостаточно прав или ключ отключен
429Too Many Requests - Превышен лимит запросов
500Internal Server Error - Внутренняя ошибка сервера