API Documentation

Build integrations with Beam — interactive API reference is served from beamcore.b1m.ai

Participant guide (BeamCore dashboard) · Examples below use your selected app network endpoint.

BeamCore docs (Swagger):beamcore.b1m.ai/docs

App network API URL:http://localhost:8000

ReDoc

Quick Links

Participant guide Swagger UI ReDoc OpenAPI JSON GitHub

Getting Started

Base URL

http://localhost:8000

Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Example Request

curl -X POST http://localhost:8000/transfers/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sender_hotkey": "5F...",
    "total_size": 1048576,
    "filename": "example.zip",
    "tier": "STANDARD"
  }'

File Transfers

Send and receive files

POST/transfers/createCreate a new transfer

POST/transfers/{id}/chunksSubmit a chunk

POST/transfers/{id}/finalizeFinalize transfer

GET/transfers/{id}Get transfer status

DELETE/transfers/{id}Cancel transfer

GET/transfers/tiersGet available tiers

View full documentation in Swagger UI →

SDKs & Libraries

JavaScript/TypeScript

npm install @datafabric/sdk

Python

pip install datafabric

go get github.com/datafabric/datafabric-go

Rust

cargo add datafabric

Rate Limits

Tier	Requests/min	Concurrent Transfers	Max File Size
Free	60	3	5 GB
Pro	300	10	50 GB
Enterprise	Unlimited	Unlimited	Unlimited