Memojin API documentation

At a glance

• A JSON REST API, at https://api.memojin.com/v1: 28 operations under 14 scopes.
• One API key per organization, acting for one Memojin account: it sees exactly what that account sees (authentication).
• A sandbox (mj_test_) where AI generations are simulated, without credits (sandbox).
• Web standards: cursor pagination, ETag, Idempotency-Key, RateLimit-* headers (120 requests a minute), errors with stable codes.
• Access on request, opened by our team: contact@memojin.com. The API is in beta.

curl "https://api.memojin.com/v1/contents?limit=20" \
  -H "Authorization: Bearer $MEMOJIN_API_KEY"

Get started

• Quick startGet a sandbox key, list your contents, create one, add a memocard and start a simulated AI generation, with curl, JavaScript or Python examples.
• Authentication and keysmj_test_ and mj_live_ keys, the Authorization Bearer header, the account a key acts for, rotation, revocation and authentication errors.
• Sandboxmj_test_ keys: same data, simulated AI generations without credits, a quota of 100 calls a day, then going live with a mj_live_ key.
• ScopesThe 14 scopes of the Memojin API (contents:read, generations:write…), the operations each one opens, and the 403 insufficient_scope error.
• Requests and responsesJSON only, camelCase fields, ISO 8601 UTC instants, 201, 202 and 204 answers, and every request and response header of the Memojin API.

Resources

• ContentsThe Content object and its five operations: list a folder, create a content with its text, read, update and delete it with the Memojin API.
• FoldersThe Folder object and its five operations: list subfolders, create, read, rename, colour and delete a folder of the “My contents” library.
• MemocardsThe Memocard object (front, back, explanation, retention) and its five operations: list a content’s memocards, create, read, update and delete them.
• QuestionsThe Question object and its five operations: free text, true or false, single or multiple choice; list, create, read, update and delete questions.
• AI generations and jobsStart an AI generation of memocards or questions (202 Accepted), follow the job with GET /v1/jobs, and read the AI credits it plans to use.
• SearchGET /v1/search: find the folders and contents of a Memojin account by name, title or description, ignoring case and accents, with a bounded result count.
• SpacesThe Space object and its two read operations: the spaces (classes, groups) the account owns, archived ones included on request.
• Sessions and statisticsThe study sessions of the account (status, space, cards seen and correct) and its statistics: mastered memocards, study time and success rate.

Protocol

• PaginationCursor-paginated lists: limit from 1 to 100, an opaque cursor, the data, nextCursor and hasMore envelope, the Link rel="next" header, full loops.
• Conditional requestsEvery GET returns an ETag: revalidate with If-None-Match (bodiless 304) and protect PATCH and DELETE with If-Match (412 if the resource changed).
• IdempotencyAn Idempotency-Key header on every POST: retry after a network failure without creating anything twice nor using credits twice, for 24 hours.
• Rate limits120 requests a minute per organization, 100 a day in the sandbox: the RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset and Retry-After headers.
• ErrorsThe JSON error format, the 25 stable error codes of the Memojin API with their HTTP status, and what to do: fix the request, wait, or retry.
• AI credits and costsOnly AI generations use credits: one ai_card unit per memocard or question, estimated in the 202 response; every other operation is free.

Versions

• Versioning and deprecationWhat may change within /v1 and what never does, the Memojin-Version header, Deprecation and Sunset, and 12 months of overlap with a future /v2.
• ChangelogEvery version of the public /v1 contract of the Memojin API, dated: new operations, new scopes, new error codes and new headers.

The reference, served by the API

This documentation and the reference are generated from the same contract the API validates your requests with. The reference remains available alongside:

• Interactive reference — every operation, to try in the browser (Scalar).
• OpenAPI 3.1 contract — to generate a typed client in your language.
• Error code table — the target of the errors’ rel="help" links.

In preparation

• Self-service developer spaceComing soon — create, name and revoke your keys, follow your usage, ask for production yourself. Today, our team does it for you, by e-mail.
• Outgoing webhooksComing soon — be told when a generation ends instead of polling GET /v1/jobs/{jobId}.
• MCP serverComing soon — the same operations, exposed to AI assistants, with the same scopes and credits.
• Access included in plansComing soon — open the API from your subscription, without asking.