Documentation de l’API Memojin

En bref

• Une API REST en JSON, à l’adresse https://api.memojin.com/v1 : 28 opérations sous 14 scopes.
• Une clé d’API par organisation, qui agit au nom d’un compte Memojin : elle voit exactement ce que ce compte voit (authentification).
• Un bac à sable (mj_test_) où les générations IA sont simulées, sans crédit (bac à sable).
• Les standards du web : pagination par curseur, ETag, Idempotency-Key, en-têtes RateLimit-* (120 requêtes par minute), erreurs à code stable.
• Accès sur demande, par notre équipe : contact@memojin.com. L’API est en bêta.

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

Démarrer

• Démarrage rapideObtenez une clé de bac à sable, listez vos contenus, créez-en un, ajoutez une carte mémo et lancez une génération IA simulée, en curl, JavaScript ou Python.
• Authentification et clésClés mj_test_ et mj_live_, en-tête Authorization Bearer, compte au nom duquel la clé agit, renouvellement, révocation et erreurs d’authentification.
• Bac à sableClés mj_test_ : mêmes données, générations IA simulées sans crédit, quota de 100 appels par jour, puis passage en production avec une clé mj_live_.
• ScopesLes 14 scopes de l’API Memojin (contents:read, generations:write…), les opérations que chacun ouvre et l’erreur 403 insufficient_scope.
• Requêtes et réponsesJSON seulement, champs en camelCase, dates ISO 8601 UTC, codes 201, 202 et 204, et tous les en-têtes de requête et de réponse de l’API Memojin.

Ressources

• ContenusL’objet Content et ses cinq opérations : lister un dossier, créer un contenu avec son texte, le lire, le modifier et le supprimer par l’API Memojin.
• DossiersL’objet Folder et ses cinq opérations : lister les sous-dossiers, créer, lire, renommer, colorer et supprimer un dossier de « Mes contenus ».
• Cartes mémoL’objet Memocard (recto, verso, explication, rétention) et ses cinq opérations : lister les cartes d’un contenu, en créer, lire, modifier et supprimer.
• QuestionsL’objet Question et ses cinq opérations : réponse libre, vrai ou faux, choix unique ou multiple ; lister, créer, lire, modifier et supprimer.
• Générations IA et travauxLancez la génération de cartes mémo ou de questions par l’IA (202 Accepted), suivez le travail avec GET /v1/jobs, estimez les crédits consommés.
• RechercheGET /v1/search : retrouvez les dossiers et les contenus d’un compte Memojin par leur nom, titre ou description, sans tenir compte des accents ni de la casse.
• EspacesL’objet Space et ses deux opérations de lecture : les espaces (classes, groupes) dont le compte est propriétaire, archivés compris sur demande.
• Séances et statistiquesLes séances d’étude du compte (statut, espace, cartes vues et réussies) et ses statistiques : cartes maîtrisées, temps d’étude, taux de réussite.

Protocole

• PaginationListes paginées par curseur : limit de 1 à 100, cursor opaque, enveloppe data, nextCursor et hasMore, en-tête Link rel="next", boucles complètes.
• Requêtes conditionnellesChaque GET rend un ETag : revalidez avec If-None-Match (304 sans corps) et protégez PATCH et DELETE avec If-Match (412 si la ressource a changé).
• IdempotenceEn-tête Idempotency-Key sur chaque POST : rejouez une requête après une coupure, sans rien créer deux fois ni consommer deux fois de crédits, 24 h durant.
• Limites de débit120 requêtes par minute par organisation, 100 par jour en bac à sable : en-têtes RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset et Retry-After.
• ErreursLe format JSON des erreurs, les 25 codes stables de l’API Memojin avec leur statut HTTP, et la conduite à tenir : corriger, attendre ou réessayer.
• Crédits IA et coûtsSeules les générations IA consomment des crédits : une unité ai_card par carte ou question, estimée dans la réponse 202 ; tout le reste est gratuit.

Versions

• Versions et dépréciationsCe qui peut changer dans /v1 et ce qui ne change jamais, l’en-tête Memojin-Version, Deprecation et Sunset, et 12 mois de coexistence avec /v2.
• Journal des changementsChaque version du contrat public /v1 de l’API Memojin, datée : nouvelles opérations, nouveaux scopes, nouveaux codes d’erreur et nouveaux en-têtes.

La référence, servie par l’API

Cette documentation et la référence sont générées depuis le même contrat que celui avec lequel l’API valide vos requêtes. La référence reste disponible en appoint :

• Référence interactive — chaque opération, essayable dans le navigateur (Scalar).
• Contrat OpenAPI 3.1 — pour générer un client typé dans votre langage.
• Table des codes d’erreur — la cible des liens rel="help" des erreurs.

En préparation

• Espace développeur en libre-serviceBientôt — créer, nommer et révoquer vos clés, suivre votre consommation, demander la production vous-même. Aujourd’hui, notre équipe le fait pour vous, par e-mail.
• Webhooks sortantsBientôt — être prévenu de la fin d’une génération au lieu d’interroger GET /v1/jobs/{jobId}.
• Serveur MCPBientôt — les mêmes opérations, exposées aux assistants IA, avec les mêmes scopes et les mêmes crédits.
• Accès inclus dans les offresBientôt — ouvrir l’API depuis votre abonnement, sans demande.