API Reference
This document provides technical specifications for the AIGNE Hub RESTful API. By following this guide, you will understand how to authenticate and interact with the core endpoints for chat completions, image generation, and embeddings, enabling robust backend integrations with your applications.
The AIGNE Hub API provides a unified interface to various underlying AI models, abstracting the complexity of individual provider APIs. All requests are authenticated using API keys.
The following diagram illustrates the interaction between an application, the AIGNE Hub API, and the underlying AI models.
For detailed specifications on each endpoint, including request and response schemas, please refer to the specific sub-sections:
Endpoints#
The following table provides a summary of the available API endpoints.
Method | Endpoint | Description |
|---|---|---|
|
| Generates a response for a given chat conversation. |
|
| Generates vector embeddings for a given input text. |
|
| Creates an image based on a text prompt. |
|
| Transcribes audio into the input language. |
|
| Generates audio from the input text. |
|
| Checks the availability of the service and models. |
Summary#
This section provided an overview of the AIGNE Hub API, covering authentication and a summary of available endpoints. For practical integration, proceed to the detailed documentation for each endpoint.
- For building conversational AI: See the Chat Completions API.
- For generating images: Explore the Image Generation API.
- For text analysis and search: Use the Embeddings API.