# Beam Documentation


- **Start here**
- [What is Beam?](/docs/intro): Learn how Beam coordinates measurable, verifiable, and incentivized data transfer.
- [Architecture](/docs/architecture): Understand how clients, BeamCore, orchestrators, workers, and validators connect, and where your data travels.

- **Build with Beam**
- [Build with Beam](/docs/clients): Start here as a client: send transfers with the SDK or Studio, connect your storage, and pay for what you move.
- [Developer Quickstart](/docs/developer-quickstart): Create your Beam account and an API key, install Beam Studio and the Beam CLI, and send your first transfer.
- [Beam SDK](/docs/sdk): Create and manage transfers from Python, TypeScript, Go, or Rust.
- [Beam CLI](/docs/cli): Install the Beam CLI, sign in, and manage your account, your machines, and Rooms from a terminal.
- [Room Webhook Members](/docs/room-webhooks): Let any HTTPS endpoint take part in a Beam Room through a member's agent: set it up, verify its signed requests, reply, and know what its host can read.
- [Agent Data Sales](/docs/data-sales): Sell or buy a dataset between AI agents that do not trust each other: a Beam Room delivers it encrypted, and an escrow contract on Bittensor EVM pays the seller only for the bytes it committed to.
- [Beam Studio](/docs/studio): Beam Studio is a self-hosted app for visual data transfer workflows: move data between S3, R2 and HTTP endpoints on demand, on a schedule or from a webhook.
- [Your First Studio Workflow](/docs/studio-first-workflow): Go from a fresh Beam Studio install to a completed, verified transfer between two buckets.
- [How Transfers Work](/docs/transfers): Follow a Beam transfer from creation to verified completion.
- Connectors
  - [Connectors](/docs/connectors): Integrate Beam with supported object storage and HTTP providers.
  - [Amazon S3](/docs/connectors/s3): Configure Amazon S3 and S3-compatible providers for Beam transfers.
  - [Cloudflare R2](/docs/connectors/r2): Configure Cloudflare R2 as a source or destination for Beam transfers.
  - [Box](/docs/connectors/box): Copy files out of Box, and into Box folders, from Studio or the TypeScript and Python SDKs.
  - [Google Cloud Storage](/docs/connectors/gcs): Use Google Cloud Storage as a source or destination for Beam transfers through its S3-compatible XML API and an HMAC key.
  - [HTTP Connector](/docs/connectors/http): Configure direct HTTP sources and destinations for Beam transfers.
  - [Hippius](/docs/connectors/hippius): Configure Hippius storage as a source or destination for Beam transfers.
- Integrations
  - [Integrations](/docs/integrations): Use Beam from other platforms: start transfers from their workflows and bring evidence of finished transfers back to them.
  - [Bittensor EVM](/docs/integrations/bittensor-evm): Get receipts of your finished Beam transfers and Room deliveries recorded on Bittensor EVM, where any smart contract can read them, for 1 credit each.
  - [Chainlink CRE](/docs/integrations/chainlink-cre): Start Beam transfers from a smart contract through the Chainlink Runtime Environment, and record DON-attested Beam reports of finished transfers onchain.
  - [Zapier](/docs/integrations/zapier): Run an action in any app Zapier connects to from a Beam Studio workflow, and start a Zap when a workflow reaches a step.
- [Billing & Payments](/docs/billing): What Beam actions cost, and how Beam credits are paid for by card, TAO, or Beam subnet alpha.
- [Account Management API](/docs/management-api): Create, freeze, rotate and revoke API keys, and read credits, usage and auto top-up settings, without a browser.

- **API reference**
- [API Reference](/docs/api-reference): Read your transfers over HTTP: the BeamCore base URL, authentication, and the transfer endpoints.
- auth
  - [/auth/me](/docs/api/auth/auth/me/get)
- transfers
  - [/transfers](/docs/api/transfers/transfers/get)
  - [/transfers/{transfer_id}](/docs/api/transfers/transfers/transfer_id/get)
  - [/transfers/{transfer_id}/receipt](/docs/api/transfers/transfers/transfer_id/receipt/get)
- Telemetry
  - [Terminal transfer summaries; kind filters participantId.](/docs/api/telemetry/transfers)
  - [One terminal transfer summary.](/docs/api/telemetry/transfer)
  - [Closed participant summaries.](/docs/api/telemetry/participants)
  - [One closed participant summary, by ID or hotkey.](/docs/api/telemetry/participant)
  - [Closed network summary: bandwidth, capacity, providers and weights.](/docs/api/telemetry/network)
  - [Closed participant snapshot versions.](/docs/api/telemetry/participantHistory)
  - [Closed network snapshot versions.](/docs/api/telemetry/networkHistory)
  - [Participant performance for a terminal transfer. Default kind is worker.](/docs/api/telemetry/performance)
  - [Expanded transfer integrity evidence or participant transfer/scoring proof summaries.](/docs/api/telemetry/expandedAudit)
  - [Finished task evidence for published terminal transfers.](/docs/api/telemetry/tasks)
  - [Sanitized events for a terminal transfer; supports replay.](/docs/api/telemetry/events)
  - [Assignment evidence for a terminal transfer.](/docs/api/telemetry/assignments)
  - [Complete published epoch sets](/docs/api/telemetry/epochs)
  - [Frozen global orchestrator ranks, workload scoring and allowance state](/docs/api/telemetry/epochOrchestrators)
  - [Published sell allowance of a miner hotkey.](/docs/api/telemetry/paidSellAllowance)
- Realtime telemetry
  - [Realtime: terminal transfer summaries; kind filters participantId.](/docs/api/realtime-telemetry/realtimeTransfers)
  - [Realtime: one terminal transfer summary.](/docs/api/realtime-telemetry/realtimeTransfer)
  - [Realtime: closed participant summaries.](/docs/api/realtime-telemetry/realtimeParticipants)
  - [Realtime: one closed participant summary, by ID or hotkey.](/docs/api/realtime-telemetry/realtimeParticipant)
  - [Realtime: closed network summary: bandwidth, capacity, providers and weights.](/docs/api/realtime-telemetry/realtimeNetwork)
  - [Realtime: closed participant snapshot versions.](/docs/api/realtime-telemetry/realtimeParticipantHistory)
  - [Realtime: closed network snapshot versions.](/docs/api/realtime-telemetry/realtimeNetworkHistory)
  - [Realtime: participant performance for a terminal transfer. Default kind is worker.](/docs/api/realtime-telemetry/realtimePerformance)
  - [Realtime: expanded transfer integrity evidence or participant transfer/scoring proof summaries.](/docs/api/realtime-telemetry/realtimeExpandedAudit)
  - [Realtime: finished task evidence for published terminal transfers.](/docs/api/realtime-telemetry/realtimeTasks)
  - [Realtime: sanitized events for a terminal transfer; supports replay.](/docs/api/realtime-telemetry/realtimeEvents)
  - [Realtime: assignment evidence for a terminal transfer.](/docs/api/realtime-telemetry/realtimeAssignments)
  - [Realtime: complete published epoch sets](/docs/api/realtime-telemetry/realtimeEpochs)
  - [Realtime: frozen global orchestrator ranks, workload scoring and allowance state](/docs/api/realtime-telemetry/realtimeEpochOrchestrators)
- Audit
  - [Integrity evidence, failed attempts and recovery charges for a known transfer; no discovery.](/docs/api/audit/publicTransfer)
  - [Initial captured assignment inputs and allocations for a known transfer.](/docs/api/audit/publicPlan)
  - [Closed scoring inputs, result and formula reference for a known epoch and participant.](/docs/api/audit/scoring)
  - [Sell allowance state of a miner hotkey.](/docs/api/audit/sellAllowance)

- **For AI agents**
- [Beam for Agents](/docs/agent): A guide for AI agents: what each Beam capability does, how to combine capabilities into solutions for an owner, where data and trust go, what Beam costs against the current setup, and when it is the right tool.