Introduction
A brief introduction to Hyperleap AI API
Welcome to the Hyperleap AI API documentation. This guide will help you understand how to interact with the Hyperleap AI API to create, retrieve, update, and manage AI conversations, prompts, and related resources through HTTP requests.
Base URL
All URLs referenced in the documentation have the following base:
Authentication
The Hyperleap AI API uses API key authentication. When making requests, you must include your API key in the x-hl-api-key
header:
For more details, please refer to the API Keys page.
API Resources
Start integrating with Hyperleap AI API by exploring the following resources:
Conversations API
Create and manage AI conversations with general or persona-based interactions.
Prompts API
Run prompts with various streaming options for AI-powered text generation.
Capture Feedback API
Collect and store user feedback on AI interactions to improve quality.
Audit Report API
Retrieve detailed information about AI interactions for auditing and compliance.
Feedback Report API
Access aggregated feedback data to analyze user satisfaction and AI performance.
Moderations API
Check content against moderation policies to ensure safe AI interactions.