HTTP API

Review HTTP routes, authentication, and request shapes.

API Reference

Start the HTTP service with `docpipe serve --host 0.0.0.0 --port 8000`. REST routes use configured HTTP Basic authentication. Health, metrics, static license pages, and the MCP-specific routes use their documented separate access rules.

Source: HTTP application and route registration Source: Authentication policy

Method	Path	Description / access
GET	/health	Health status; exempt from Basic Auth
GET	/metrics	Prometheus metrics; exempt from Basic Auth
GET	/profiles	Installed profiles and runtime presets
GET	/plugins	Installed plugins and source/vector catalog
GET	/plugins/health	Probe configured vector plugin; authenticated
POST	/plugins/resolve	Recommend plugins for a file and goal
POST	/parse	Parse a document
POST	/extract	Extract structured data
POST	/run	Parse and extract
POST	/ingest	Ingest into the selected vector store
POST	/ingest/stream	Ingest with SSE progress
DELETE	/ingest	Remove chunks for a source
POST	/search	Vector similarity search
POST	/rag/query	RAG question and answer
POST	/rag/stream	Streaming RAG via SSE
POST	/agents/query	AutoGen agentic RAG
POST	/mcp	Streamable HTTP MCP endpoint; operator bearer token
GET	/mcp/health	MCP liveness only
GET	/mcp/tools	Legacy MCP tool descriptors
POST	/mcp/call	Legacy MCP tool invocation
GET	/admin	Operator UI when control DB and panel are enabled

Python HTTP client

from docpipe.http import DocpipeClient

with DocpipeClient("http://localhost:8000", username="admin", password="<secret>") as client:
    print(client.health())
    print(client.get("/profiles").json())
    print(client.rag_query({...}))