# RemindMe

RemindMe is a spaced repetition learning app at https://getremindme.app. Public docs are served at https://docs.getremindme.app and https://getremindme.app/docs.

## Primary URLs

- App: https://getremindme.app
- Docs hub: https://docs.getremindme.app/docs
- 5-minute quickstart: https://docs.getremindme.app/docs/quickstart
- API quickstart: https://docs.getremindme.app/docs/api
- API authentication: https://docs.getremindme.app/docs/api/authentication
- Human API reference: https://docs.getremindme.app/docs/api/reference
- CLI docs: https://docs.getremindme.app/docs/cli
- Agent guide: https://docs.getremindme.app/docs/agents
- MCP guide: https://docs.getremindme.app/docs/agents/mcp
- API base URL: https://api.getremindme.app/v1
- OpenAPI: https://docs.getremindme.app/openapi.json
- Full agent context: https://docs.getremindme.app/llms-full.txt

## Product Summary

Users create study materials, review them on a spaced repetition schedule, receive reminders, and manage billing from the web app. Premium costs $7.99/month or $79.90/year and is billed through Stripe. Billing, invoices, cancellation, and payment methods are managed through Settings and the Stripe portal. Mid-cycle plan changes are not currently supported.

## API Keys

Users create and revoke API keys in the app at Settings > Developer/API Access. Keys begin with `rmk_live_`, are shown only once, are stored by RemindMe only as hashed values with metadata, and should be rotated or revoked if exposed.

Use either header:

```http
Authorization: Bearer <api-key>
X-RemindMe-API-Key: <api-key>
```

Scopes: `materials:read`, `materials:write`, `reviews:read`, `reviews:write`, `snooze:write`, `profile:read`.

The CLI is currently a checked-in local Node script at `cli/remindme.js`, not a published npm global package. Use `REMINDME_API_KEY` or `node cli/remindme.js login-api-key rmk_live_...` for local storage. A future package may expose a global `remindme` command.

## v1 Endpoints

- `GET /v1/me`
- `GET /v1/materials?limit=&q=`
- `POST /v1/materials`
- `GET /v1/reviews/due?limit=`
- `POST /v1/reviews/{materialId}`
- `POST /v1/materials/{materialId}/snooze`
- `GET /v1/search?q=&limit=`

Agents should use least-privilege scoped keys, prefer read-only access until a user asks for a write action, confirm creates/reviews/snoozes, and never expose API keys in logs, prompts, source files, or shared transcripts.

- API reference for humans: https://docs.getremindme.app/docs/api/reference
- Quickstart path for humans: create account, add first material, complete first review, create API key, call `GET /v1/me`, then try the CLI.