Skip to main content
The Ragrails REST API exposes the same pipeline as the SDK through HTTP. Use it when your application is not Python, when you want a service boundary around indexing and chat, or when clients need to upload documents directly.
The server starts on http://127.0.0.1:8000. Run the dependency preflight before your first pipeline request. It reports missing optional packages, provider keys, and common local-vs-Docker vector database URL mistakes.

Workflows

Pipeline

Start with the pipeline overview, or call individual stages when you want to inspect or persist each intermediate JSON result.

Streaming

Streaming endpoints return text/event-stream:

Server Extras

Most request and response bodies are JSON. Document uploads use multipart form data. Use /v1/pipelines/ingest/mixed when a single ingest request must combine uploaded files with server paths, folders, remote document URLs, websites, APIs, or Markdown. Use the OpenAPI schema when generating clients.