# Beam

## Docs

- [Building AI Agents](https://docs.beam.cloud/v2/agents/introduction.md): Beam is launching a new type of agent framework that is stateful and has concurrency built-in.
- [Example: Research Assistant](https://docs.beam.cloud/v2/agents/synchronization.md)
- [Mounting S3 Buckets](https://docs.beam.cloud/v2/data/external-storage.md): Attach S3 buckets to your apps
- [Ephemeral Files and Images](https://docs.beam.cloud/v2/data/output.md): Storing ephemeral files for images, audio files, and more.
- [Distributed Storage Volumes](https://docs.beam.cloud/v2/data/volume.md): Attach distributed storage volumes to your apps
- [Keeping Containers Warm](https://docs.beam.cloud/v2/endpoint/keep-warm.md): Control how long your apps stay running before shutting down.
- [Pre-Loading Models](https://docs.beam.cloud/v2/endpoint/loaders.md): This guide shows how you can optimize performance by pre-loading models when your container first starts.
- [Creating a Web Endpoint](https://docs.beam.cloud/v2/endpoint/overview.md): Deploying and invoking web endpoints on Beam
- [Realtime and Streaming](https://docs.beam.cloud/v2/endpoint/realtime.md)
- [Sending File Payloads](https://docs.beam.cloud/v2/endpoint/sending-file-payloads.md): Sending file payloads to Endpoints and Web Servers
- [Versioning](https://docs.beam.cloud/v2/endpoint/versioning.md)
- [Hosting a Web Server](https://docs.beam.cloud/v2/endpoint/web-server.md): Deploying web servers on Beam
- [Container Images](https://docs.beam.cloud/v2/environment/custom-images.md)
- [Custom Registries](https://docs.beam.cloud/v2/environment/custom-registries.md)
- [GPU Acceleration](https://docs.beam.cloud/v2/environment/gpu.md)
- [Working in Jupyter Notebooks](https://docs.beam.cloud/v2/environment/jupyter-notebook.md)
- [Remote vs. Local Environment](https://docs.beam.cloud/v2/environment/remote-versus-local.md)
- [CPU and RAM](https://docs.beam.cloud/v2/environment/resources.md)
- [Storing Secrets](https://docs.beam.cloud/v2/environment/secrets.md): How to store secrets and environment variables in Beam
- [Serverless ComfyUI](https://docs.beam.cloud/v2/examples/comfy-ui.md)
- [Chat with DeepSeek R1](https://docs.beam.cloud/v2/examples/deepseek-r1.md)
- [Fine-tuning Gemma with LoRA](https://docs.beam.cloud/v2/examples/gemma-fine-tune.md)
- [Hugging Face Models](https://docs.beam.cloud/v2/examples/inference.md): A beginner's guide to running highly performant inference workloads on Beam.
- [LLaMA 3.1 8B](https://docs.beam.cloud/v2/examples/llama3.md)
- [Stable Diffusion with LoRAs](https://docs.beam.cloud/v2/examples/lora.md)
- [Text-to-Video with Mochi](https://docs.beam.cloud/v2/examples/mochi-1.md)
- [Parler TTS](https://docs.beam.cloud/v2/examples/parler-tts.md)
- [Qwen2.5-7B with SGLang](https://docs.beam.cloud/v2/examples/sglang.md)
- [Running Streamlit Apps](https://docs.beam.cloud/v2/examples/streamlit.md)
- [Fine-Tuning Meta Llama 3.1 8B with Unsloth](https://docs.beam.cloud/v2/examples/unsloth.md)
- [Run an OpenAI-Compatible vLLM Server](https://docs.beam.cloud/v2/examples/vllm.md)
- [Web Scraping with Beam Functions](https://docs.beam.cloud/v2/examples/web-scraping.md)
- [Faster Whisper](https://docs.beam.cloud/v2/examples/whisper.md)
- [Zonos](https://docs.beam.cloud/v2/examples/zonos.md)
- [Distributed Maps](https://docs.beam.cloud/v2/function/maps.md): Using Beam's distributed Map
- [Queues](https://docs.beam.cloud/v2/function/queues.md): Using Beam's distributed Queue to coordinate between tasks
- [Running Functions Remotely](https://docs.beam.cloud/v2/function/running-functions.md): A short guide on using Beam to run one-off functions in the cloud
- [Scheduled Jobs](https://docs.beam.cloud/v2/function/scheduled-job.md): How to run workloads on a schedule.
- [Core Concepts](https://docs.beam.cloud/v2/getting-started/core-concepts.md)
- [Installation](https://docs.beam.cloud/v2/getting-started/installation.md)
- [Introduction](https://docs.beam.cloud/v2/getting-started/introduction.md)
- [Quickstart](https://docs.beam.cloud/v2/getting-started/quickstart.md)
- [Networking](https://docs.beam.cloud/v2/pod/networking.md)
- [Host a Web Service](https://docs.beam.cloud/v2/pod/web-service.md)
- [Reference](https://docs.beam.cloud/v2/reference/api.md)
- [List Containers/Pods/Sandboxes](https://docs.beam.cloud/v2/reference/api-docs/gatewayservice/get-containers.md): List containers/pods/sandboxes associated with your workspace.
- [Stop Container/Pod/Sandbox](https://docs.beam.cloud/v2/reference/api-docs/gatewayservice/post-containers-stop.md): Stop a running container/pod/sandbox by its ID.
- [Create a Pod](https://docs.beam.cloud/v2/reference/api-docs/podservice/post-pods.md): Create a new pod and return its identifiers and initial state. Provide exactly one of `stubId` or `checkpointId`.
- [Cancel Task](https://docs.beam.cloud/v2/reference/api-docs/tasks/tasks-cancel.md)
- [Get Task Status](https://docs.beam.cloud/v2/reference/api-docs/tasks/tasks-status.md)
- [CLI Reference](https://docs.beam.cloud/v2/reference/cli.md)
- [Python SDK Reference](https://docs.beam.cloud/v2/reference/py-sdk.md)
- [TypeScript SDK Reference - Beta](https://docs.beam.cloud/v2/reference/ts-sdk.md)
- [FAQ](https://docs.beam.cloud/v2/resources/faq.md): This is an ongoing list of issues people sometimes encounter while using Beam. If you're having an issue, check this list first.
- [Pricing and Billing](https://docs.beam.cloud/v2/resources/pricing-and-billing.md)
- [Configuration](https://docs.beam.cloud/v2/sandbox/configuration.md): Learn how to configure and customize your sandbox environment
- [File System Operations](https://docs.beam.cloud/v2/sandbox/filesystem.md): Upload, download, and manage files within your sandbox environment
- [Networking](https://docs.beam.cloud/v2/sandbox/networking.md): Expose ports dynamically for services running inside your sandbox
- [Overview](https://docs.beam.cloud/v2/sandbox/overview.md): Run anything in secure code execution environments
- [Process Management](https://docs.beam.cloud/v2/sandbox/processes.md): Execute code and commands with real-time output streaming in your sandbox
- [Snapshots](https://docs.beam.cloud/v2/sandbox/snapshots.md)
- [Scaling Out](https://docs.beam.cloud/v2/scaling/concurrency.md)
- [Concurrent Inputs](https://docs.beam.cloud/v2/scaling/concurrent-inputs.md)
- [Parallelizing Functions](https://docs.beam.cloud/v2/scaling/parallelizing-functions.md): How to parallelize your functions
- [Privacy Policy](https://docs.beam.cloud/v2/security/privacy-policy.md)
- [Terms and Conditions](https://docs.beam.cloud/v2/security/terms-and-conditions.md): These are the terms the Beam Platform is provided under.
- [Amazon Web Services](https://docs.beam.cloud/v2/self-hosting/aws.md): Learn how to deploy Beam OSS (Beta9) to Amazon EKS.
- [Local Machine](https://docs.beam.cloud/v2/self-hosting/local-machine.md): Learn how to deploy Beam OSS (Beta9) to your local machine.
- [Overview](https://docs.beam.cloud/v2/self-hosting/overview.md): Beta9 is the open source project that powers Beam
- [Querying Task Status](https://docs.beam.cloud/v2/task-queue/query-status.md)
- [Running Async Tasks](https://docs.beam.cloud/v2/task-queue/running-tasks.md)
- [Task Callbacks](https://docs.beam.cloud/v2/topics/callbacks.md): Setup a callback to your server when a task finishes running
- [Integrate into CI/CD](https://docs.beam.cloud/v2/topics/ci.md): You can integrate Beam into an existing CI/CD process to deploy your code automatically.
- [Cold Start Performance](https://docs.beam.cloud/v2/topics/cold-start.md)
- [Runtime Variables](https://docs.beam.cloud/v2/topics/context.md): Accessing information about the runtime while running tasks
- [Public Endpoints](https://docs.beam.cloud/v2/topics/public-endpoints.md): Deploying public web endpoints on Beam
- [Send Events Between Apps](https://docs.beam.cloud/v2/topics/signal.md)
- [Timeouts and Retries](https://docs.beam.cloud/v2/topics/timeouts-and-retries.md)

## OpenAPI Specs

- [pods.swagger](https://docs.beam.cloud/v2/reference/api-docs/pods.swagger.json)
- [gateway.swagger](https://docs.beam.cloud/v2/reference/api-docs/gateway.swagger.json)
- [package](https://docs.beam.cloud/package.json)
- [package-lock](https://docs.beam.cloud/package-lock.json)
- [settings](https://docs.beam.cloud/.vscode/settings.json)

## Optional

- [Slack Community](https://join.slack.com/t/beam-cloud/shared_invite/zt-3enuvj3r7-OeAzVPYvyqQHy9avNrLL0w)
- [Github](https://github.com/beam-cloud/beta9)
- [Twitter](https://twitter.com/beam_cloud)