Documentation

Complete guide to using DocuMind AI

Getting Started
Learn how to get started with DocuMind AI
Uploading Documents
How to upload and manage your documents
Asking Questions
How to ask questions and get answers
Dashboard & Features
Overview of dashboard and key features
Account Management
Manage your account and settings
API Reference
Integrate DocuMind AI into your applications
Introduction

DocuMind AI is an intelligent document assistant that allows you to upload PDF documents and ask questions about them using advanced AI technology. Our system uses Retrieval-Augmented Generation (RAG) to provide accurate, context-aware answers based on your document content.

Key Features:

  • Upload and process PDF documents
  • Ask natural language questions about your documents
  • Get instant AI-powered answers with source citations
  • Multi-user support with complete data isolation
  • Document management and Q&A history tracking
  • RESTful API for integration
Quick Start Guide

Step 1: Create an Account

Visit the signup page and create your account with your email and password.

Step 2: Upload Your First Document

Click the "Upload PDF" button on your dashboard, select a PDF file, and wait for it to be processed. The system will extract text, create embeddings, and make it searchable.

Step 3: Ask Questions

Navigate to the "Ask Questions" page, select your document, and start asking questions. The AI will search through your document and provide accurate answers.

Creating an Account

To get started with DocuMind AI, you need to create an account. This ensures your documents are secure and isolated from other users.

Account Creation Process:

  1. Click "Sign Up" on the login page
  2. Enter your email address and create a password
  3. Verify your email (if required)
  4. You'll be automatically logged in and redirected to the dashboard
First Steps After Signup

Once you've created your account, here's what you should do:

  • Explore the Dashboard: Familiarize yourself with the interface and navigation
  • Upload a Test Document: Start with a simple PDF to understand how the system works
  • Try Asking Questions: Ask various types of questions to see how the AI responds
  • Check Your Account Status: View your usage statistics and account information
Supported Formats

Currently, DocuMind AI supports PDF files (.pdf) only. We're working on adding support for other document formats in future updates.

Important Notes:

  • PDFs must contain extractable text (not just images)
  • Scanned PDFs may require OCR processing first
  • Password-protected PDFs are not supported
  • Maximum file size depends on your plan
Upload Process

Uploading a document is a simple process that happens in several stages:

1

File Selection

Click "Upload PDF" and select your file, or drag and drop it into the upload area.

2

Upload to Storage

The file is uploaded to secure cloud storage (0-60% progress).

3

Text Extraction

Text is extracted from the PDF and split into manageable chunks (60-90% progress).

4

Embedding Generation

AI embeddings are generated for semantic search capabilities.

5

Indexing

Document is indexed in the vector database and ready for queries (90-100% progress).

Document Management

Your dashboard provides comprehensive document management features:

View Documents

See all your uploaded documents with file size, upload date, and title.

Ask Questions

Click the message icon to ask questions about a specific document.

Delete Documents

Remove documents and all associated Q&A history with the delete button.

Upload More

Easily upload additional documents from the dashboard or upload page.

File Size Limits

File size limits depend on your subscription plan:

PlanMax File SizeTotal Storage
Free10 MB100 MB
Basic50 MB5 GB
Pro200 MBUnlimited
Question Format

You can ask questions in natural language. The AI understands various question types:

Factual Questions

"What is the contract duration?" or "What is the salary mentioned?"

Summary Questions

"Summarize the key terms" or "What are the main points?"

Comparison Questions

"What are the differences between section A and B?"

Specific Detail Questions

"What does clause 5.2 say?" or "Who are the parties involved?"

Best Practices for Asking Questions

Be Specific

Specific questions yield better results than vague ones.

Use Context

Reference specific sections, dates, or terms when possible.

Ask One Question at a Time

Multiple questions in one query may reduce answer quality.

Refine Your Questions

If the answer isn't satisfactory, try rephrasing or being more specific.

Understanding Answers

Answers are generated using Retrieval-Augmented Generation (RAG), which means:

  • Answers are based on content from your uploaded documents
  • The AI searches for relevant passages before generating an answer
  • Answers include source citations when available
  • If information isn't in your documents, the AI will indicate that

Answer Format

Answers preserve line breaks and formatting, making them easy to read. Multi-paragraph answers are displayed with proper spacing.

Chat Interface

The chat interface provides a conversational experience:

Question Display

Your questions appear immediately when submitted, shown in blue bubbles on the right.

Loading State

While processing, you'll see a "Thinking..." indicator with a spinner.

Answer Display

Answers appear in gray bubbles on the left, preserving formatting and line breaks.

Keyboard Shortcuts

Press Enter to send, Shift+Enter for a new line.

Dashboard Overview

Your dashboard is the central hub for managing your documents and viewing your activity:

Top Navigation

Access Pricing, FAQs, Docs, Upload, and your account menu.

Statistics Cards

View total documents, questions asked, and account status at a glance.

Document List

See all your documents with quick actions to ask questions or delete.

Q&A History

Review your recent questions and answers for quick reference.

Statistics

The dashboard displays three key statistics:

  • Total Documents: Number of PDFs you've uploaded
  • Total Questions: Number of questions you've asked across all documents
  • Account Status: Your current subscription status (Active/Inactive)
Document List

The document list shows:

  • Document title (filename without extension)
  • File size in human-readable format
  • Upload date
  • Quick action buttons (Ask Questions, Delete)
Q&A History

Your Q&A history displays:

  • Recent questions you've asked
  • Corresponding answers
  • Document title for each Q&A pair
  • Creation timestamp

Note: Q&A history is tied to specific documents. When you delete a document, its Q&A history is also removed.

Account Status

The Account Status page provides comprehensive information about your account:

User Information

  • Email address
  • Account creation date
  • User ID

Usage Statistics

  • Documents uploaded count
  • Questions asked count
  • Total storage used

Subscription Plan

View your current plan and available features.

Data Security

DocuMind AI takes security seriously:

User Isolation

Each user's documents are completely isolated. You can only access your own documents.

Secure Storage

Documents are stored in secure cloud storage with encryption.

Authentication

All API requests require user authentication via user ID headers.

No Data Sharing

We never share your documents or data with third parties.

API Authentication

All API requests require user authentication. You can provide your user ID in two ways:

// Method 1: Via Header (Recommended)
X-User-ID: your-user-id

// Method 2: Via Request Body/Query
{
  "user_id": "your-user-id"
}

Important: Never expose your user ID in client-side code. Always use server-side API routes or secure authentication mechanisms.

Upload Endpoint

POST /upload

Upload a PDF document for processing and indexing.

Request

Headers:
  X-User-ID: your-user-id (required)
  Content-Type: multipart/form-data

Body (Form Data):
  file: PDF file (required)
  document_id: string (optional)
  title: string (optional)
  file_size: number (optional)
  file_url: string (optional)

Response

{
  "status": "ingested",
  "filename": "document.pdf",
  "user_id": "user-123",
  "document_id": "doc-456"
}

Example

curl -X POST https://api.documind.ai/upload \
  -H "X-User-ID: user-123" \
  -F "file=@document.pdf" \
  -F "document_id=doc-456" \
  -F "title=My Document"
Query Endpoint

POST /query

Ask a question about your documents and get an AI-generated answer.

Request

Headers:
  X-User-ID: your-user-id (required)
  Content-Type: application/json

Body:
{
  "question": "What is the main topic?",
  "user_id": "user-123",
  "document_id": "doc-456" (optional)
}

Response

{
  "answer": "The main topic is...",
  "sources": ["document.pdf"],
  "passages": ["relevant text passage..."]
}

Example

curl -X POST https://api.documind.ai/query \
  -H "Content-Type: application/json" \
  -H "X-User-ID: user-123" \
  -d '{
    "question": "What is the main topic?",
    "document_id": "doc-456"
  }'
Document Management Endpoints

GET /documents

List all documents for a user.

Headers:
  X-User-ID: your-user-id (required)

Response:
{
  "documents": [
    {
      "id": 1,
      "user_id": "user-123",
      "document_id": "doc-456",
      "path": "./data/user-123/document.pdf",
      "filename": "document.pdf",
      "num_chunks": 25,
      "title": "My Document",
      "file_size": 1024000,
      "file_url": "https://..."
    }
  ],
  "count": 1
}

GET /documents/:document_id

Get a specific document by ID.

Headers:
  X-User-ID: your-user-id (required)

Response:
{
  "id": 1,
  "user_id": "user-123",
  "document_id": "doc-456",
  "path": "./data/user-123/document.pdf",
  "filename": "document.pdf",
  "num_chunks": 25,
  "title": "My Document",
  "file_size": 1024000,
  "file_url": "https://..."
}

DELETE /documents/:document_id

Delete a document and its associated vectors.

Headers:
  X-User-ID: your-user-id (required)

Response:
{
  "status": "deleted",
  "document_id": "doc-456",
  "vectors_deleted": 25
}
Complete UI Workflow

1. Login/Signup Flow

  1. Visit the login page
  2. Click "Sign Up" if you don't have an account
  3. Enter email and password
  4. You're automatically redirected to the dashboard

2. Upload Document Flow

  1. Click "Upload PDF" button from dashboard or navigation
  2. Select a PDF file or drag and drop
  3. Watch progress indicator (0-60%: upload, 60-90%: processing, 90-100%: indexing)
  4. Success message appears and you're redirected to dashboard
  5. Document appears in your document list

3. Ask Questions Flow

  1. Click "Ask Questions" from dashboard or click message icon on a document
  2. Select the document you want to query (if multiple documents)
  3. Type your question in the text area
  4. Press Enter or click Send
  5. Question appears immediately in chat
  6. "Thinking..." indicator shows while processing
  7. Answer appears below the question when ready
  8. Continue asking more questions in the same conversation

4. Document Management Flow

  1. View all documents on dashboard
  2. Click message icon to ask questions about a specific document
  3. Click delete icon to remove a document (with confirmation)
  4. Deleted documents and their Q&A history are permanently removed

5. Account Management Flow

  1. Click your avatar in the top right
  2. View account menu with email
  3. Click "Account Status" card or navigate to account status page
  4. View usage statistics, user information, and subscription plan
  5. Logout from account menu or account status page

Ready to get started?

Start using DocuMind AI today and experience intelligent document processing.

DocuMind AI - Your Intelligent Document Assistant