Edithly API: Add AI Document Intelligence to Your App in Minutes

Direct answer: Edithly exposes a REST API that lets any application upload documents, generate visuals (MCQs, mind maps, presentations, flashcards), and chat with documents — all programmatically, at scale.

What Edithly's API Enables

If you're building a product that needs to work with documents, Edithly's API eliminates the need to build document AI infrastructure from scratch. Instead of training models, building extraction pipelines, and developing visual generation systems, you make API calls.

The Edithly API covers:

• Document ingestion — upload PDFs, Word files, URLs, YouTube links
• Visual generation — MCQs, mind maps, flashcards, presentations, study aids, infographics
• Document chat — ask questions against uploaded documents via API
• Repository management — create, manage, and query document collections
• Artifact retrieval — retrieve generated visuals and export them

Core API Endpoints

Document Upload

POST /api/v1/documents
Content-Type: multipart/form-data
Authorization: Bearer {api_key}

file: [document.pdf]

Returns a document_id for subsequent operations.

Generate Visual

POST /api/v1/visuals/generate
Authorization: Bearer {api_key}

{
  "document_id": "doc_abc123",
  "type": "mcq",
  "options": {
    "count": 20,
    "difficulty": "medium"
  }
}

Returns a job_id. Poll for completion or receive webhook notification.

Chat with Document

POST /api/v1/chat
Authorization: Bearer {api_key}

{
  "document_id": "doc_abc123",
  "message": "What are the key findings of this report?",
  "conversation_id": "conv_xyz789"
}

Returns the AI answer with source citations.

What Developers Build with Edithly API

EdTech Platforms (India, Australia, USA)

EdTech companies use Edithly's API to add AI-powered content generation to their platforms. Upload a curriculum document → automatically generate a quiz bank, a set of revision flashcards, and a study guide — served directly in the student's learning interface.

Indian EdTech platforms serving NEET, JEE, and UPSC aspirants use Edithly's API to generate question banks from proprietary content at scale. Australian LMS providers integrate Edithly for automatic formative assessment generation. US course platforms add AI-generated practice sets to uploaded course materials.

HR and L&D Platforms

Training content providers use Edithly's API to automatically generate assessments from training materials. Upload a compliance module → generate a 20-question assessment. No manual question writing required.

Legal Tech

Legal platforms use Edithly's API to provide contract Q&A interfaces. Upload a contract → users ask questions → Edithly returns cited answers. Reduces review time without replacing legal expertise.

Internal Tooling

Engineering teams build internal AI assistants using Edithly's API. Technical documentation, runbooks, and process guides become queryable via a Slack bot or internal web tool — powered by Edithly's document intelligence.

Authentication and Security

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.edithly.com/v1/documents

All API calls use Bearer token authentication over HTTPS. API keys are scoped and can be restricted to specific operations or document collections.

Webhook Support

For long-running operations (visual generation, large document ingestion), Edithly sends webhook notifications when jobs complete:

{
  "event": "visual.generated",
  "job_id": "job_abc123",
  "visual_type": "mind_map",
  "document_id": "doc_xyz789",
  "result_url": "https://api.edithly.com/v1/visuals/vis_123",
  "timestamp": "2025-11-21T10:30:00Z"
}

No polling required for production integrations.

Python Example: Generate MCQs from a PDF

import edithly

client = edithly.Client(api_key="your-api-key")

# Upload document
doc = client.documents.upload("chapter_5.pdf")

# Generate MCQs
job = client.visuals.generate(
    document_id=doc.id,
    visual_type="mcq",
    options={"count": 25}
)

# Wait for completion
result = job.wait()
print(result.questions)

API Plans and Pricing

Get Your API Key

Access the Edithly API portal from your account dashboard. Generate an API key, review the documentation, and make your first call in under 5 minutes.