Run the REST API

​

What you will run

​

1. Install server extras

pip install "ragrails[server-qdrant]"
# or: pip install "ragrails[server-pinecone]"
# or: pip install "ragrails[server-weaviate]"

export VOYAGE_API_KEY="..."
export OPENAI_API_KEY="..."

​

2. Start the server

ragrails-api --host 127.0.0.1 --port 8000

ragrails-api --reload

​

3. Smoke test

curl http://127.0.0.1:8000/v1/health

curl -X POST http://127.0.0.1:8000/v1/pipelines/query \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What does this knowledge base cover?",
    "retrieval": {
      "vector_db": "qdrant",
      "collection": "docs",
      "url": "http://localhost:6333",
      "top_k": 5
    }
  }'

​

Common endpoints

​

Production checklist

• Put the service behind your auth layer, gateway, and rate limits.
• Use managed vector storage or persistent volumes for production indexes.
• Keep API keys in environment variables or your secret manager.
• Generate typed clients from /v1/openapi.json.
• Prefer streaming endpoints for long crawls and responsive chat UIs.
• Add request logging and audit logging around ingestion, chat, and tool-using workflows.

​

Next steps

• REST API overview
• REST API reference
• Streaming
• Website walkthrough