Skip to main content

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.

API Reference

For detailed specifications on each endpoint, including request and response schemas, please refer to the specific sub-sections:

Chat Completions

Detailed specification for the chat completions endpoint, including request/response schemas and streaming support.

Image Generation

Reference for the image generation endpoint, covering supported models and parameters for size and quality.

Embeddings

Documentation for creating vector representations of text for use in semantic search and other ML tasks.

API Authentication

Explains how to securely authenticate requests to the AIGNE Hub API using OAuth and API keys.

Endpoints

The following table provides a summary of the available API endpoints.

MethodEndpointDescription
POST/chat/completionsGenerates a response for a given chat conversation.
POST/embeddingsGenerates vector embeddings for a given input text.
POST/image/generationsCreates an image based on a text prompt.
POST/audio/transcriptionsTranscribes audio into the input language.
POST/audio/speechGenerates audio from the input text.
GET/statusChecks 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.