Codeflow API¶
Service title: codeflow-to-md
Source: src\md_generator\codeflow\api\main.py
Endpoints¶
| Method | Path | Auth | Request | Response | Errors |
|---|---|---|---|---|---|
| GET | /health | See OpenAPI /docs |
Upload/body per route | Job id or ZIP | Standard FastAPI errors |
| POST | /analyze | See OpenAPI /docs |
Upload/body per route | Job id or ZIP | Standard FastAPI errors |
| GET | /status/{job_id} | See OpenAPI /docs |
Upload/body per route | Job id or ZIP | Standard FastAPI errors |
| GET | /result/{job_id} | See OpenAPI /docs |
Upload/body per route | Job id or ZIP | Standard FastAPI errors |
| POST | /analyze/sync | See OpenAPI /docs |
Upload/body per route | Job id or ZIP | Standard FastAPI errors |
| GET | /analyze/job/{job_id}/events | See OpenAPI /docs |
Upload/body per route | Job id or ZIP | Standard FastAPI errors |
Sync vs async¶
- Sync routes return artifacts immediately (subject to size/time limits).
- Job routes return
job_id; poll status/download endpoints until complete. - Event/stream routes (domain modules) emit progress for long exports.
Authentication¶
No built-in authentication middleware is enabled. Terminate TLS and authenticate at the reverse proxy or API gateway.
Examples¶
Open interactive docs at /docs when running uvicorn locally.
Many converter APIs mount MCP at /mcp when mcp extra is installed.