Deck package

A deck package is a ZIP file containing all the data related to a deck: its structure, cards, review history, and media files. Use it to back up a deck, import it somewhere else, or share it with others.

JSON files in the package mirror the corresponding API objects, with small differences detailed in the pages of deck.json, cards.json, and reviews.json.

  • To export a deck, click on the right side of the decks menu, then select Export. You can choose to include the review history in the export or not.
  • To import a deck, go to the import page.

Package structure

The deck package is made of three JSON files and a folder for media files.

deck-package.zip
├── deck.json
├── cards.json
├── reviews.json
└── media/
└── ...
deck.json required

The deck's name, settings, deck fields, and card layouts.

cards.json required

The content of every card in the deck.

reviews.json optional

The review history of every card. Omit it to export a deck without its learning progress, for example when sharing it with someone else.

media optional

The audio and image files referenced from cards.json. Only required if the deck has fields of type audio or image with content, or images embedded in rich_content fields.


Media files

Media files referenced in the cards.json file need to be included in the media folder. Audio and image files are accepted, whether they are the value of an audio or image field, or an image embedded in a rich_content field.

FilesAccepted formatsMaximum size
Audiomp3, wav, ogg0.5MB
Imagejpg, jpeg, png, gif, webp, svg3MB

Size limitations

To be imported in Recall, a deck package must:

  • Be less than 500MB once compressed;
  • Contain no more than 5,000 cards;
  • Contain no more than 250,000 reviews.