For the complete documentation index, see llms.txt. This page is also available as Markdown.

Storage API

Looking for endpoints? The full OpenAPI spec is rendered in the sidebar below this section's pages — one page per resource (Storage, Index, User, …) with request and response models. Base URL: https://cloud.learncard.com/api.

LearnCloud Storage is LearnCard's end-to-end encrypted storage system. It holds a user's personal data — their credentials, presentations, and learning records — encrypted client-side, so not even LearnCard servers can read it.

Storage API vs Network API: the Network API handles interactions between parties (sending credentials, profiles, boosts, consent). The Storage API handles a single user's private data (their wallet contents and xAPI learning records). Most integrations that send credentials only need the Network API.

Use the Storage API when you need to:

  • Store credentials and presentations securely and sync them across devices

  • Record and query xAPI learning statements ("Alice completed Lesson 3") tied to a user's DID

  • Swap in your own storage backend while keeping the same interface

import { initLearnCard } from '@learncard/init';

const learnCard = await initLearnCard({ seed: process.env.SEED, network: true });

const uri = await learnCard.store.LearnCloud.uploadEncrypted(credential);
const ids = await learnCard.index.LearnCloud.get({ category: 'Achievement' });

Key Features

  • xAPI Integration: Track and store learning experiences

  • OIDC Authentication: Provide OpenID Connect authentication

  • DID Web Resolution: Resolve DIDs for identity management

  • End-to-End Encryption: Data is encrypted client-side.

Last updated

Was this helpful?