Changelog

Find a version

All versions All versions forward

Version 0.2.1

Release Date: 2026-01-08

General Summary

The new version of the API is a major update focused on user experience. The most significant changes include:

• Removal of Administration Endpoints: All routes for creating, modifying, and deleting base resources (models, languages, users) have been removed from this specification to make it purely user-oriented.
• New Authentication Method: The authentication system has been revamped.
• URL Standardization: Endpoint paths have been simplified and made more consistent.
• Introduction of Pagination: Resource lists are now paginated for better performance.
• Data Model Enrichment: API responses are now more detailed and better documented.

---

❗ Breaking Changes

These changes will require modifications in any existing integration.

1. Authentication

• The old ApiKeyAuth security mechanism that used the Authorization header has been removed.
• The new version uses bearerAuth (for JWT tokens) and apiKeyHeader which expects a key in the X-API-Key header.

2. URL Structure

• The /api/v1 prefix has been removed from all paths and is now part of the server URL (https://aura.authot.live/backend/api/v1).
• Path identifiers have been standardized to {id} (e.g., /models/{modelId} becomes /models/{id}).
• Trailing slashes have been added to several routes for consistency (e.g., /languages becomes /languages/).

3. Removed Endpoints

• All administration endpoints have been removed from this documentation, specifically:
  • POST, PUT, DELETE on /languages
  • POST, PUT, DELETE on /models
  • POST, PUT, DELETE on /translations
  • POST /users, POST /setup/initial-admin
  • POST /settings
• The following user endpoints have been removed:
  • GET /api/v1/ping (now /ping but the prefix changed)
  • GET /api/v1/lives/1/save
  • GET /api/v1/lives/1/saves/
  • GET /api/v1/live_translations/{liveTranslationId}/save

4. Response Structure

• Endpoints that return lists (like GET /languages/) no longer use a count field. They now return a pagination object containing total_items, total_pages, current_page, and per_page.

5. Modified Query Parameters

• GET /languages/: The active filter parameter has been removed.
• GET /models: The active filter parameter has been removed.
• GET /settings: The user_id and username parameters have been removed. The endpoint now returns the authenticated user’s settings.

---

✨ New Features (Additions)

1. New Endpoints

New GET endpoints have been added to retrieve a single resource by its identifier:

• GET /languages/{id}: Retrieve a specific language.
• GET /models/{id}: Retrieve a specific model.
• GET /translations/{id}: Retrieve a specific translation pair.
• GET /tokens/{id}: Retrieve a specific API token.

2. Pagination

• The following list endpoints now support pagination with the skip and limit query parameters:
  • GET /languages/
  • GET /models/
  • GET /translations/
  • GET /user-live-configs/
  • GET /tokens/
  • GET /lives/

3. WebSocket Documentation

• A new Websocket section has been added to document in detail how the real-time API works.

---

✏️ Modifications and Improvements

1. Data Schemas

• Data models (schemas) are now formally defined and highly detailed, with clear descriptions for each field. This significantly improves the clarity and predictability of the API.
• Responses for live sessions (Live), translations (Translation), and others are much richer and include nested objects for models and languages.

2. Endpoint Simplification

• GET /settings: Simplified to no longer take parameters and directly return the connected user’s configuration.

3. HTTP Response Codes

• DELETE operations now return a 204 No Content status code, which is a more standard practice for successful deletions with no content to return.

4. API Metadata

• The API title has been changed from “Aura Live” to “User”.
• The OpenAPI version has changed from 3.0.3 to 3.0.1.
• The server URL has been updated.