Synapse Recommendation API Documentation

The Synapse Recommendation API provides a fast, secure, and intelligent way to retrieve skill-based engineer recommendations. It's built with FastAPI for performance, Pydantic for type-safe validation, and supports API key authentication for protected access.


📁 Repository Structure

synapse-recommender/
├── app/
│   ├── __init__.py              # Package initializer
│   ├── main.py                  # FastAPI application entrypoint
│   ├── engine.py                # Core logic: model training and prediction
│   ├── data_loader.py           # Fetches and processes data from PostgreSQL
│   ├── schemas.py               # Pydantic models for request/response structure
│   └── security.py              # API key validation logic
│
├── scripts/
│   └── seed_data.py             # Script to insert sample data into the database
│
├── .env                         # Environment variables (e.g., DB URI, API keys)
├── .gitignore                   # Ignore Python artifacts, .env, etc.
├── Dockerfile                   # Build instructions for Docker image
└── requirements.txt             # Python dependencies


🔐 Authentication

This API uses a secure API key-based authentication mechanism.

X-Internal-API-Key: <YOUR_API_KEY>


🚀 Endpoints

✅ Health Check

Success Response:

{
  "status": "ok",
  "model_ready": true
}