Help & Guides
Your guide to understanding and using the Alkimi platform.
Getting Started
Welcome to Alkimi AI, the infrastructure for grounded, academic AI. Our platform empowers you to transform your proprietary data (documents, curriculum, and research) into secure, intelligent agents that guide learning and automate workflows. Unlike generic AI tools, Alkimi ensures your assistants are strictly grounded in the knowledge you provide, offering control, accuracy, and pedagogical value.
This documentation is designed to help you get up and running quickly. Whether you are a professor building a Socratic tutor for your students, an administrator setting up a compliance bot, or a developer integrating our API, these guides will walk you through every step of the process, from ingesting your first document to deploying your fully customized agent.
How We Work
The Alkimi platform operates in three high-level stages:
Ingest & Ground
Connect proprietary data sources
Build & Customize
Configure persona & controls
Deploy & Interact
Launch to employees or customers
- Ingest & Ground: Clients securely connect their proprietary data sources (such as documents, curriculum materials, or support wikis) to the platform. Alkimi processes and indexes this knowledge to create a secure, private foundation for the AI.
- Build & Customize: Organizations use the platform to configure their intelligent assistants. This includes defining parameters, setting access controls (i.e., private vs. public), and customizing the assistant's persona.
- Deploy & Interact: The resulting AI assistant is deployed to its intended audience. This can be internally for secure access by employees or students, or externally by embedding it directly onto a public website to serve as a customer support or help agent.
Key Concepts
- Agents: Customizable AI entities that can perform tasks, answer questions, and automate workflows.
- Knowledge: Collections of documents and data that you can provide to your agents, giving them a unique context and knowledge base.
- Snippets (or Chunks): When you upload a document, it is broken down into smaller, manageable pieces of text called snippets. The retrieval system searches these snippets to find the most relevant information for a user's query.
- Chats: The primary interface for interacting with your agents.
Navigation
The platform uses a bottom-left navigation menu to switch between different tools and settings.
- App Navigation: Click the button showing your current location (e.g., "Chat") and organization to open the main menu. From here, you can switch between Chat, Agents, Knowledge, and Organization Settings. You can also switch organizations if you belong to multiple workspaces.
- Organization Menu: Included in the main menu, this allows you to switch between different organizations or create a new one. See the Organization guide for more details.
- Account Menu: Click your profile picture to access personal settings, including your Profile, Preferences, Help & Guides, and Logout. See the Account guide for more details.
Your First Agent: A 5-Minute Tutorial
Let's create a simple agent that can answer questions about a specific topic.
- Create a Knowledge Collection: Open the main navigation menu in the bottom left and select Knowledge. Click the plus (+) button next to the collection dropdown in the sidebar and give it a name, like "Project Research."
Create Collection
Collection nameWhat is this collection about? (Optional)0 / 512 - Add a Document: Select your new collection in the sidebar. Then, click the plus (+) button next to "Content" or hover over a folder, click the three dots (...), and select "Add File(s)." In the dialog, click "Click to select files" to upload a PDF or text file.
Add File(s)
Select files to upload.
Click to select files BrowseMax 100MB & 1000 pages per file.
Extract ModeAutoVerbatimDistilledAuto: Automatically detects the best extraction mode for the file content. Recommended for most use cases.
3 credits per page - Create the Agent: Open the navigation menu again and select Agents. Click the plus (+) button next to the agent dropdown in the sidebar. Give it a name, like "Research Assistant."
Create Agent
Enter a name and choose a starting point for your new agent.
My New AgentStart from a TemplateTemplates provide a pre-configured starting point for an agent, including its core instructions, personality, and variables.
AI Agent Builder
Describe what you need and AI will build it for you.
Browse Catalog
Explore the full catalog of all templates.
- Connect the Knowledge: In the agent configuration screen, go to the "Knowledge" tab. Select your "Project Research" collection to connect it to the agent.
MA301: Division Algorithm - Knowledge
Manage Knowledge Access
Select the knowledge collections this agent should have access to. The agent will use the information within the selected collections to answer user questions.
Context Limit
570 / 10,4851.4k5.9kOptimal High CriticalKnowledge Collections
Rosen - Elementary Number TheoryContains 12 items (450 snippets)Lecture 1: DivisibilityContains 5 items (120 snippets)Problem Set 1Contains 20 items (300 snippets)Axioms ReferenceContains 1 items (50 snippets) - Start Chatting: That's it! Open the navigation menu and select Chat. Select your new "Research Assistant" from the sidebar, and start asking it questions about the document you uploaded. Proof of Existence
How do I prove the existence part of the division algorithm?
Consider the set S = { a - bk : k is an integer, a - bk >= 0 }. To show existence, you can apply the **Well-Ordering Principle** to this set.
- Show S is non-empty
- Apply Well-Ordering Principle to find least element r
- Prove r < |b|
Theorem 1.1.pdfAlkimi AI can make mistakes. Check important info.Ask a question about the Division Algorithm...
Tip: Creating an Agent from a File
You can also create a new agent from a configuration file. In the "Create Agent" dialog, click the "Import from File" button in the footer. This will open a file picker for you to select a JSON configuration file. This is
a great way to quickly set up a new agent from a backup or a shared template. You can override the name of the agent from the file by entering a new name in the dialog before clicking import.