Public Endpoints

Deploying public web endpoints on Beam

Creating a Public Endpoint

By default, endpoints are private and require a bearer token to access. You can remove the authentication requirement for endpoints using the authorized=False argument:

auth.py

from beam import endpoint


@endpoint(authorized=False)  # Disable authentication
def create_public_endpoint():

    print("This API can be invoked without an auth token")
    return {"success": "true"}

Invoking a Public Endpoint

A public endpoint’s app URL works without a token:

https://[APP-NAME]-[APP-ID].app.beam.cloud

beam deploy prints this URL with a version suffix such as -v1, which pins that version. Remove the suffix to always call the latest version. See Versioning.

A full request to a public endpoint might look something like this:

curl -X POST \
--compressed 'https://create-public-endpoint-712408b.app.beam.cloud' \
-H 'Content-Type: application/json' \
-d '{}'

You can also view the URL by clicking the Call API button on the deployment detail page in the web dashboard.

Stub ID URLs

Public endpoints can also be called by stub ID, without a token:

https://app.beam.cloud/endpoint/public/[STUB-ID]

Each deploy creates a new stub, so this URL stays tied to the version it came from. It keeps serving that version after you redeploy, and stops working once that version is stopped. Use the app URL if you want requests to follow new deploys.

You can find your Stub ID on the deployment detail page in the web dashboard.

Name-based URLs such as https://app.beam.cloud/endpoint/[APP-NAME] always require an auth token, even for public endpoints.