IPFS — BizFirstAI Node Reference

What it does: The IPFS node (ipfs) exposes a Kubo IPFS daemon's RPC API, an IPFS Cluster daemon's REST API, and two composite Storage operations as workflow steps. It covers content-addressed storage (add/cat/get/ls/refs), pinning (local and remote-pinning-service), the Mutable File System (MFS), the IPLD DAG and raw block layers, IPNS naming, key management, swarm/peer connectivity, bootstrap peers, node system info, and repo maintenance.

Quick Start

Add an IPFS node to your workflow
Set resource to content and operation to add
Set baseUrl to your Kubo daemon's RPC endpoint (e.g. http://127.0.0.1:5001)
Wire an upstream node's binary output into inputDataKey (default data), or set inlineContent
Run the workflow — the node uploads the content and returns its cid

Tip: Every operation shares the same connection config keys — baseUrl/authMode/credentialID for the Kubo daemon, plus clusterBaseUrl/clusterAuthMode/destinationCredentialID for the handful of operations that talk to an IPFS Cluster daemon. Learn the pattern once on Connecting and every operation below follows it.

Pages in This Guide

Configuration

Connection config keys, credentials, and registration.

Connecting

Kubo vs. Cluster, auth modes, SSRF policy, and safety guards.

Content Operations

add, cat, get, ls, refs — upload and retrieve content-addressed data.

Pin Operations

11 operations: local pinning plus remote pinning-service management.

Files (MFS) Operations

9 operations on IPFS's Mutable File System.

Dag Operations

6 operations on the IPLD merkle-DAG layer.

Block Operations

4 operations on the raw block layer beneath DAG.

Name (IPNS) Operations

publish and resolve — mutable pointers to immutable content.

Key Operations

5 operations managing the IPNS keys used to sign publishes.

Swarm Operations

5 operations for peer connectivity and addresses.

Bootstrap Operations

3 operations managing the daemon's bootstrap peer list.

System Operations

id, version, resolve — node identity and version info.

Repo Operations

stat and garbageCollect — local repository maintenance.

Cluster Operations

4 operations against the separate IPFS Cluster REST API.

Storage Operations

2 composite operations combining Kubo and Cluster calls.

Input & Output

The shared output contract, binary I/O, and how errors surface.

Examples

Worked workflow patterns using this node.

Troubleshooting

Common errors and how to fix them.

Roadmap

Known deferrals and what's coming next.

Core Concepts

Two Daemons, One Node

Most operations talk to a Kubo daemon's RPC API (baseUrl) — the reference IPFS implementation. A smaller set talks to a separate IPFS Cluster daemon's REST API (clusterBaseUrl) for coordinated pinning across multiple nodes. Two storage operations are composites that call both.

Resources

Operations are grouped by resource, matching Kubo's and Cluster's own API boundaries:

content — add, cat, get, ls, refs (content-addressed data)
pin — local pin lifecycle plus remote pinning-service management
files — the Mutable File System (MFS), a virtual filesystem over IPFS
dag — the IPLD merkle-DAG layer
block — the raw block layer beneath DAG
name — IPNS publish/resolve
key — IPNS key management
swarm — peer connectivity
bootstrap — bootstrap peer list
system — node identity/version
repo — local repository maintenance
cluster — IPFS Cluster coordinated pinning
storage — composite upload+pin / verify-integrity operations

Output Contract

Every operation writes an outputData object with status/resource/operation (list-shaped operations also add count) and an items array. Errors route to the error output port. See Input & Output.

Operation Summary

Resource	Operations	Guide Page
`content`	add, cat, get, ls, refs	Content Operations
`pin`	add, list, remove, update, verify, remoteAdd, remoteList, remoteRemove, remoteServiceAdd, remoteServiceList, remoteServiceRemove	Pin Operations
`files`	copy, flush, list, makeDirectory, move, read, remove, stat, write	Files (MFS) Operations
`dag`	get, put, resolve, import, export, stat	Dag Operations
`block`	get, put, remove, stat	Block Operations
`name`	publish, resolve	Name (IPNS) Operations
`key`	generate, list, remove, rename, import	Key Operations
`swarm`	peers, connect, disconnect, addrs, addrsLocal	Swarm Operations
`bootstrap`	add, list, remove	Bootstrap Operations
`system`	id, version, resolve	System Operations
`repo`	stat, garbageCollect	Repo Operations
`cluster`	add, pinStatus, unpin, listPeers	Cluster Operations
`storage`	uploadAndPin, verifyIntegrity	Storage Operations