Skip to main content

Introduction

Welcome to the Ask API documentation! This guide will help you understand and integrate with our powerful AI agent platform.

What is Ask API?​

The Ask API provides a comprehensive set of endpoints that allow you to interact with AI agents, manage documents and collections, and build conversational experiences into your applications.

Key Features​

🤖 AI Agents​

Create and manage AI agents that can answer questions, process information, and engage in conversations with your users.

💬 Conversations​

Build interactive conversational experiences with support for both streaming and non-streaming responses.

📄 Document Management​

Upload, organize, and manage documents that your AI agents can reference and query against.

📚 Collections​

Organize your documents into collections for better organization and scoped agent interactions.

What You Can Build​

With the Ask API, you can:

  • Chatbots and Virtual Agents: Create intelligent conversational interfaces for your applications
  • Document Q&A Systems: Build systems that can answer questions based on your document collections
  • Knowledge Management Tools: Develop tools that help users find and interact with information
  • Custom AI Applications: Integrate AI capabilities into your existing workflows and applications

API Architecture​

The Ask API is built on RESTful principles and uses JSON for request and response payloads. Key components include:

  • Agents: AI assistants configured to handle specific tasks or domains
  • Conversations: Interaction sessions between users and agents
  • Messages: Individual exchanges within conversations
  • Documents: Content that agents can reference and query
  • Collections: Logical groupings of related documents

Next Steps​

Ready to get started? Head over to the Getting Started guide to begin building with the Ask API.

Need Help?​

If you have questions or need assistance:

  • Check out our API Reference for detailed endpoint documentation
  • Review the code examples in our guides
  • Contact our support team for additional help