VibelensVibelens

API Documentation

POST/:project_id/:engine_id/search

Returns a list of pages that match the search query. Requires API key for protected engines.

URL Parameters:

project_idrequired
string - The ID of the project to search in
engine_idrequired
string - The ID of the engine to use for search

Request Body:

Request Parameters:

queryrequired
string - The search query to execute against the dataset

Response:

Response Parameters:

idrequired
string - Unique identifier of the matched page
urlrequired
string - URL of the matched page
page_titlerequired
string - Title of the matched page
text_contentrequired
string - Text content of the matched page
POST/:project_id/:engine_id/chat

Bot endpoint that can be used to ask questions to the dataset. Requires API key for protected engines.

URL Parameters:

project_idrequired
string - The ID of the project to chat in
engine_idrequired
string - The ID of the engine to use for chat

Request Body:

Request Parameters:

messagerequired
string - The message to send to the bot
chat_idoptional
string - The ID of the chat to continue the conversation

Response:

Response Parameters:

idrequired
string - The ID of the returned message
chat_idrequired
string - The ID of the chat
messagerequired
string - The message returned by the bot
related_contentrequired
array - The related content to the message
GET/:project_id/:engine_id

Returns an engine with its associated bot information.

URL Parameters:

project_idrequired
string - The ID of the project containing the engine
engine_idrequired
string - The ID of the engine to retrieve

Response:

Response Parameters:

idrequired
string - Unique identifier of the engine
namerequired
string - Name of the engine
botrequired
object - Associated bot information

Base URL

The base URL for the API is:

https://backend.vibelens.io/api

Authentication

The OpenAPI endpoints require authentication based on the engine's visibility:

  • Public engines - No authentication required
  • Protected engines - Requires X-API-Key header
  • Private engines - Not accessible via OpenAPI

Rate Limiting

Endpoints are rate limited to:

  • 150 requests per 30 seconds per IP address

Error Handling

The API uses standard HTTP status codes and returns error responses in the following format:

Common Error Codes:

  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Missing or invalid API key
  • 404 Not Found - Engine not found
  • 429 Too Many Requests - Rate limit exceeded
  • 500 Internal Server Error - Server-side error