Documentation

Ekayana Documentation

Everything you need to integrate decentralized storage and AI-powered research data management into your applications.

Quick Start

1. Install the SDK

# Install the Ekayana SDK
npm install @ekayana/sdk

# Or using yarn
yarn add @ekayana/sdk

2. Upload your first file

import { Ekayana } from '@ekayana/sdk';

const client = new Ekayana({ 
  apiKey: process.env.EKAYANA_API_KEY 
});

// Upload research data with metadata
const result = await client.content.upload({
  file: './dataset.csv',
  metadata: {
    title: 'Climate Research Dataset 2024',
    license: 'CC-BY-4.0'
  }
});

console.log('CID:', result.cid);

Core Documentation

Getting Started

Bio-AI DIDs sequencer - decentralized storage and GDPR compliant DID system

Bio-DID-Sequencer

GDPR compliant Decentralized Identifier system for research data

BioAgents Architecture

AI powered system for research data processing and knowledge extraction

Knowledge Graph

Rich interconnected data representation for semantic queries and intelligent data discovery

System Architecture

Comprehensive platform integrating DIDs, AI processing, knowledge graphs, and secure data management

Solana Registry Program

In-depth specification of the bio-did-registry on-chain program

Protocol Labs Stack

Comprehensive integration with IPFS, Filecoin, libp2p, UCAN, and other Protocol Labs technologies

Dataverse Integration

Seamless integration with Harvard Dataverse for research data repositories

UCAN Authorization

Trustless, decentralized authorization with capability-based security

Post-Quantum Security

FIPS 203/204 cryptography across identity, authorization, and storage

Dedicated Gateways

High-performance IPFS gateways with custom domains and SSL support

Content Pinning

Ensure your content stays available in the IPFS network indefinitely

IPNS Publishing

Create mutable links to IPFS content with consistent addressing

Privacy Controls

GDPR-compliant privacy controls for your IPFS content

Organizations & Regulations

Global digital identity initiatives and Bio DID Sequencer compliance

Tutorials & API Reference

Authentication

Register, sign in, and use post-quantum session tokens

Creating a DID

Mint a conformant did:bio DID for a dataset and resolve it

File Storage API

Upload, download, and manage content-addressed files

Sharing & Delegation

Grant scoped access to a file with revocable UCAN tokens

IPNS Tutorial

Practical guide to using IPNS for mutable content references

Errors & Rate Limits

Error response format, status codes, and throttling behaviour

Code Examples

Copy-paste ready snippets to get started quickly

Installation

Get started with the SDK

bash
# Install the Ekayana SDK
npm install @ekayana/sdk

# Or using yarn
yarn add @ekayana/sdk

Upload Data

Store research data on IPFS

typescript
import { Ekayana } from '@ekayana/sdk';

const client = new Ekayana({ 
  apiKey: process.env.EKAYANA_API_KEY 
});

// Upload research data with metadata
const result = await client.content.upload({
  file: './dataset.csv',
  metadata: {
    title: 'Climate Research Dataset 2024',
    license: 'CC-BY-4.0'
  }
});

console.log('CID:', result.cid);

Create DID

Generate decentralized identifiers

typescript
// Create a DID for a research dataset
const did = await client.did.create({
  type: 'research-dataset',
  metadata: {
    title: 'Archaeological Survey Data',
    institution: 'National Heritage Institute',
    researchers: [
      { name: 'Suraj Kumar', orcid: '0000-0001-2345-6789' }
    ],
    keywords: ['archaeology', 'heritage', 'survey'],
    license: 'CC-BY-NC-4.0',
    gdprConsent: true
  }
});

console.log('DID:', did.id);
// did:ekayana:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK

Knowledge Extraction

AI-powered data processing

typescript
// Extract knowledge from a heritage document
const extraction = await client.extract.process({
  cid: 'bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi',
  options: {
    extractEntities: true,
    generateGraph: true,
    language: 'en'
  }
});

// Query the knowledge graph
const results = await client.graph.query({
  sparql: `
    SELECT ?artifact ?date ?location
    WHERE {
      ?artifact a :CulturalArtifact ;
               :discoveryDate ?date ;
               :location ?location .
    }
  `
});

Ready to Get Started?

Begin with our introduction guide to learn the fundamentals.

Start Learning