API Reference Overview

The Omelette backend exposes REST APIs under /api/v1/.

Base URL

http://localhost:8000/api/v1

Response Format

All endpoints return a consistent wrapper:

{
  "code": 200,
  "message": "success",
  "data": { ... }
}

• code — HTTP-style status (200, 201, 400, 404, 500)
• message — Human-readable message
• data — Response payload (omit on 204-style success)

Pagination

List endpoints use PaginatedData:

{
  "items": [...],
  "total": 100,
  "page": 1,
  "page_size": 20,
  "total_pages": 5
}

Async Tasks

Long-running operations (search, dedup, crawl, OCR, RAG build) return task_id. Poll status:

GET /api/v1/tasks/{task_id}

Resources

Resource	Base Path
Projects	/projects
Papers	/projects/{id}/papers
Keywords	/projects/{id}/keywords
Search	/projects/{id}/search
Dedup	/projects/{id}/dedup
OCR	/projects/{id}/ocr
Crawler	/projects/{id}/crawl
Subscription	/projects/{id}/subscriptions
RAG	/projects/{id}/rag
Writing	/projects/{id}/writing
Chat	/chat
Conversations	/conversations
Settings	/settings
Tasks	/tasks
Pipelines	/pipelines