Authentication
Base URL:https://api.allium.so/api/v1/beam
All endpoints require an API key passed via the X-API-Key header:
Getting a pipeline running
Create a pipeline config
Use Create pipeline to define your source (chain + entity), transforms (set filter and/or JavaScript), and sinks (where data is delivered). The response includes the generated pipeline
id and transform uids you’ll need for the next steps.Deploy
Call Deploy to spin up workers, create topics, and start streaming data. Deployment takes a few seconds.
Monitor
Check Deployment stats for worker health and Deployment metrics for throughput, latency, and error rates.
Endpoint groups
Configs
Create, read, update, and delete pipeline configurations.
Deployment
Deploy, teardown, and monitor running pipelines.
Transforms
Update transforms on a deployed pipeline.
Filter Values
Manage values in set filter transforms (supports 10M+ values).
BeamConfig schema (sources, transforms, sinks, and field types).