Information
- License: AGPL-3.0-or-later
- OpenAPI version:
3.1.0
Merran documentation /API & integrations
Overview
Merran API 0.0.0
Section titled “Merran API 0.0.0”Everything the Merran app does, it does through this API: the same routes are open to scripts and to tools like Home Assistant. Tools use an API key: make one at POST /api/auth/api-keys while signed in, then send it as Authorization: Bearer mrn_…. Each route a key can use says which permission it needs, in x-merran-permission (like recipes:read); routes without it refuse keys. Browsers sign in with POST /api/auth/sign-in/username and send the session cookie it sets.
Operations
Section titled “Operations”GET
/api/auth/mePOST
/api/auth/setupPOST
/api/householdsGET
/api/recipesPOST
/api/recipesDELETE
/api/recipes/deletedDELETE
/api/recipes/{recipe}POST
/api/sharePOST
/api/discoverGET
/api/sitesPOST
/api/sitesDELETE
/api/sites/{site}GET
/api/planPOST
/api/plan/repeatPOST
/api/plan/clearGET
/api/listPOST
/api/list/clearPOST
/api/list/itemsDELETE
/api/list/items/{itemId}GET
/api/pantryGET
/api/eventsGET
/api/storesDELETE
/api/stores/kroger/linkGET
/api/voicePOST
/api/voice/speakPATCH
/api/settings/serverGET
/api/healthAuthentication
Section titled “Authentication”session
Section titled “session”The cookie that signing in sets.
Security scheme type: apiKey
Cookie parameter name: merran.session_token
apiKey
Section titled “apiKey”An API key, made at POST /api/auth/api-keys, sent as Authorization: Bearer mrn_…. It acts as its person in one household, with only the permissions it was given.
Security scheme type: http
Bearer format: mrn_…
© 2026 Kyle Johnson. Documentation: CC BY 4.0. Merran: AGPL-3.0-or-later.