> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allium.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> REST API endpoints for managing Beam pipelines programmatically.

Allium Beam lets you create custom-filtered, real-time blockchain data pipelines. Pick a chain and entity from Allium's Datastreams, apply filters and JavaScript transforms, and deliver the processed data to Kafka, SNS, your own Kafka cluster, or a webhook — all without building infrastructure.

## Authentication

Base URL: `https://api.allium.so/api/v1/beam`

All endpoints require an API key passed via the `X-API-Key` header:

```bash theme={null}
curl -X GET https://api.allium.so/api/v1/beam \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
```

Get your API key from [app.allium.so/settings/api-keys](https://app.allium.so/settings/api-keys).

## Getting a pipeline running

<Steps>
  <Step title="Create a pipeline config">
    Use [Create pipeline](/beam/api-reference/configs/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 `uid`s you'll need for the next steps.
  </Step>

  <Step title="Deploy">
    Call [Deploy](/beam/api-reference/deployment/deploy) to spin up workers, create topics, and start streaming data. Deployment takes a few seconds.
  </Step>

  <Step title="Monitor">
    Check [Deployment stats](/beam/api-reference/deployment/stats) for worker health and [Deployment metrics](/beam/api-reference/deployment/metrics) for throughput, latency, and error rates.
  </Step>

  <Step title="Iterate">
    Update your config or transforms at any time, then redeploy — it's idempotent with zero downtime. Filter value changes take effect immediately without a redeploy.
  </Step>
</Steps>

## Endpoint groups

<CardGroup cols={2}>
  <Card title="Configs" icon="gear" href="/beam/api-reference/configs/list-pipelines">
    Create, read, update, and delete pipeline configurations.
  </Card>

  <Card title="Deployment" icon="rocket" href="/beam/api-reference/deployment/deploy">
    Deploy, teardown, and monitor running pipelines.
  </Card>

  <Card title="Transforms" icon="wand-magic-sparkles" href="/beam/api-reference/transforms/update-transform">
    Update transforms on a deployed pipeline.
  </Card>

  <Card title="Filter Values" icon="filter" href="/beam/api-reference/filter-values/list-filter-values">
    Manage values in set filter transforms (supports 10M+ values).
  </Card>
</CardGroup>

See the [Configuration reference](/beam/api-reference/configuration) for full details on the `BeamConfig` schema (sources, transforms, sinks, and field types).