Build with Beam
Start here as a client: send transfers with the SDK or Studio, connect your storage, and pay for what you move.
You are a client if you want Beam to move your data. You describe intent — these bytes, from here, to there — and the network competes to deliver it. You never talk to orchestrators or workers directly, and you do not need a Bittensor wallet.
This page is the map. Everything a client needs falls into two halves: implementation guides that get bytes moving, and reference material you return to once they are.
Set up
Create your account at console.b1m.ai, then three things, in this order. The Developer Quickstart runs through all of it end to end.
| # | Step | Where |
|---|---|---|
| 1 | Add credits and create an API key | console.b1m.ai |
| 2 | Install Beam Studio — the application you build and run data movement in | curl -fsSL https://cdn.b1m.ai/studio/install.sh | sudo sh |
| 3 | Install the Beam CLI — your account, your machines, and Rooms from a terminal | curl -fsSL https://cdn.b1m.ai/cli/install.sh | sh, or on Windows irm https://cdn.b1m.ai/cli/install.ps1 | iex |
Studio is self-hosted, so step 2 is a real install on a Linux host, not a signup. It is how most teams operate Beam day to day — see Beam Studio for requirements and the connect flow.
Implementation
Reference
The sidebar lists the client surface under API reference — auth and transfers.
What you need before you start
| Requirement | Where it comes from |
|---|---|
| A Beam account | console.b1m.ai → Create an account. |
| An organization with credits | console.b1m.ai → Settings → Billing. See Billing & Payments. |
| An API key | console.b1m.ai → API Keys. |
| A reachable source | An object in supported storage, or an HTTPS URL the workers can read. See Connectors. |
| A reachable destination | Storage or an HTTPS endpoint the workers can write to. With object storage, the SDK reads the size from the source; a plain HTTP transfer needs the size up front. |
The Developer Quickstart walks through all of it in order, from creating your account to installing Studio and the CLI.
Choosing an interface
| Interface | Use it when |
|---|---|
| SDK | A transfer is one step inside an application you maintain. Chunking, distribution, and completion polling are handled for you. Available for Python, TypeScript, Go, and Rust. |
| Beam Studio | You want to run a transfer without writing code, or the work is a pipeline rather than a single transfer — several steps, conditions, retries, or a schedule — and you want to see runs rather than tail logs. |
| HTTP API | You need to read the status of your transfers from any language. It does not create transfers. |
The SDK and Studio reach the same network and spend the same organization credits, and every transfer they create shows up together in the Console. Pick per job, not once: using the SDK in your service and Studio for scheduled syncs is normal.
The Beam CLI (beam) manages your account, your machines, and
Rooms; it does not create transfers.
Source code
The SDK is open source, at
Beam-Network/beam-sdk-public.
Next steps
- Developer Quickstart — Send your first transfer.
- Beam SDK — Create transfers from code.
- Beam Studio — Build the pipeline around the transfer.
- Connectors — Configure your storage provider.
- API Reference — Read your transfers over HTTP.
- Architecture — What sits behind the API, if you are curious.