walrus-console-quickstart

Everything you need to start building on the Console API.

Console runs on Sui mainnet.

---

What is Console?

Walrus Console is a developer-friendly web app and REST API for managing files on Walrus. Store, organize, and access data through familiar workflows, backed by durable and verifiable infrastructure. Files live in buckets, encrypted client-side with Seal and stored on Walrus — Console only ever holds ciphertext, never your plaintext or decryption keys. Auth is a simple Authorization: Bearer hbr_… API key minted in the web app; gas for on-chain steps is sponsored for you via Enoki.

If you can call a REST endpoint, you can build on Console.

Note. Building directly on the REST API today means you orchestrate the client-side encryption yourself — the reserve → sign → finalize and Seal encrypt/decrypt steps you'll see in this quickstart. A TypeScript SDK to streamline building on Console (this orchestration included) is on the roadmap.

Who this repo is for

• Any developer who wants the curated API surface (OpenAPI + Postman) and a copy-paste quickstart to integrate Console.

What's in here

Path	What it is
QUICKSTART.md	"Hello world" tour — sign up, create an encrypted bucket, upload + download a file. Start here.
openapi.yaml	Curated OpenAPI spec — the public, Bearer-only API surface (19 operations on 14 paths).
postman/	Ready-to-import Postman collection + environment for poking the API by hand.
app/	TypeScript reference integration: curl walkthrough, helper CLIs, automated round-trip, Hono backend.
AGENTS.md	Repo-level guidance for AI coding assistants (loaded by CLAUDE.md).

Quickstart

Prerequisites: a way to sign in to the web app to mint an API key — Google or Apple (via zkLogin) — plus curl/Postman or Node.js. See QUICKSTART.md for exact versions.

1. Sign in at console.walrus.xyz — Google or Apple (via zkLogin). Your account and a Personal Space are provisioned automatically.
2. Integrations → Create API Key (top-right). Choose API key: the other type, Management API key, only mints further keys and cannot upload, download or manage assets. Pick Read & Write (read_write) and copy both secrets the reveal screen shows, the hbr_… API key and the suiprivkey1… service private key. They are shown once.
3. Follow QUICKSTART.md to create a Seal-encrypted bucket and round-trip a file.

Poke the API with Postman

Import the collection and one environment from postman/ into Postman Desktop:

• postman/console.postman_collection.json
• postman/console.postman_environment.json

Paste your hbr_… key into the bearerToken environment variable. baseUrl is already set to https://api.console.walrus.xyz.

Hosted docs

The same docs are served live from the API:

• OpenAPI viewer (Scalar): https://api.console.walrus.xyz/docs/openapi
• OpenAPI spec (raw): https://api.console.walrus.xyz/openapi.yaml
• Docs index: https://api.console.walrus.xyz/docs

Questions / issues

Open an issue: github.com/MystenLabs/walrus-console-quickstart/issues/new/choose and pick Bug, Feature request or Documentation. For a question, start with the Console FAQ. Report security issues by email to security@mystenlabs.com, not on GitHub.

License

See LICENSE.