Skip to content

Clients Orchestrators Workers API Reference Beam

Start here

What is Beam?Architecture

Clients: build

Build with Beam Developer Quickstart Beam CLI Beam Studio How Transfers Work

Connectors Amazon S3 Cloudflare R2 Google Cloud Storage HTTP Connector Hippius

Billing & Payments

Clients: API reference

/auth/challenge POST /auth/verify POST /auth/me GET /auth/keys GET /auth/keys POST /auth/keys/{key_prefix} DELETE /auth/keys/worker POST

/clients/register POST /clients/{client_id} GET /clients GET

/destinations GET /destinations POST /destinations/{destination_id} GET /destinations/{destination_id} DELETE /destinations/{destination_id} PUT

/transfers GET /transfers/{transfer_id} GET

/webhooks/sentry POST

/jobs/{job_id} GET /jobs GET

/status/orchestrator-relays GET

Orchestrators

Orchestrators PRISM Scoring Weights Recovery Timeouts

Orchestrators: API reference

/orchestrators/pending-transfers GET /orchestrators/workers GET /orchestrators/prism-scores/{orch_uid} GET /orchestrators/{orchestrator_id} GET /orchestrators/ready PATCH /orchestrators/{orchestrator_id}/workers GET /orchestrators/{orchestrator_id}/workers/{worker_id} PATCH /orchestrators/{orchestrator_id}/pending-transfers GET /orchestrators/{orchestrator_id}/assignments GET /orchestrators/{orchestrator_id}/tasks GET /orchestrators/register POST /orchestrators/history DELETE

/routing/orchestrators GET /routing/worker-capacity GET /routing/pools GET

Workers

Workers: API reference

/workers/register POST /workers/{worker_id} GET

Orchestrator & worker protocol

Participant Control Protocol

Validators

Validators: API reference

/validators/heartbeat POST /validators/scores/submit POST /validators/weights/proof POST /validators/weights/{epoch} GET /validators/orchestrators GET

/Validator/epoch-summary/latest-epoch GET

Platform

/config/uid-ranges GET

/docs/ GET /docs/static/index.html GET /docs/static/swagger-initializer.js GET /docs/json GET /docs/yaml GET /docs/static/{*} GET /docs/static/{*} HEAD

/openapi.json GET

clients

/clients

GET

/clients

Authorization

apiKey

X-Api-Key<token>

In: header

Response Body

curl -X GET "https://example.com/clients"

Empty

Beam

Decentralized distributed bandwidth infrastructure.

/clients/{client_id} GET

Previous Page

/destinations GET

Next Page