Introduction

Welcome to Blobs Platform! This guide will help you understand what Blobs is and how to get started.

What is Blobs?

Blobs is a multi-network blob storage and management platform designed for modern applications that need flexible, hierarchical data storage with enterprise-grade permissions.

Key Features

🗂️ Hierarchical Organization - Organize blobs in parent-child tree structures
🔐 Advanced Permissions - Hybrid RBAC + object-level permissions with inheritance
🌐 Multi-Network Support - Connect to multiple Blobs instances simultaneously
⚡ Type-Safe SDKs - First-class TypeScript and Go client libraries
🔌 Pluggable Storage - Support for local filesystem, S3, GCS, and more
👥 Multi-Tenancy - Organization-based access control
🎨 Theming - Customizable UI themes with CSS variables

Core Concepts

Blobs

A blob is an abstract data container that can store:

Text content (markdown, JSON, etc.)
Media references
Arbitrary metadata

Blobs support parent-child relationships, allowing you to build complex hierarchies.

Permissions

Permissions use a hybrid model:

RBAC (Role-Based) - System-level roles (admin, moderator, user)
ABAC (Attribute-Based) - Object-level permissions (read, write, delete, share)
Inheritance - Child blobs can inherit permissions from parents

Organizations

Users can belong to organizations with role-based access, enabling multi-tenant applications.

Networks

The SDK supports connecting to multiple Blobs backends simultaneously, each with its own configuration and authentication.

Architecture

Quick Start

Choose your preferred language:

TypeScript SDK — for web and Node.js apps (auto-generated reference of every class, method, and type)
API Reference — direct REST API with an interactive playground