Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Sign in, run a Python function, and deploy a web API
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade beam-client
beam login
beam whoami to check your workspace.
app.py:
from beam import function
@function(cpu=1, memory="1Gi")
def square(x: int):
return {"result": x**2}
if __name__ == "__main__":
print(square.remote(x=12))
python app.py
{'result': 144}.
app.py with:
from beam import endpoint
@endpoint(name="quickstart", cpu=1, memory="1Gi")
def predict(x: int = 12):
return {"result": x**2}
beam deploy app.py:predict
beam deployment list
beam deployment wait YOUR_DEPLOYMENT_ID --timeout 300
export BEAM_ENDPOINT_URL='YOUR_DEPLOYMENT_URL'
# Set BEAM_TOKEN through your shell or secret manager.
curl -X POST "$BEAM_ENDPOINT_URL" \
-H "Authorization: Bearer $BEAM_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"x": 12}'
{"result":144}. Use beam logs quickstart --follow to stream logs, or beam deployment stop YOUR_DEPLOYMENT_ID to stop it.
beam setup agent to connect it to your workspace. See agent setup.Was this page helpful?