# Hyperleap AI

## Docs

- [API Keys](https://docs.hyperleap.ai/api-reference/api-keys.md): How to obtain and use API keys for authentication
- [Conversation run details](https://docs.hyperleap.ai/api-reference/audit-report/conversation-run-details.md): Get details of a specific conversation run for audit.
- [Conversations](https://docs.hyperleap.ai/api-reference/audit-report/conversations.md): Get Conversations for audit based on filter conditions passed in.
- [Audit Report Overview](https://docs.hyperleap.ai/api-reference/audit-report/overview.md): Overview of the Audit Report API endpoints
- [Prompt run details](https://docs.hyperleap.ai/api-reference/audit-report/prompt-run-details.md): Get details of a specific prompt run for audit.
- [Prompt runs](https://docs.hyperleap.ai/api-reference/audit-report/prompt-runs.md): Get Prompt runs for audit based on filter conditions passed in.
- [Capture Feedback Overview](https://docs.hyperleap.ai/api-reference/capture-feedback/overview.md): Overview of the Capture Feedback API endpoints
- [Set Conversation Score](https://docs.hyperleap.ai/api-reference/capture-feedback/set-conversation-score.md): Set the Conversation's Score (while gathering user feedback).
- [Set Message's Score](https://docs.hyperleap.ai/api-reference/capture-feedback/set-messages-score.md): Set the Message Score in a Conversation (while gathering user feedback).
- [Set Prompt run Score](https://docs.hyperleap.ai/api-reference/capture-feedback/set-prompt-run-score.md): Update the score parameters for a Prompt run based on User feedback.
- [Completions API](https://docs.hyperleap.ai/api-reference/completions/overview.md): Execute raw prompt completions without creating/storing a prompt first
- [Continue Chat](https://docs.hyperleap.ai/api-reference/conversations/continue-chat.md): Send a (user) message to a conversation, and get a response.
- [Continue (HTTP/2 Streaming)](https://docs.hyperleap.ai/api-reference/conversations/continue-http2-streaming.md): Send a user message and continue an existing Conversation. Streams response using HTTP/2 (recommended).
- [Continue (SSE Streaming)](https://docs.hyperleap.ai/api-reference/conversations/continue-sse-streaming.md): Send a user message and continue an existing Conversation. Streams response using SSE.
- [Create a General Conversation](https://docs.hyperleap.ai/api-reference/conversations/create-a-general-conversation.md): Create a General Conversation, without targetting a Persona.
- [Create a Persona Conversation](https://docs.hyperleap.ai/api-reference/conversations/create-a-persona-conversation.md): Start a Conversation with a Persona.
- [Get All Conversations](https://docs.hyperleap.ai/api-reference/conversations/get-all-conversations.md): Get all the conversations for the specified caller, 10 at a time.
- [Get All Conversations with a Persona](https://docs.hyperleap.ai/api-reference/conversations/get-all-conversations-with-a-persona.md): Get all the persona conversations for the specified caller, 10 at a time.
- [Get Specific Conversation](https://docs.hyperleap.ai/api-reference/conversations/get-specific-conversation.md): Get the Conversation based on the ConversationId passed in.
- [Get User Conversations](https://docs.hyperleap.ai/api-reference/conversations/get-user-conversations.md): Get all the conversations for the caller and a specific external user, 10 at a time.
- [Conversations Overview](https://docs.hyperleap.ai/api-reference/conversations/overview.md): Overview of the Conversations API endpoints
- [Set Conversation as Active](https://docs.hyperleap.ai/api-reference/conversations/set-conversation-as-active.md): Set the Conversation as active.
- [Set Conversation's Metadata](https://docs.hyperleap.ai/api-reference/conversations/set-conversations-metadata.md): Set the Conversation's Metadata.
- [Set Conversation's Name](https://docs.hyperleap.ai/api-reference/conversations/set-conversations-name.md): Set the Conversation's name.
- [Set Conversation's Status](https://docs.hyperleap.ai/api-reference/conversations/set-conversations-status.md): Set the Conversation's status.
- [Errors](https://docs.hyperleap.ai/api-reference/errors.md): Troubleshoot problems with this comprehensive breakdown of all error codes.
- [Conversations](https://docs.hyperleap.ai/api-reference/feedback-report/conversations.md): Get Conversations for feedback analysis based on filter conditions passed in.
- [Feedback Report Overview](https://docs.hyperleap.ai/api-reference/feedback-report/overview.md): Overview of the Feedback Report API endpoints
- [Prompt runs](https://docs.hyperleap.ai/api-reference/feedback-report/prompt-runs.md): Get Prompt runs for feedback analysis based on filter conditions passed in.
- [Introduction](https://docs.hyperleap.ai/api-reference/introduction.md): A brief introduction to Hyperleap AI API
- [Moderations Check](https://docs.hyperleap.ai/api-reference/moderations/moderations-check.md): Gets information on whether the user input contains any intent that is sexual, hatred, harassment, self-harm or violent in nature.
- [Moderations Overview](https://docs.hyperleap.ai/api-reference/moderations/overview.md): Overview of the Moderations API endpoints
- [Prompts Overview](https://docs.hyperleap.ai/api-reference/prompts/overview.md): Overview of the Prompts API endpoints
- [Run Prompt (HTTP/2 Streaming)](https://docs.hyperleap.ai/api-reference/prompts/run-prompt-http2-streaming.md): Run a specific prompt based on the Prompt ID and Prompt Version ID passed in. The results will be streamed using HTTP/2. Not recommended when creating classifiers to make decisions, since full response is not available for decision making.
- [Run Prompt (Non-streaming)](https://docs.hyperleap.ai/api-reference/prompts/run-prompt-non-streaming.md): Run a specific prompt based on the Prompt ID and Prompt Version ID passed in. Recommended when creating classifiers to make decisions, since full response is available for decision making
- [Run Prompt (SSE Streaming)](https://docs.hyperleap.ai/api-reference/prompts/run-prompt-sse-streaming.md): Run a specific prompt based on the Prompt ID and Prompt Version ID passed in. The results will be streamed using SSE. Not recommended when creating classifiers to make decisions, since full response is not available for decision making.
- [Assistants](https://docs.hyperleap.ai/guides/assistants/assistants.md): Learn how to use specialized AI Assistants that understand your business and support your team 24/7
- [Create Your First Assistant](https://docs.hyperleap.ai/guides/assistants/create-assistant.md): Learn how to create and configure AI assistants for your specific business needs
- [Chatbots](https://docs.hyperleap.ai/guides/chatbots/chatbots.md): Deploy Website Chatbots Powered By GenAI, in Minutes
- [Create Your First Chatbot](https://docs.hyperleap.ai/guides/chatbots/create-chatbot.md): A Comprehensive Guide to Creating and Configuring AI Chatbots
- [FAQ](https://docs.hyperleap.ai/guides/faq.md): Frequently asked questions about Hyperleap AI
- [Create and Configure Persona](https://docs.hyperleap.ai/guides/personas/create-persona.md): Learn how to create and set up your AI personas in Hyperleap AI
- [Integrate Personas](https://docs.hyperleap.ai/guides/personas/integrate-persona.md): Learn how to integrate your personas into applications using our API
- [Working with Personas](https://docs.hyperleap.ai/guides/personas/personas.md): Learn how to create, manage, and utilize AI personas in Hyperleap AI
- [Create and Configure Prompt](https://docs.hyperleap.ai/guides/prompts/create-prompt.md): Learn how to create and set up your AI prompts in Hyperleap AI
- [Integrate Prompts](https://docs.hyperleap.ai/guides/prompts/integrate-prompt.md): Learn how to integrate your prompts into applications using our API
- [Prompt Engineering Best Practices](https://docs.hyperleap.ai/guides/prompts/prompt-engineering-best-practices.md): Comprehensive guide to designing effective AI prompts with proven techniques and strategies
- [Working with Prompts](https://docs.hyperleap.ai/guides/prompts/prompts.md): Learn how to create, manage, and optimize AI prompts in Hyperleap AI
- [Sources](https://docs.hyperleap.ai/guides/sources.md)
- [Create Your First Tool](https://docs.hyperleap.ai/guides/tools/create-tool.md): Learn how to create and customize AI tools for your specific business needs
- [Tools](https://docs.hyperleap.ai/guides/tools/tools.md): Learn how to use tools to automate your business tasks
- [Troubleshooting](https://docs.hyperleap.ai/guides/troubleshooting.md): Common issues and their solutions
- [Managing Workspaces](https://docs.hyperleap.ai/guides/workspace.md): A comprehensive guide to managing workspaces in Hyperleap AI
- [Introduction](https://docs.hyperleap.ai/introduction.md): Hyperleap AI empowers businesses to build AI solutions across three powerful modes: Bot Studio for customer-facing chatbots, AI Studio for internal team productivity, and API Console for seamless AI integration into your products.
- [ ](https://docs.hyperleap.ai/welcome.md)

## OpenAPI Specs

- [openapi](https://docs.hyperleap.ai/openapi.json)
- [api](https://docs.hyperleap.ai/api.json)

## Optional

- [Pricing](https://hyperleap.ai/pricing)
- [About Hyperleap AI](https://hyperleap.ai)