Skip to content
Beam Docs
Api

Overview

The BeamCore endpoints a client calls, with a request panel and samples for each.

These pages cover the BeamCore endpoints a client calls over HTTP: checking a key and reading transfers, plus the supported delayed and realtime telemetry and audit APIs. Transfers are created with an SDK or Beam Studio, not over HTTP.

Paid telemetry uses an organization key with telemetry:read and prepaid credits. Standard, history and detail responses cost 0.001, 0.002 and 0.004 credit ($0.50, $1 and $2 per 1,000 at $0.50 per credit); successful empty pages count, errors and 304 responses do not. Responses are metered exactly and charged in aggregate: whole hundredths of a credit as they accrue, and the remainder rounded up once per month. Epoch lists and their orchestrator pages use the history tier. Observations publish one subnet epoch after capture, with a 60-minute fallback when the chain clock is unavailable. Each read is pinned to a published generation: keep cursor filters to page the same version, and continue within an hour. Responses carry an ETag; send If-None-Match to revalidate, and an unchanged payload answers 304 without a charge.

Realtime telemetry mirrors every paid route under /v1/telemetry/realtime/ with current evidence, including transfers in progress; work awaiting verification is reported separately. Epoch reads return complete sets of closed epochs only. It needs the separate telemetry:realtime:read grant, which telemetry:read never implies, and costs twice the snapshot price: 0.002, 0.004 and 0.008 credit ($1, $2 and $4 per 1,000). Realtime has its own quota with the same limits, a realtime cursor continues for 9 minutes, and X-Beam-Telemetry-Lag-Ms reports how far the data a read returns trails committed evidence. While projections are not ready or not current, realtime reads answer 503 with Retry-After.

curl 'https://api.b1m.ai/v1/telemetry/epochs?limit=20' -H 'X-Api-Key: YOUR_ORGANIZATION_KEY'
curl 'https://api.b1m.ai/v1/telemetry/epochs/123/orchestrators?limit=100' -H 'X-Api-Key: YOUR_ORGANIZATION_KEY'

Use the returned epoch number and nextCursor in subsequent reads. Free audit routes expose only the requested subject's published proof; they do not provide fleet browsing.

Each page has a request panel that builds a sample in cURL, JavaScript, Go, Python, Java, C#, and Rust. The query parameters and response fields are described in API Reference.

Samples omit the key itself until you enter one. They mirror the request panel above them, so an authenticated operation shows the header with an empty value — -H "X-Api-Key: " — and copying it as-is returns 401 authentication required. Enter a key in the panel and the samples fill it in across every language, or paste your own value into the header.

Authenticated operations use the X-Api-Key request header. Enter only a test or scoped key in an interactive client; this documentation never stores or embeds API keys.

Decentralized distributed bandwidth infrastructure.