Skip to content

API Reference

Jump to bottom
Nikita Ganzikov edited this page Jan 6, 2026 · 1 revision

API Reference

Bright provides a RESTful API for managing search indexes and documents.

Base URL

http://localhost:3000

Response Format

All responses are in JSON format.

Success Response

{
  "hits": [...],
  "totalHits": 10,
  "totalPages": 2
}

Error Response

{
  "error": "error message"
}

HTTP Status Codes

  • 200 OK - Request successful
  • 201 Created - Resource created successfully
  • 204 No Content - Request successful with no content to return
  • 400 Bad Request - Invalid request parameters
  • 404 Not Found - Resource not found
  • 500 Internal Server Error - Server error

API Sections

Clone this wiki locally