26 lines
1.3 KiB
Text
26 lines
1.3 KiB
Text
---
|
|
title: Ask AI API Reference
|
|
---
|
|
|
|
The Ask AI API enables developers to build custom chat interfaces powered by Algolia's AI assistant. Use these endpoints to create tailored conversational experiences that search your Algolia index and generate contextual responses using your own LLM provider.
|
|
|
|
:::info
|
|
This API documentation is primarily for developers building custom Ask AI integrations. If you're using the DocSearch package, you typically won't need this information since DocSearch handles the Ask AI API integration automatically. For standard DocSearch usage, see the [DocSearch documentation](/docs/docsearch) instead.
|
|
:::
|
|
|
|
## API Documentation
|
|
|
|
For complete API documentation including endpoints, authentication, request/response formats, and implementation examples, please visit the official Algolia Ask AI API Reference:
|
|
|
|
**[Algolia Ask AI API Reference](https://www.algolia.com/doc/guides/algolia-ai/askai/reference/api)**
|
|
|
|
The official documentation includes:
|
|
|
|
- Authentication and token management
|
|
- Chat endpoint with streaming responses
|
|
- Search parameters and facet filtering
|
|
- Feedback submission
|
|
- Integration examples with Next.js and Vercel AI SDK
|
|
- Error handling and best practices
|
|
|
|
For more information about Ask AI in general, see the [Ask AI documentation](/docs/v4/v4/askai).
|