API Documentation — ShortMe.lk

🔐 Authentication

Bearer Token Authentication

All authenticated endpoints require a Sanctum Personal Access Token in the Authorization header.

Authorization: Bearer YOUR_API_TOKEN

Getting a token:

POST /api/auth/register
{
    "name": "John Doe",
    "email": "john@example.com",
    "password": "secret123",
    "password_confirmation": "secret123"
}

// Response:
{
    "success": true,
    "data": {
        "user": { "id": 1, "name": "John Doe", "email": "john@example.com" },
        "token": "1|abc123..."
    }
}

Content-Type: All requests must send Content-Type: application/json (or multipart/form-data for file uploads).

📦 Response Format

All endpoints return JSON with a consistent structure:

// Success
{
    "success": true,
    "data": { ... },
    "message": "Optional success message"
}

// Error
{
    "success": false,
    "error": "Error description",
    "message": "Detailed error (validation)"
}

HTTP Status Codes:

200	Success
201	Created (register, generate)
422	Validation error
401	Unauthenticated
403	Forbidden
404	Not found
429	Rate limited / plan limit reached
500	Server error

👤 Authentication

POST /api/auth/register Create a new account Public ▶

Parameter	Type	Required	Description
name	string	required	Full name
email	string	required	Valid email address
password	string	required	Min 8 chars, mixed case + numbers
password_confirmation	string	required	Must match password

Response (201)

{
    "success": true,
    "data": {
        "user": { "id": 1, "name": "John", "email": "john@example.com", "email_verified_at": null },
        "token": "1|abc123..."
    },
    "message": "Registration successful. Please verify your email."
}

POST /api/auth/login Sign in and get token Public ▶

Parameter	Type	Required	Description
email	string	required	Registered email
password	string	required	Account password

Response (200)

{
    "success": true,
    "data": {
        "user": { "id": 1, "name": "John", "email": "john@example.com" },
        "token": "2|xyz789..."
    }
}

POST /api/auth/logout Revoke current token Auth ▶

No parameters needed. Revokes the token used in the Authorization header.

GET /api/auth/me Get current user profile Auth ▶

Response (200)

{
    "success": true,
    "data": {
        "user": {
            "id": 1, "name": "John", "email": "john@example.com",
            "is_admin": false, "email_verified_at": "2026-09-01T...",
            "subscription": { "plan": "pro", "status": "active", "expires_at": "2026-10-01T..." }
        }
    }
}

POST /api/auth/forgot-password Send password reset link Public ▶

Parameter	Type	Required	Description
email	string	required	Registered email address

POST /api/auth/reset-password Reset password with token Public ▶

Parameter	Type	Required	Description
token	string	required	Reset token from email
email	string	required	Email address
password	string	required	New password
password_confirmation	string	required	Must match password

💳 Subscription & Plans

GET /api/subscription Current subscription details Auth ▶

Response (200)

{
    "success": true,
    "data": {
        "subscription": { "id": 1, "plan": "pro", "status": "active", "expires_at": "..." },
        "usage": { "daily_used": 3, "daily_limit": null, "plan_name": "Pro" }
    }
}

GET /api/plans List available plans Auth ▶

Response (200)

{
    "success": true,
    "data": {
        "plans": [
            { "name": "free", "price": 0, "features": [...] },
            { "name": "pro", "price": 990, "features": [...] },
            { "name": "ultra", "price": 2990, "features": [...] }
        ]
    }
}

POST /api/subscription/upgrade Upgrade to a paid plan Auth ▶

Parameter	Type	Required	Description
plan_name	string	required	`pro` or `ultra`

POST /api/subscription/cancel Cancel current subscription Auth ▶

No parameters. Cancels the active subscription.

📄 Documents & Short Notes

GET /api/documents List user's documents Auth ▶

Parameter	Type	Required	Description
type	string	optional	Filter: `notes` or `paper`
page	integer	optional	Page number (default: 1)

POST /api/documents/short-notes/file Generate notes from PDF/file Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
source_pdf	file	required	PDF, DOC, DOCX, PPT, PPTX (max 50MB)
title	string	optional	Document title (max 255)
language	string	optional	Output language (default: sinhala)
note_style	string	optional	`bullets`, `paragraph`, `flashcards`, `flashcard_deck`, `high_level`
note_length	string	optional	`brief` or `detailed` (default: detailed)
tone	string	optional	`formal`, `casual`, `academic`, `technical`, `friendly`
focus_area	string	optional	Specific topics to focus on (max 1000)
custom_instructions	string	optional	Additional instructions (max 1000)

Response (201)

{
    "success": true,
    "data": {
        "paper": { "id": 42, "status": "generating", "type": "notes", "title": "My Notes" },
        "message": "Generation started. Poll /api/documents/{id} for status."
    }
}

POST /api/documents/short-notes/text Generate notes from pasted text Auth ▶

Parameter	Type	Required	Description
source_text	string	required	Raw text content (max 50,000 chars)
title	string	optional	Document title
language	string	optional	Output language
note_style	string	optional	`bullets`, `paragraph`, `flashcards`, `flashcard_deck`, `high_level`
note_length	string	optional	`brief` or `detailed`
tone	string	optional	`formal`, `casual`, `academic`, `technical`, `friendly`
focus_area	string	optional	Focus topics
custom_instructions	string	optional	Extra instructions

POST /api/documents/short-notes/audio Generate notes from audio/video Auth ▶

Parameter	Type	Required	Description
source_audio	file	*	Audio/video file (MP3, WAV, MP4, etc.)
source_url	string	*	YouTube or audio URL (Pro feature)
source_lang	string	optional	Audio language (default: auto-detect)
title	string	optional	Document title
language	string	optional	Output language
note_style	string	optional	Note style
note_length	string	optional	`brief` or `detailed`
tone	string	optional	Tone

* Provide either source_audio (file) or source_url (URL), not both.

POST /api/documents/short-notes/url Generate notes from a URL Auth ▶

Parameter	Type	Required	Description
source_url	string	required	URL to extract content from
title	string	optional	Document title
language	string	optional	Output language
note_style	string	optional	Note style
note_length	string	optional	`brief` or `detailed`
tone	string	optional	Tone

GET /api/documents/{paper} Get document details + content Auth ▶

Response (200)

{
    "success": true,
    "data": {
        "paper": {
            "id": 42, "title": "My Notes", "type": "notes", "status": "completed",
            "language": "sinhala", "created_at": "...",
            "generated_content": { "markdown": "...", "chunks": [...], "diagrams": [...] }
        }
    }
}

GET /api/documents/{paper}/download/{format} Download document Auth ▶

Parameter	Type	Required	Description
format	string	required	`pdf`, `word`, `txt`, or `bilingual-pdf`

DELETE /api/documents/{paper} Delete a document Auth ▶

Permanently deletes the document and its files.

POST /api/documents/{paper}/retry Retry failed generation Auth ▶

Retries generation for a document with status failed.

📋 Question Papers

POST /api/question-papers/file Generate from PDF/file Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
source_pdf	file	required	Source file (PDF, DOC, DOCX, PPT, PPTX)
title	string	required	Paper title (max 255)
question_type	string	required	`mcq`, `essay`, `short`, `mixed`
question_count	integer	required	Number of questions (1-50)
options_count	integer	optional	MCQ options per question (2-10, default: 4)
subject	string	optional	Subject name
grade_level	string	optional	Grade level
language	string	optional	Output language
focus_area	string	optional	Topics to focus on
custom_instructions	string	optional	Extra instructions
description	string	optional	Paper description

POST /api/question-papers/text Generate from pasted text Auth ▶

Parameter	Type	Required	Description
source_text	string	required	Source text (max 50,000 chars)
title	string	optional	Paper title
question_type	string	required	`mcq`, `essay`, `short`, `mixed`
question_count	integer	required	1-50
options_count	integer	optional	2-10 (default: 4)
subject	string	optional	Subject
grade_level	string	optional	Grade level
language	string	optional	Output language
focus_area	string	optional	Focus topics
custom_instructions	string	optional	Extra instructions

POST /api/question-papers/audio Generate from audio/video Auth ▶

Parameter	Type	Required	Description
source_audio	file	*	Audio/video file
source_url	string	*	YouTube/audio URL
source_lang	string	optional	Audio language
title	string	optional	Paper title
question_type	string	required	`mcq`, `essay`, `short`, `mixed`
question_count	integer	required	1-50
options_count	integer	optional	2-10
subject	string	optional	Subject
grade_level	string	optional	Grade level
language	string	optional	Output language

POST /api/question-papers/url Generate from a URL Auth ▶

Parameter	Type	Required	Description
source_url	string	required	URL to extract content from
title	string	optional	Paper title
question_type	string	required	`mcq`, `essay`, `short`, `mixed`
question_count	integer	required	1-50
options_count	integer	optional	2-10
subject	string	optional	Subject
grade_level	string	optional	Grade level
language	string	optional	Output language

🃏 Flashcards

GET /api/documents/{paper}/flashcards Get flashcard deck Auth ▶

Returns flashcard data for a document generated with note_style: flashcard_deck.

POST /api/documents/{paper}/flashcards/rate Rate a flashcard Auth ▶

Parameter	Type	Required	Description
card_index	integer	required	Index of the card (0-based)
rating	string	required	`easy`, `medium`, `hard`

GET /api/flashcards/{token} View shared flashcards Public ▶

Public endpoint — no auth required. Access shared flashcard deck by token.

🌐 Translations

POST /api/translations/file Translate from file Auth ▶

Parameter	Type	Required	Description
source_pdf	file	required	File to translate
target_language	string	required	Target language
source_language	string	optional	Source language (auto-detect if omitted)

POST /api/translations/text Translate from text Auth ▶

Parameter	Type	Required	Description
source_text	string	required	Text to translate (max 50,000)
target_language	string	required	Target language
source_language	string	optional	Source language

POST /api/translations/audio Translate from audio Auth ▶

Parameter	Type	Required	Description
source_audio	file	*	Audio file
source_url	string	*	Audio URL
target_language	string	required	Target language
source_language	string	optional	Source language

POST /api/translations/url Translate from URL Auth ▶

Parameter	Type	Required	Description
source_url	string	required	URL to translate
target_language	string	required	Target language
source_language	string	optional	Source language

🎯 Quizzes

GET /api/quizzes List user's quizzes Auth ▶

Parameter	Type	Required	Description
page	integer	optional	Page number

POST /api/quizzes Create a quiz manually Auth ▶

Parameter	Type	Required	Description
title	string	required	Quiz title
description	string	optional	Quiz description
questions	array	required	Array of question objects
questions[].question_text	string	required	Question text
questions[].question_type	string	required	`mcq`, `short`, `essay`
questions[].options	array	optional	MCQ options array
questions[].correct_answer	string	required	Correct answer
questions[].explanation	string	optional	Answer explanation

POST /api/quizzes/ai-generate AI-generate quiz questions Auth ▶

Parameter	Type	Required	Description
topic	string	*	Topic description
source_pdf	file	*	Source PDF (alternative to topic)
count	integer	optional	Number of questions (default: 5)
options_count	integer	optional	Options per MCQ (2-10, default: 4)
language	string	optional	`english`, `sinhala`, `tamil`

GET /api/quizzes/{quiz} Get quiz details Auth ▶

Returns quiz with all questions, share token, and settings.

PUT /api/quizzes/{quiz} Update quiz Auth ▶

Parameter	Type	Required	Description
title	string	optional	Quiz title
description	string	optional	Description
pin	string	optional	PIN protection

DELETE /api/quizzes/{quiz} Delete quiz Auth ▶

Permanently deletes the quiz and all attempts.

POST /api/quizzes/{quiz}/publish Publish quiz (generate share link) Auth ▶

Response (200)

{
    "success": true,
    "data": {
        "share_url": "https://shortme.lk/quiz/abc123...",
        "short_url": "https://shortme.lk/q/xyz"
    }
}

POST /api/quizzes/{quiz}/start Start quiz session Auth ▶

Starts the quiz for participants. Sets status to live.

POST /api/quizzes/{quiz}/close Close quiz Auth ▶

Closes the quiz — no more submissions accepted.

GET /api/quizzes/{quiz}/participants List participants Auth ▶

Returns all participants with scores and answers.

GET /api/quizzes/{quiz}/report Get quiz analytics report Auth ▶

Returns per-question analytics, scores, and performance breakdown.

GET /api/quizzes/{quiz}/export Export results as CSV Auth ▶

Returns CSV file download with all participant results.

POST /api/quizzes/{quiz}/shortlink Generate short link Auth ▶

Generates a short URL like /q/xyz for easy sharing.

POST /api/quizzes/{quiz}/duplicate Duplicate quiz Auth ▶

Creates a copy of the quiz with all questions.

GET /api/quiz/{shareToken} Get quiz for taking (public) Public ▶

Returns quiz questions for participants. No auth required.

POST /api/quiz/{shareToken}/submit Submit quiz answers (public) Public ▶

Parameter	Type	Required	Description
answers	object	required	Map of question_id => answer
name	string	optional	Participant name

POST /api/quiz/{shareToken}/verify-pin Verify quiz PIN (public) Public ▶

Parameter	Type	Required	Description
pin	string	required	PIN code

GET /api/quiz/{shareToken}/results/{attempt} Get quiz results (public) Public ▶

Returns results for a specific attempt including score, correct answers, and explanations.

📚 AI Books

GET /api/books List user's books Auth ▶

POST /api/books Generate a new book Auth ▶

Parameter	Type	Required	Description
title	string	required	Book title (max 500)
description	string	required	Book description/topic (max 2000)
author	string	optional	Author name
language	string	required	Language code (english, sinhala, tamil, etc.)
page_count	integer	required	Number of pages (5 to plan max)
book_style	string	required	`textbook`, `narrative`, `reference`, `children`, `friendly`, `high_level`
proofread	string	optional	`on` to enable (Ultra only)
scope_limit	string	optional	`on` to limit to references (Ultra only)
insert_images	string	optional	`on` to add AI images (Ultra only)
image_count	integer	optional	Number of images (1-20)
references	file[]	optional	Reference PDFs/DOCX (max 5, Ultra only)
special_instructions	string	optional	Extra instructions (max 2000)

GET /api/books/{book} Get book details Auth ▶

GET /api/books/{book}/progress Get generation progress Auth ▶

POST /api/books/{book}/cancel Cancel generation Auth ▶

POST /api/books/{book}/retry Retry failed generation Auth ▶

GET /api/books/{book}/download/{format} Download book Auth ▶

Parameter	Type	Required	Description
format	string	required	`pdf` or `docx`

DELETE /api/books/{book} Delete book Auth ▶

🎨 Presentations

GET /api/presentations List presentations Auth ▶

POST /api/presentations Generate presentation Auth ▶

Parameter	Type	Required	Description
title	string	required	Presentation title (max 500)
description	string	optional	Description (max 2000)
language	string	required	`english`, `sinhala`, `tamil`
slide_count	integer	required	Number of slides (4 to plan max)
source_pdf	file	optional	Source file
source_text	string	optional	Source text (max 50,000)
source_url	string	optional	Source URL

GET /api/presentations/{presentation} Get presentation details Auth ▶

GET /api/presentations/{presentation}/download Download PPTX Auth ▶

DELETE /api/presentations/{presentation} Delete presentation Auth ▶

🧑‍🏫 AI Coaches & Tutoring

GET /api/ai-coaches List coaches & templates Auth ▶

POST /api/ai-coaches Create custom tutor Auth ▶

Parameter	Type	Required	Description
name	string	required	Tutor name
subject	string	required	Subject area
description	string	optional	Tutor description
system_prompt	string	optional	Custom system prompt
grade_level	string	optional	Grade level
language	string	optional	Language

POST /api/ai-coaches/{coach}/clone Clone a template tutor Auth ▶

Creates a personal copy of a template coach.

POST /api/ai-coaches/{coach}/sessions Start new chat session Auth ▶

Parameter	Type	Required	Description
title	string	optional	Session title

POST /api/ai-coaches/sessions/{session}/message Send message to tutor Auth ▶

Parameter	Type	Required	Description
message	string	required	Your message (max 5000)

Response (200)

{
    "success": true,
    "data": {
        "response": "AI tutor response text...",
        "session": { "total_questions": 5, "correct_answers": 3, "accuracy": 60 }
    }
}

POST /api/ai-coaches/sessions/{session}/assessment Generate practice assessment Auth ▶

AI generates assessment questions based on the tutoring session context.

POST /api/ai-coaches/sessions/{session}/submit-answer Submit assessment answers Auth ▶

Parameter	Type	Required	Description
answers	array	required	Array of answer strings

POST /api/ai-coaches/{coach}/references Upload reference material Auth ▶

Parameter	Type	Required	Description
file	file	required	PDF, DOCX, or PPTX (max 200MB)

🔮 Exam Predictor

GET /api/exam-predictions List predictions Auth ▶

POST /api/exam-predictions Generate exam prediction Auth ▶

Parameter	Type	Required	Description
title	string	required	Prediction title (max 500)
subject	string	optional	Subject
grade_level	string	optional	Grade level
language	string	required	`english`, `sinhala`, `tamil`
source_text	string	*	Paste study text
source_file	file	*	Upload PDF/DOCX/PPTX
source_files	file[]	*	Upload multiple files
mode	string	required	`prediction` or `question_generator`
difficulty_level	string	optional	`easy`, `medium`, `hard` (question_generator mode)
question_type	string	optional	`mcq`, `essay`, `short`, `mixed`
question_count	integer	optional	1-50
options_count	integer	optional	2-10

* Provide at least one of: source_text, source_file, or source_files.

GET /api/exam-predictions/{prediction} Get prediction details Auth ▶

GET /api/exam-predictions/{prediction}/download/{format} Download prediction Auth ▶

Parameter	Type	Required	Description
format	string	required	`pdf`, `markdown`, or `questions`

GET /api/exam-predictor/shared/{shareToken} View shared prediction Public ▶

Public endpoint — view a shared exam prediction by token.

📊 Pass Predictor

POST /api/pass-predictions/paper/{paper} Predict from paper answers Auth ▶

Parameter	Type	Required	Description
answers	array	required	Array of student answers (one per question)

Response (200)

{
    "success": true,
    "data": {
        "prediction": {
            "id": 1, "title": "...", "grade": "B+",
            "pass_probability": 78, "verdict": "Likely Pass",
            "strengths": [...], "weaknesses": [...],
            "recommendation": "...", "marks_awarded": 65, "total_marks": 100
        }
    }
}

POST /api/pass-predictions/coach/{session} Predict from coaching session Auth ▶

Analyzes coaching session performance to predict exam outcome.

GET /api/pass-predictions List predictions Auth ▶

✍️ AI Text Humanizer

POST /api/humanize/text Humanize pasted text Auth ▶

Parameter	Type	Required	Description
text	string	required	AI text to humanize (min 20, max 50,000 chars)
language	string	required	`english`, `sinhala`, `tamil`
tone	string	required	`natural`, `professional`, `casual`, `academic`

Response (200)

{
    "success": true,
    "data": {
        "humanized_text": "The rewritten natural-sounding text...",
        "original_length": 1250,
        "humanized_length": 1180
    }
}

POST /api/humanize/file Humanize text from file Auth ▶

Parameter	Type	Required	Description
file	file	required	TXT, PDF, or DOCX (max 10MB)
language	string	required	`english`, `sinhala`, `tamil`
tone	string	required	`natural`, `professional`, `casual`, `academic`

🎙️ Audio to Text Transcription

POST /api/audio-to-text Upload audio/video for transcription Auth ▶

Parameter	Type	Required	Description
audio	file	*	Audio/video file (MP3, WAV, M4A, MP4, etc.)
source_url	string	*	YouTube or audio URL
language	string	optional	Audio language code

Response (201)

{
    "success": true,
    "data": {
        "job": { "id": "01J...", "status": "pending" },
        "message": "Transcription started. Poll /api/audio-to-text/{id} for status."
    }
}

GET /api/audio-to-text List transcription history Auth ▶

GET /api/audio-to-text/{audioJob} Get transcription status Auth ▶

POST /api/audio-to-text/{audioJob}/optimize AI-optimize transcript Auth ▶

Uses AI to improve transcript accuracy and formatting.

POST /api/audio-to-text/{audioJob}/generate-notes Generate notes from transcript Auth ▶

Creates short notes from the transcribed text.

POST /api/audio-to-text/{audioJob}/generate-paper Generate question paper from transcript Auth ▶

Creates a question paper from the transcribed content.

GET /api/audio-to-text/{audioJob}/download/{format} Download transcript Auth ▶

Parameter	Type	Required	Description
format	string	required	`pdf`, `docx`, or `txt`

GET /api/shared/transcript/{shareToken} View shared transcript Public ▶

🔍 Smart Search (AI-Powered)

POST /api/smart-search Generate optimized search query Auth ▶

Parameter	Type	Required	Description
query	string	required	What you're looking for (min 3, max 500)
language	string	optional	`en`, `si`, `ta` (default: en)

Response (200)

{
    "success": true,
    "data": {
        "search": {
            "id": 1, "query": "A/L Physics past papers",
            "dork_query": "site:edu.lk \"A/L\" \"Physics\" filetype:pdf past papers",
            "explanation": "Optimized for Sri Lankan educational sites...",
            "suggested": ["try adding year range", "search for mark schemes"],
            "tags": ["physics", "A/L", "past papers"],
            "ai_summary": "Found 15 relevant resources..."
        }
    }
}

GET /api/smart-search/{search} Get search results Auth ▶

GET /api/scholar/{shareToken} View shared search Public ▶

📸 Snap & Solve

POST /api/snap/answer Upload image, get AI answer Auth ▶

Parameter	Type	Required	Description
image	file	required	Image file (max 10MB)
language	string	optional	Response language (default: english)

Response (200)

{
    "success": true,
    "data": {
        "answer": "The solution to the problem is...",
        "explanation": "Step by step...",
        "share_token": "abc123..."
    }
}

GET /api/snap/{snap} Get snap question details Auth ▶

🛠️ AI Mini Tools

All mini tools return complete JSON responses (non-streaming). Each generates AI content and returns it in a single response.

POST /api/mini-tools/song Song Writer Auth ▶

Parameter	Type	Required	Description
topic	string	required	Song description (max 500)
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/essay Essay Writer Auth ▶

Parameter	Type	Required	Description
topic	string	required	Essay topic (max 500)
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/story Story Generator Auth ▶

Parameter	Type	Required	Description
topic	string	required	Story topic (max 500)
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/whatsapp-status WhatsApp Status Auth ▶

Parameter	Type	Required	Description
topic	string	required	Status topic (max 500)
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/math-solver Math Solver Auth ▶

Parameter	Type	Required	Description
problem	string	optional*	Math problem text (max 2000)
image	string	optional*	Base64 image of problem
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/horoscope Horoscope Auth ▶

Parameter	Type	Required	Description
name	string	required	Person name (max 100)
zodiac	string	required	Zodiac sign (Aries..Pisces)
language	string	optional	english, sinhala, tamil
details	string	optional	Personal details (max 500)
dob	date	optional	Date of birth
tob	string	optional	Time of birth (HH:MM)
pob	string	optional	Place of birth (max 100)
gender	string	optional	male, female, other

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/study-planner Study Planner Auth ▶

Parameter	Type	Required	Description
subjects	string	required	Subjects/topics (max 500)
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/speech Speech Writer Auth ▶

Parameter	Type	Required	Description
occasion	string	required	Speech occasion (max 500)
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/quotes Quote Generator Auth ▶

Parameter	Type	Required	Description
topic	string	required	Quote topic (max 500)
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/name-generator Name Generator Auth ▶

Parameter	Type	Required	Description
purpose	string	required	Naming purpose (max 500)
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

POST /api/mini-tools/recipe Recipe Generator Auth ▶

Parameter	Type	Required	Description
ingredients	string	required	Available ingredients (max 500)
language	string	optional	english, sinhala, tamil

Response (200)

{
    "success": true,
    "data": {
        "content": "Generated content in Markdown...",
        "proofread": "Review and improved version..."
    }
}

📑 PDF Tools

All PDF tools accept file uploads via multipart/form-data and return JSON with download URLs.

POST /api/pdf-tools/compress Compress PDF Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file (max 50MB)

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/merge Merge PDFs Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
files	file[]	required	2-10 PDF files

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/split Split PDF Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file
pages	string	required	Pages like "1-3,5,7-10"

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/rotate Rotate Pages Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file
rotation	integer	required	90, 180, or 270

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/extract-pages Extract Pages Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file
pages	string	required	Pages to extract

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/extract-text Extract Text Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/to-images PDF to Images Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file
dpi	integer	optional	72-300 (default: 150)

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/protect Protect PDF Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file
password	string	required	Password (min 4 chars)

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/unlock Unlock PDF Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	Protected PDF
password	string	required	Current password

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/images-to-pdf Images to PDF Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
images	file[]	required	1-20 JPG/PNG images

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/watermark Add Watermark Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file
text	string	required	Watermark text
opacity	number	optional	0-1 (default: 0.3)

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/info PDF Info Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/convert-to-markdown PDF to Markdown Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/ai-summary AI Summary Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file
language	string	optional	Summary language

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/describe-image AI Describe Image Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file
page	integer	required	Page number
language	string	optional	Description language

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

POST /api/pdf-tools/pdf-to-word PDF to Word Auth ▶

Content-Type: multipart/form-data

Parameter	Type	Required	Description
file	file	required	PDF file (Ultra plan)

Response (200)

{
    "success": true,
    "data": {
        "download_url": "/api/pdf-tools/download?path=...",
        "filename": "compressed_output.pdf",
        "size": 1024000
    }
}

📊 Office Tools (Excel/CSV)

POST /api/office-tools/upload Upload spreadsheet Auth ▶

Parameter	Type	Required	Description
file	file	required	XLSX, XLS, or CSV (max 10MB)

GET /api/office-tools/files List uploaded files Auth ▶

POST /api/office-tools/analyze AI-analyze spreadsheet Auth ▶

Parameter	Type	Required	Description
path	string	required	File path from upload response

POST /api/office-tools/charts/generate Generate chart from data Auth ▶

Parameter	Type	Required	Description
path	string	required	File path
chart_type	string	required	bar, line, pie, scatter, etc.
x_column	string	required	X-axis column name
y_column	string	required	Y-axis column name

POST /api/office-tools/dashboard/generate Generate HTML dashboard Auth ▶

Parameter	Type	Required	Description
path	string	required	File path

Welcome Back

Create Account

Reset Password

ShortMe.lk API

Bearer Token Authentication