Getting Started with CODITECT DMS

Welcome to CODITECT Document Management System! This guide will help you get started with AI-powered semantic search in 10 minutes.

---

Quick Start

Step 1: Create Your Account

1. Go to dms.coditect.ai
2. Click Sign Up and enter your email
3. Choose your organization name
4. Select your subscription tier:
   • Free: 100 documents, 50 searches/day
   • Pro: 10,000 documents, 500 searches/day, GraphRAG
   • Enterprise: Unlimited documents, priority support

Step 2: Get Your API Key

1. Navigate to Settings > API Keys
2. Click Create API Key
3. Name your key (e.g., "Development")
4. Select scopes: read, search, write
5. Copy and save your key securely

# Set your API key as an environment variable
export CODITECT_API_KEY="dms_prod_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Step 3: Upload Your First Document

Using the Dashboard:

1. Go to Documents > Upload
2. Drag and drop files or click to browse
3. Wait for processing (usually 5-30 seconds)

Using the API:

curl -X POST https://dms-api.coditect.ai/api/v1/documents/upload \
  -H "X-API-Key: $CODITECT_API_KEY" \
  -F "file=@my-document.md"

Using Python:

import requests

response = requests.post(
    "https://dms-api.coditect.ai/api/v1/documents/upload",
    headers={"X-API-Key": os.environ["CODITECT_API_KEY"]},
    files={"file": open("my-document.md", "rb")}
)
print(response.json())

Step 4: Search Your Documents

Using the Dashboard:

1. Go to Search
2. Enter your query in natural language
3. View results with highlighted matches

Using the API:

curl -X POST https://dms-api.coditect.ai/api/v1/search \
  -H "X-API-Key: $CODITECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "How do I implement authentication?",
    "mode": "hybrid",
    "top_k": 10
  }'

Using Python:

import requests

response = requests.post(
    "https://dms-api.coditect.ai/api/v1/search",
    headers={
        "X-API-Key": os.environ["CODITECT_API_KEY"],
        "Content-Type": "application/json"
    },
    json={
        "query": "How do I implement authentication?",
        "mode": "hybrid",
        "top_k": 10
    }
)

results = response.json()
for result in results["results"]:
    print(f"Score: {result['score']:.2f} - {result['document_title']}")
    print(f"  {result['content'][:200]}...")

---

Search Modes Explained

Hybrid Search (Recommended)

Combines semantic and keyword search for best results:

{
  "query": "authentication with JWT tokens",
  "mode": "hybrid"
}

Best for: General search, finding relevant content

Vector Search

Pure semantic similarity using AI embeddings:

{
  "query": "How do I secure my API endpoints?",
  "mode": "vector"
}

Best for: Conceptual queries, finding similar content

Keyword Search

Traditional full-text search:

{
  "query": "jwt token expiration",
  "mode": "keyword"
}

Best for: Exact phrase matching, specific terms

GraphRAG Search

Explore relationships between document chunks:

{
  "seed_chunk_id": "550e8400-e29b-41d4-a716-446655440001",
  "max_depth": 2,
  "relationship_types": ["sequential", "semantic"]
}

Best for: Understanding context, exploring related content

---

Supported File Formats

Format	Extension	Max Size
Markdown	.md	50 MB
Plain Text	.txt	50 MB
PDF	.pdf	50 MB
Word	.docx	50 MB

Processing Time:

• Small documents (<100KB): 5-10 seconds
• Medium documents (100KB-1MB): 10-30 seconds
• Large documents (>1MB): 30-120 seconds

---

Document Processing Pipeline

When you upload a document, it goes through:

1. Parsing: Extract text and structure
2. Chunking: Split into semantic segments
3. Embedding: Generate AI vector embeddings
4. Indexing: Add to search index
5. Relationship Building: Identify connections

Check processing status:

curl https://dms-api.coditect.ai/api/v1/documents/{doc_id}/status \
  -H "X-API-Key: $CODITECT_API_KEY"

---

Organizing Your Documents

Document Types

Categorize documents for better organization:

Type	Use Case
reference	Technical specifications, API docs
guide	Tutorials, how-to guides
adr	Architecture Decision Records
workflow	Process documentation
agent	AI agent configurations
command	CLI command documentation

Tags and Keywords

Add metadata when uploading:

{
  "filename": "security-best-practices.md",
  "content": "...",
  "document_type": "guide",
  "keywords": ["security", "best-practices", "authentication"],
  "tags": ["v2", "reviewed"]
}

---

Team Collaboration

Invite Team Members

1. Go to Settings > Team
2. Click Invite Member
3. Enter email and select role:
   • Owner: Full access, billing
   • Admin: Manage users and settings
   • Editor: Upload/edit documents
   • Viewer: Search only
   • API Only: API access only

API Keys for Applications

Create scoped API keys for different applications:

{
  "name": "Production App",
  "scopes": ["read", "search"],
  "expires_in_days": 365
}

Scopes:

• read: Read documents and chunks
• search: Execute searches
• write: Upload and edit documents
• delete: Delete documents
• admin: Manage users and settings

---

Dashboard & Analytics

Monitor Your Usage

View key metrics on the dashboard:

• Documents: Total count, by type/status
• Searches: Volume, latency percentiles
• Processing: Job status, queue length
• Costs: Embedding costs, API usage

Export Reports

Download usage reports:

1. Go to Analytics
2. Select date range
3. Click Export CSV

---

Best Practices

Document Preparation

1. Use Markdown: Best support for structure
2. Add Headings: Improves chunking quality
3. Include Metadata: YAML frontmatter is preserved
4. Keep Focused: One topic per document

Search Optimization

1. Use Natural Language: "How do I..." works better than keywords
2. Try Hybrid Mode: Best balance of precision and recall
3. Expand Context: Enable for longer passages
4. Adjust min_score: Lower for broader results

API Integration

1. Cache Results: Reduce API calls
2. Batch Uploads: Use bulk endpoints for efficiency
3. Handle Errors: Implement retry logic
4. Monitor Quotas: Check usage endpoint regularly

---

Troubleshooting

Document Not Processing

Symptoms: Status stuck at "pending"

Solutions:

1. Check file format is supported
2. Verify file is not corrupted
3. Check document size limits
4. Contact support if persistent

Search Returns No Results

Symptoms: Empty results for expected queries

Solutions:

1. Verify documents are fully processed
2. Lower min_score threshold
3. Try different search modes
4. Check query for typos

API Authentication Errors

Symptoms: 401 Unauthorized responses

Solutions:

1. Verify API key is valid
2. Check key has required scopes
3. Ensure key hasn't expired
4. Regenerate key if needed

---

Next Steps

Learn More

• API Reference - Complete endpoint documentation
• SDK Guide - Language-specific SDKs
• Deployment Guide - Self-hosted deployment

Get Help

• Documentation: https://docs.coditect.ai
• Email Support: support@az1.ai
• Status Page: https://status.coditect.ai
• GitHub Issues: https://github.com/coditect-ai/coditect-rollout-master/issues

Upgrade Your Plan

Ready for more? Upgrade to unlock:

• Pro: 10x more documents, GraphRAG, priority processing
• Enterprise: Unlimited, SSO, dedicated support, SLA

Contact sales@az1.ai for enterprise pricing.

---

Quick Reference

Common API Endpoints

Endpoint	Method	Description
/search	POST	Execute search
/documents	GET	List documents
/documents	POST	Create document
/documents/upload	POST	Upload file
/documents/{id}	GET	Get document
/analytics/dashboard	GET	Get metrics
/tenants/me	GET	Get tenant info

Environment Variables

# Required
export CODITECT_API_KEY="dms_prod_sk_..."

# Optional
export CODITECT_API_URL="https://dms-api.coditect.ai/api/v1"
export CODITECT_TIMEOUT="30"

---

Welcome to CODITECT DMS! We're excited to have you on board.