Skip to content

api-reference.md

Latest commit

 

History

History
80 lines (55 loc) · 1.48 KB

api-reference.md

File metadata and controls

80 lines (55 loc) · 1.48 KB

API Reference

API Service (services/api)

Base URL: http://localhost:4000

Health

  • GET /health
  • GET /health/deps

Auth

  • POST /api/auth/register
  • POST /api/auth/login
  • GET /api/auth/me

Manuals

  • POST /api/manuals (multipart form-data, field: file)
  • GET /api/manuals
  • GET /api/manuals/:manualId
  • GET /api/manuals/:manualId/checklists
  • POST /api/manuals/:manualId/checklists/generate

Generate request body:

{
  "objective": "Generate a practical maintenance checklist",
  "maxItems": 20,
  "provider": "local",
  "retrievalMode": "tree_search",
  "strictCitations": true
}

Jobs

  • GET /api/jobs/health
  • POST /api/jobs/generate
  • GET /api/jobs
  • GET /api/jobs/:jobId

Checklists

  • GET /api/checklists/:checklistId
  • PATCH /api/checklists/:checklistId
  • PATCH /api/checklists/:checklistId/items/:itemId
  • POST /api/checklists/:checklistId/export/pdf

Exports

  • GET /api/exports/:exportId
  • GET /api/exports/:exportId/file

Chat

  • GET /api/chat/history?manualId=...
  • POST /api/chat/query

AI Service (services/ai)

Base URL: http://localhost:8001

  • GET /health
  • POST /v1/ingest
  • POST /v1/pageindex/build
  • POST /v1/checklist/generate
  • POST /v1/checklist/verify
  • POST /v1/chat/query

Auth Notes

Most /api/* routes require Bearer token except auth register/login and health routes.

Notes

  • Most /api/* routes require Bearer token.
  • Health routes do not require auth.