Docs
The API and CLI source live on GitHub. We keep the canonical docs there so they never drift from the code — these cards just link out.
README
Quick start, two-mode overview, API reference, BYOK walkthrough.
github.com/adrienckr/notslop-api ↗
ARCHITECTURE.md
Single-process design, scrape cron, credit ledger, encrypted provider storage.
github.com/adrienckr/notslop-api ↗
SELF_HOST.md
Self-host walkthrough for Fly.io including Stripe + Resend setup.
github.com/adrienckr/notslop-api ↗
CONTRIBUTING.md
How to add a new source. Templates and review expectations.
github.com/adrienckr/notslop-api ↗
Quick reference
Endpoints at a glance. Full schemas in the README.
| Method | Path | What |
|---|---|---|
| GET | /v1/health | Liveness |
| GET | /v1/pricing | Live credit cost + per-provider cost |
| POST | /v1/signup | Send magic link |
| GET | /v1/auth/verify | Consume token, return api_key |
| GET | /v1/me | Balance + keys |
| GET | /v1/feed | Read cached posts (1 credit) |
| PUT | /v1/providers/:provider | Store BYOK creds |
| POST | /v1/billing/checkout | Stripe Checkout for credit packs |