Beyond Better API Documentation

This document provides details about the endpoints available in the Beyond Better API.

Base URL

All endpoints are relative to: https://<hostname>:<port>/api/v1

Endpoints

API Status

GET /status

Check the status of the API.

Conversation Management

List Conversations

GET /conversation

Retrieve a list of conversations with pagination and filtering options.

Get Conversation

GET /conversation/:id

Retrieve details of a specific conversation.

Continue Conversation

POST /conversation/:id

Continue an existing conversation.

Delete Conversation

DELETE /conversation/:id

Delete a specific conversation.

Clear Conversation

POST /conversation/:id/clear

Clear the history of a specific conversation.

WebSocket Connection

GET /ws/conversation/:id

Establish a WebSocket connection for real-time conversation updates.

Note on Unimplemented Features

Some features mentioned in the codebase are not fully implemented or exposed through the API. These may be implemented in future versions.

Error Handling

All endpoints may return appropriate HTTP status codes for various error conditions. Detailed error messages will be provided in the response body when applicable.

Authentication

The current implementation does not include authentication. It is designed for local use only. Ensure proper security measures are in place when deploying this API in a production environment.

Versioning

This documentation is for API version 1 (v1). Future versions may introduce changes to the endpoint structure or functionality.