Master API Reference
Relevant source files
The following files were used as context for generating this wiki page:
Introduction
The Master API Reference provides a comprehensive overview of the RESTful interfaces available within the Aether-X Ultimate platform. This project is built on a microservices architecture where an Central API Gateway serves as the primary entry point for all client requests, providing unified routing, rate limiting, and request logging across specialized services.
Sources: README.md:16-25, services/api-gateway/app.py:12-21
The API ecosystem covers several domains: content generation (text, image, video), AI model interactions, no-code application development, high-security operations including encryption and custom protocols, and complex data processing pipelines. All services expose /health endpoints for monitoring and are integrated into the gateway's routing logic.
Sources: README.md:44-77, services/api-gateway/app.py:82-206
API Gateway and Routing
The API Gateway (Port 80) acts as a reverse proxy, dispatching requests to internal microservices based on URL path segments. It implements a global rate-limiting mechanism and a logging decorator to track request duration and status.
Sources: services/api-gateway/app.py:27-77
Request Flow Architecture
The following diagram illustrates how a client request is processed through the Gateway and routed to the appropriate backend service.
The Gateway uses a proxy_request function to handle generic routing and specialized wrappers for versioned v1 endpoints.
Sources: services/api-gateway/app.py:85-115
Security and Authentication
The Security service (Port 8005) provides identity management using JWT tokens and bcrypt password hashing. It also facilitates data privacy through Fernet symmetric encryption and customizable security protocols.
Sources: services/security/app.py:20-55
Authentication Endpoints
| Endpoint | Method | Description | Source |
|---|---|---|---|
/api/v1/user/register | POST | Registers a new user with bcrypt password hashing. | services/security/app.py:84-118 |
/api/v1/user/login | POST | Authenticates credentials and returns a JWT token. | services/security/app.py:120-156 |
Security Operations Endpoints
| Endpoint | Method | Description | Source |
|---|---|---|---|
/api/v1/encrypt | POST | Encrypts plaintext using Fernet (Zero-knowledge architecture). | services/security/app.py:158-181 |
/api/v1/decrypt | POST | Decrypts ciphertext provided the correct JWT and keys. | services/security/app.py:183-206 |
/api/v1/protocol/create | POST | Defines custom security parameters (algorithm, key length). | services/security/app.py:208-243 |
AI and Content Generation
This section details endpoints for generating media and interacting with Large Language Models (LLMs) and specialized domain models.
Text and LLM Services
The system utilizes GPT-2 for general text generation and supports both single-prompt and batch-processing modes.
| Endpoint | Method | Payload Parameters | Source |
|---|---|---|---|
/api/v1/text/generate | POST | prompt, language | services/text-generation/app.py:18-39 |
/api/v1/llm/generate | POST | prompt, model_name | services/ai-models/app.py:32-53 |
batch-generate | POST | prompts (Array) | services/text-generation/app.py:41-65 |
Specialized Predictions
Specialized models can be invoked for specific tasks like anomaly detection or text classification.
Sources: services/ai-models/app.py:85-132
No-Code Development
The No-Code service (Port 8004) enables users to create application structures and automated workflows using natural language descriptions.
Sources: services/no-code-development/app.py:15-135
Application Creation Data Model
| Field | Type | Description | Source |
|---|---|---|---|
app_id | UUID | Unique identifier for the generated application. | services/no-code-development/app.py:32 |
structure | Object | Contains generated pages, components, and data_sources. | services/no-code-development/app.py:137-175 |
workflow_id | UUID | Identifier for specific automation logic. | services/no-code-development/app.py:90 |
Workflow Execution
Workflows are composed of steps such as api_call, data_processing, and content_generation.
Sources: services/no-code-development/app.py:185-235
Data Processing and ETL
The Data Processing service (Port 8006) manages data ingestion, real-time stream processing, and ETL (Extract, Transform, Load) pipelines.
Sources: services/data-processing/app.py:16-105
Data Pipeline Components
| Component | Functionality | Source |
|---|---|---|
| Ingest | Synchronous data reception and queuing. | services/data-processing/app.py:21-46 |
| Stream | Asynchronous background threads processing data_queue. | services/data-processing/app.py:144-177 |
| ETL | Pipeline execution including Extract, Transform, and Load steps. | services/data-processing/app.py:107-124 |
Conclusion
The Aether-X Ultimate Master API provides a modular and secure interface for complex AI operations. By centralizing these capabilities through the API Gateway, the platform ensures consistent security, rate limiting, and monitoring across all functional domains, from generative AI to custom data pipelines.