Sur cette page

À savoir
L’objet Folder
Lister les sous-dossiers d’un dossier
Créer un dossier
Lire un dossier
Modifier un dossier
Supprimer un dossier

Les dossiers rangent la bibliothèque, sur cinq niveaux au plus. La couleur et l’icône ne valent que pour les dossiers de premier niveau ; les demander pour un sous-dossier répond 403 forbidden.

À savoir

GET /v1/folders liste les sous-dossiers d’un parent (le premier niveau sans parentId) ; les contenus d’un dossier se lisent avec GET /v1/contents?folderId=….
Supprimer un dossier supprime ses sous-dossiers et leurs contenus.

L’objet Folder

Un dossier de la bibliothèque (« Mes contenus »). Les dossiers s’imbriquent sur cinq niveaux au plus.

Champ	Type	Description
`id`toujours présent	`string (uuid)`	Identifiant du dossier (UUID).
`name`toujours présent	`string`	Nom du dossier.
`parentId`toujours présent	`string \| null`	Dossier parent, ou null pour un dossier de premier niveau.
`description`toujours présent	`string \| null`	Description, ou null.
`color`toujours présent	`string \| null`	Couleur `#RRGGBB` (dossiers de premier niveau seulement), ou null.
`icon`toujours présent	`string \| null`	Nom d’icône (dossiers de premier niveau seulement), ou null.
`updatedAt`toujours présent	`string (date-time)`	Instant de la dernière modification (ISO 8601, UTC).

Folder

{
  "id": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60",
  "name": "Biology",
  "parentId": null,
  "description": "Year 12 biology.",
  "color": "#3B82F6",
  "icon": "leaf",
  "updatedAt": "2026-10-02T08:30:12.000Z"
}

Lister les sous-dossiers d’un dossier

GET/v1/foldersScope folders:read

Les dossiers rangés directement dans le parent (le premier niveau si parentId est omis), dans l’ordre de la bibliothèque, paginés.

Paramètres

Champ	Où	Type	Description
`parentId`facultatif	requête	`string (uuid)`	Dossier parent (UUID). Omettez-le pour lister les dossiers de premier niveau.
`limit`facultatif	requête	`integer`de 1 à 100 · défaut 50	Nombre d’éléments par page, de 1 à 100 (50 par défaut).
`cursor`facultatif	requête	`string`200 caractères au plus	Curseur opaque : le `nextCursor` de la page précédente. Gardez le même `limit` d’une page à l’autre.

Réponse 200

Une page de dossiers — Une page de Folder { data, nextCursor, hasMore }

Erreurs

HTTP	Signification
`400`	`validation_error` ou `invalid_cursor`
`401`	`invalid_api_key` ou `revoked_api_key`
`403`	`insufficient_scope`, `account_suspended`, `live_not_enabled` ou `forbidden`
`404`	`not_found` — le dossier parent n’existe pas ou n’est pas visible avec cette clé
`406`	`not_acceptable` — l’en-tête `Accept` exclut `application/json`
`429`	`rate_limited` ou `test_quota_exceeded` — voyez les en-têtes `Retry-After` et `RateLimit-*`
`500`	`internal_error`
`503`	`unavailable` — voyez l’en-tête `Retry-After`

Requête

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

Réponse 200

{
  "data": [
    {
      "id": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60",
      "name": "Biology",
      "parentId": null,
      "description": "Year 12 biology.",
      "color": "#3B82F6",
      "icon": "leaf",
      "updatedAt": "2026-10-02T08:30:12.000Z"
    }
  ],
  "nextCursor": null,
  "hasMore": false
}

Créer un dossier

POST/v1/foldersScope folders:write

Crée un dossier au premier niveau ou dans un parent (cinq niveaux au plus). La couleur et l’icône ne valent que pour les dossiers de premier niveau.

Paramètres

Champ	Où	Type	Description
`Idempotency-Key`facultatif	en-tête	`string`	Fortement recommandée. Une valeur unique par opération (UUID v4), réutilisée telle quelle à chaque nouvelle tentative. Pendant 24 heures, la même clé et la même requête rejouent la première réponse (`Idempotent-Replayed: true`) sans second effet ni second débit ; une autre requête avec la même clé → 422 `idempotency_key_reused` ; encore en cours → 409 `idempotency_in_progress`.

Corps de la requête `CreateFolderRequest`

Un nouveau dossier.

Champ	Type	Description
`name`obligatoire	`string`1 à 200 caractères	Nom du dossier (1 à 200 caractères).
`parentId`facultatif	`string (uuid) \| null`	Dossier parent ; omis ou null = premier niveau.
`description`facultatif	`string \| null`2000 caractères au plus	Description (2 000 caractères au plus).
`color`facultatif	`string \| null`	Couleur `#RRGGBB` (dossiers de premier niveau seulement), ou null.
`icon`facultatif	`string \| null`64 caractères au plus	Nom d’icône (dossiers de premier niveau seulement).

Réponse 201

Le dossier créé — Un objet Folder

Erreurs

HTTP	Signification
`400`	`validation_error` ou `bad_request`
`401`	`invalid_api_key` ou `revoked_api_key`
`403`	`insufficient_scope`, `account_suspended`, `live_not_enabled` ou `forbidden`
`404`	`not_found` — le dossier parent n’existe pas ou n’est pas visible avec cette clé
`406`	`not_acceptable` — l’en-tête `Accept` exclut `application/json`
`409`	`idempotency_in_progress` — réessayez après `Retry-After` (1 s)
`413`	`payload_too_large`
`415`	`unsupported_media_type`
`422`	`idempotency_key_reused`, ou une règle métier (voyez la description)
`429`	`rate_limited` ou `test_quota_exceeded` — voyez les en-têtes `Retry-After` et `RateLimit-*`
`500`	`internal_error`
`503`	`unavailable` — voyez l’en-tête `Retry-After`

Requête

curl -X POST "https://api.memojin.com/v1/folders" \
  -H "Authorization: Bearer $MEMOJIN_API_KEY" \
  -H "Idempotency-Key: 6f1c2b0e-8d4a-4f7e-9a51-3c2d1e0f9b87" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Biology",
  "color": "#3B82F6",
  "icon": "leaf"
}'

Réponse 201

{
  "id": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60",
  "name": "Biology",
  "parentId": null,
  "description": "Year 12 biology.",
  "color": "#3B82F6",
  "icon": "leaf",
  "updatedAt": "2026-10-02T08:30:12.000Z"
}

Lire un dossier

GET/v1/folders/{folderId}Scope folders:read

Un dossier du compte au nom duquel la clé d’API agit. Répond 304 à un If-None-Match qui correspond.

Paramètres

Champ	Où	Type	Description
`folderId`obligatoire	chemin	`string (uuid)`	Identifiant du dossier (UUID).

Réponse 200

Le dossier — Un objet Folder

Erreurs

HTTP	Signification
`400`	`validation_error` — un identifiant n’est pas un UUID
`401`	`invalid_api_key` ou `revoked_api_key`
`403`	`insufficient_scope`, `account_suspended`, `live_not_enabled` ou `forbidden`
`404`	`not_found`
`406`	`not_acceptable` — l’en-tête `Accept` exclut `application/json`
`429`	`rate_limited` ou `test_quota_exceeded` — voyez les en-têtes `Retry-After` et `RateLimit-*`
`500`	`internal_error`
`503`	`unavailable` — voyez l’en-tête `Retry-After`

Requête

curl "https://api.memojin.com/v1/folders/7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60" \
  -H "Authorization: Bearer $MEMOJIN_API_KEY"

Réponse 200

{
  "id": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60",
  "name": "Biology",
  "parentId": null,
  "description": "Year 12 biology.",
  "color": "#3B82F6",
  "icon": "leaf",
  "updatedAt": "2026-10-02T08:30:12.000Z"
}

Modifier un dossier

PATCH/v1/folders/{folderId}Scope folders:write

Modifie le nom, la description, la couleur ou l’icône (couleur et icône : dossiers de premier niveau seulement, 403 forbidden sinon).

Paramètres

Champ	Où	Type	Description
`folderId`obligatoire	chemin	`string (uuid)`	Identifiant du dossier (UUID).

Corps de la requête `UpdateFolderRequest`

Les champs à modifier ; les autres restent tels quels.

Champ	Type	Description
`name`facultatif	`string`1 à 200 caractères	Nouveau nom (1 à 200 caractères).
`description`facultatif	`string \| null`2000 caractères au plus	Nouvelle description, ou null pour l’effacer.
`color`facultatif	`string \| null`	Couleur `#RRGGBB` (dossiers de premier niveau seulement), ou null.
`icon`facultatif	`string \| null`64 caractères au plus	Nouveau nom d’icône, ou null.

Réponse 200

Le dossier modifié — Un objet Folder

Erreurs

HTTP	Signification
`400`	`validation_error` ou `bad_request`
`401`	`invalid_api_key` ou `revoked_api_key`
`403`	`insufficient_scope`, `account_suspended`, `live_not_enabled` ou `forbidden`
`404`	`not_found`
`406`	`not_acceptable` — l’en-tête `Accept` exclut `application/json`
`412`	`precondition_failed` — `If-Match` ne correspond pas à l’`ETag` actuel
`413`	`payload_too_large`
`415`	`unsupported_media_type`
`429`	`rate_limited` ou `test_quota_exceeded` — voyez les en-têtes `Retry-After` et `RateLimit-*`
`500`	`internal_error`
`503`	`unavailable` — voyez l’en-tête `Retry-After`

Requête

curl -X PATCH "https://api.memojin.com/v1/folders/7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60" \
  -H "Authorization: Bearer $MEMOJIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Biology — Year 12"
}'

Réponse 200

{
  "id": "7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60",
  "name": "Biology",
  "parentId": null,
  "description": "Year 12 biology.",
  "color": "#3B82F6",
  "icon": "leaf",
  "updatedAt": "2026-10-02T08:30:12.000Z"
}

Supprimer un dossier

DELETE/v1/folders/{folderId}Scope folders:write

Supprime le dossier, ses sous-dossiers et leurs contenus. Répond 204 sans corps.

Paramètres

Champ	Où	Type	Description
`folderId`obligatoire	chemin	`string (uuid)`	Identifiant du dossier (UUID).

Réponse 204

Supprimé — Pas de corps de réponse.

Erreurs

HTTP	Signification
`400`	`validation_error` — un identifiant n’est pas un UUID
`401`	`invalid_api_key` ou `revoked_api_key`
`403`	`insufficient_scope`, `account_suspended`, `live_not_enabled` ou `forbidden`
`404`	`not_found`
`406`	`not_acceptable` — l’en-tête `Accept` exclut `application/json`
`412`	`precondition_failed` — `If-Match` ne correspond pas à l’`ETag` actuel
`429`	`rate_limited` ou `test_quota_exceeded` — voyez les en-têtes `Retry-After` et `RateLimit-*`
`500`	`internal_error`
`503`	`unavailable` — voyez l’en-tête `Retry-After`

Requête

curl -X DELETE "https://api.memojin.com/v1/folders/7a2d9c41-0b3e-4c5f-8e6a-1d2c3b4a5f60" \
  -H "Authorization: Bearer $MEMOJIN_API_KEY"

Memojin pour

Fonctionnalités

Matières

Ressources

Dossiers

À savoir

L’objet Folder

Lister les sous-dossiers d’un dossier

Paramètres

Réponse 200

Erreurs

Créer un dossier

Paramètres

Corps de la requête `CreateFolderRequest`

Réponse 201

Erreurs

Lire un dossier

Paramètres

Réponse 200

Erreurs

Modifier un dossier

Paramètres

Corps de la requête `UpdateFolderRequest`

Réponse 200

Erreurs

Supprimer un dossier

Paramètres

Réponse 204

Erreurs

Dossiers

À savoir

L’objet Folder

Lister les sous-dossiers d’un dossier

Paramètres

Réponse 200

Erreurs

Créer un dossier

Paramètres

Corps de la requête CreateFolderRequest

Réponse 201

Erreurs

Lire un dossier

Paramètres

Réponse 200

Erreurs

Modifier un dossier

Paramètres

Corps de la requête UpdateFolderRequest

Réponse 200

Erreurs

Supprimer un dossier

Paramètres

Réponse 204

Erreurs

Corps de la requête `CreateFolderRequest`

Corps de la requête `UpdateFolderRequest`