Your First Studio Workflow

This guide takes a fresh Beam Studio installation to a completed transfer between two object-storage buckets, and shows where to confirm the result in Studio, in the Console, and in the destination bucket.

Before you start, you need:

• A Beam account whose organization has credits. Steps 0 and 1 of the Developer Quickstart cover both.
• A role in that organization that can create API keys and run transfers: owner, admin, or developer.
• A Linux host that meets Studio's requirements.
• Object storage that speaks the S3 API, with an object to copy, a destination bucket, and an access key pair that can read the source and write the destination. See Connectors for the permissions each provider needs.

1. Install Studio

On the host, run the installer:

curl -fsSL https://cdn.b1m.ai/studio/install.sh | sudo sh

If Studio will be reached at a domain rather than on the host itself, set BEAM_STUDIO_PUBLIC_URL first; see Install.

When it finishes, the installer prints the Studio URL and a claim code. Keep the claim code for step 3. To print it again later, run:

sudo beam-updater claim-code

2. Sign in

Open the Studio URL and choose Continue with Beam Auth. Studio shows a short code. Select Open Beam Auth, sign in if prompted, check that the code matches the one Studio shows, and select Approve connection. You can also open auth.b1m.ai/device and enter the code.

Studio has no accounts of its own: you use Studio with your Beam account.

3. Claim your Studio

A new installation serves nobody until it is claimed.

1. Open Settings → Access.
2. Choose the Beam organization that will own this Studio.
3. Enter the claim code and select Claim this Studio.

The first claim wins. A newly claimed Studio is closed: only your organization can use it until you admit others under Settings → Access.

4. Approve the instance key

Right after the claim, Settings → Access asks you to approve an instance key: the Beam API key this Studio uses for your organization.

1. Select Open Beam Auth.
2. Check that the code matches the one Studio shows.
3. Select Create API key.

Beam creates an organization API key for this Studio and hands it to Studio directly. You never copy or paste it. The key is named "Studio: ‹your Studio's host›", both under Credentials in Studio and under API Keys in the Console. New workflows and Beam Transfer steps use it.

If Settings → Access shows "This Studio has no instance key yet", select Create instance key to start the approval.

5. Add your storage credential

1. Open Credentials and select New credentials.
2. Choose Object storage, then your provider, such as Amazon S3, Cloudflare R2, or Wasabi. For any other S3-compatible store, choose Custom, then Custom S3-compatible.
3. Enter a Credential name, the Access key ID, and the Secret access key. Under Advanced options, set what your provider needs: the Region for Amazon S3, the Account ID for Cloudflare R2, or the Endpoint URL for other stores.
4. Select Test connection, then Save.

The credential stays in your Studio.

6. Create the workflow

1. Select Create workflow: the + next to Workflows in the sidebar, or the button on the Workflows page.
2. Enter a Title, and choose the Simple transfer template.
3. Select Create workflow.

The editor opens with a Source endpoint and a Destination endpoint, both started by Trigger manually and both connected to a Beam Transfer step.

7. Point it at your buckets

Double-click Source endpoint:

1. Under Credential, choose the credential from step 5.
2. Under Bucket, choose the source bucket.
3. In the Bucket explorer, select the object to copy.
4. Select Done.

Double-click Destination endpoint and do the same with the destination bucket. In the Bucket explorer, open the folder to write to and select Use this folder, or enter the Object key to write.

8. Check the Beam credential and billing key

Double-click the Beam Transfer step. On Configuration, set Beam credential to the key marked (instance default), "Studio: ‹your Studio's host›", if it is not already selected.

Runs are charged to the workflow's Billing API key, under the workflow's Settings tab, in Execution and billing. A new workflow uses the instance key. You can choose another Beam key there if you have added one under Credentials.

9. Save and run

1. Select Save changes. It stays disabled while the canvas shows issues; fix the marked steps first.
2. Check the estimate next to Run: the credits this run is expected to cost. See Prices.
3. Select Run.

Run starts the saved workflow. Studio opens the run, and its status moves from Queued to Running to Completed.

10. Verify the transfer

• In Studio: the run shows Completed. Its Beam transfer panel shows the Transfer id. Every run of the workflow is listed on its Runs tab.
• In the Console: open Transfers at console.b1m.ai. Find the transfer by its ID, and confirm that it completed and how many credits it used.
• In the destination bucket: the object is there, with the same size as the source.

If something goes wrong

Next steps

• Beam Studio: schedules, triggers, and managing your installation.
• Connectors: storage permissions for each provider.
• How Transfers Work: what happens once a Beam Transfer step starts.
• Billing & Payments: what transfers and workflow runs cost.