Skip to main content

​
Query vaults

Read vault contents using the vault ID. All read operations work on active, sealed, and persisted vaults. Expired vaults return 404.

​
Get vault metadata

import { initialise } from '@prudra/core';
import { getVault } from '@prudra/vault';

initialise({ apiKey: process.env.PRUDRA_API_KEY! });

const vault = await getVault({ vaultId: 'vlt_clx1abc123' });
console.log(vault.id);        // 'vlt_clx1abc123'
console.log(vault.status);    // 'sealed'
console.log(vault.summary);   // 'Analysis complete'
console.log(vault.expiresAt); // ISO timestamp

​
Get the full manifest

The manifest includes all documents with their data and all files with their CDN URLs: 
import { getVaultManifest } from '@prudra/vault';

const manifest = await getVaultManifest({ vaultId: 'vlt_clx1abc123' });

for (const doc of manifest.documents) {
  console.log(doc.label, doc.data);
}

for (const file of manifest.files) {
  console.log(file.name, file.url);  // CDN URL for download
}
When using vaultMiddleware, req.vault.getManifest() returns the same data: 
const manifest = await req.vault!.getManifest();
res.json({
  documents: manifest.documents,
  files:     manifest.files,
});

​
Response fields

FieldTypeDescription
idstringVault ID (vlt_...)
statusstringactive, sealed, persisted, or expired
labelstringHuman-readable label from creation
summarystringSummary provided when sealing
sealedAtstringISO timestamp of sealing, null if still active
expiresAtstringISO timestamp of expiry, null if persisted
createdAtstringISO timestamp of creation
documentsarrayList of document stubs (full data in manifest)
filesarrayList of file stubs with CDN URLs