Beyond Better Hub Documentation

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

Base URL

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

Endpoints

Hub Status

GET /status

Check the status of the Hub.

Collaboration Management

List Collaborations

GET /collaboration

Retrieve a list of collaborations with pagination and filtering options.

Get Collaboration

GET /collaboration/:id

Retrieve details of a specific collaboration.

Continue Collaboration

POST /collaboration/:id

Continue an existing collaboration.

Delete Collaboration

DELETE /collaboration/:id

Delete a specific collaboration.

Clear Collaboration

POST /collaboration/:id/clear

Clear the history of a specific collaboration.

WebSocket Connection

GET /ws/collaboration/:id

Establish a WebSocket connection for real-time collaboration updates.

Note on Unimplemented Features

Some features mentioned in the codebase are not fully implemented or exposed through the Hub. 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 Hub in a production environment.

Versioning

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