Build with Beam
Start here as a client: send transfers with the SDK, CLI, Studio, or HTTP API, 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.
Implementation
Reference
The sidebar lists the client surface under Clients: API reference — auth, clients, destinations, transfers, webhooks, jobs, and status. Orchestrator, worker, and validator endpoints are the participant side of the network; they live under their own roles and are not callable with a client API key.
What you need before you start
| Requirement | Where it comes from |
|---|---|
| An organization with credits | Console → Settings → Billing. See Billing & Payments. |
| An API key | Console → API Keys. Keys are environment-specific. |
| A reachable source | Signed URL or endpoint the workers can read. See Connectors. |
| A reachable destination | Endpoint the workers can write to, with the exact byte size known up front. |
Use a key from the same environment as your transfer. A development key against production, or the reverse, fails authentication rather than falling back.
Choosing an interface
| Interface | Use it when |
|---|---|
Python SDK (beam-network-sdk) | A transfer is one step inside an application you maintain. Chunking, distribution, and completion polling are handled for you. |
| Beam Studio | 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 are not on Python, or you need to drive the transfer lifecycle yourself. |
| CLI | You want to move data from a terminal without writing code, or script it from a shell. |
All four 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.
Next steps
- Developer Quickstart — Send your first transfer.
- Beam CLI — Move data from a terminal.
- Beam Studio — Build the pipeline around the transfer.
- Connectors — Configure your storage provider.
- API Reference — Authentication and base URLs.
- Architecture — What sits behind the API, if you are curious.