Skip to content

API 参考概览

Omelette 后端在 /api/v1/ 下提供 REST API。

基础 URL

http://localhost:8000/api/v1

响应格式

统一包装:

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

分页

列表接口使用 PaginatedData

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

异步任务

长任务(search、dedup、crawl、OCR、RAG build)返回 task_id。轮询:

GET /api/v1/tasks/{task_id}

资源

资源路径
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

Released under the MIT License.