Changelog

Documentation

API Reference

CLI Reference

Beamlit Console

Support

Overview

Beamlit Documentation

Deploy your first AI model worldwide in just 3 minutes.

Get started

Run inferences on your Beamlit deployments.

Inference API

Interact with Beamlit through a command line interface.

bl login

bl workspaces

bl logout

bl run

bl apply

bl metrics

bl get

bl get environments

bl get functions

bl get locations

bl get modelproviders

bl get models

bl get policies

bl delete

bl delete function

bl delete model

bl delete modelprovider

bl delete policy

bl completion

bl completion fish

bl completion powershell

Learn how to deploy a model you saved on a private HuggingFace repository.

Deploy a custom model from HuggingFace

Learn how to create a hybrid replica of a model deployed on your own Kubernetes cluster.

Offload burst inferences from a self hosted model

Query an agent

Execute custom code to empower your AI agents with tools and actions.

Make invocation requests on your functions.

Invoke a function

Empower your agents with AI models from anywhere.

Deploy AI models and manage the life-cycle of deployments in production.

Custom models deployment

Query a model

Deploy public or private AI models from HuggingFace.

HuggingFace integration

OpenAI integration

Connect your agents to LLMs from Anthropic.

Anthropic integration

Connect your agents to LLMs from Mistral AI.

Mistral AI integration

Cohere integration

xAI integration

Enforce deployment strategies across your entire workspace.

Environments

Create and enforce fine-grained deployment rules.

Policies

Get visibility over all inference requests on your models.

Monitoring

Control authentication and authorization over all resources in your workspace.

Users and roles

Automate the life-cycle of Beamlit resources via API through service accounts.

Service accounts

Interact with Beamlit by API or CLI using access tokens.

Access tokens

Run serverless AI models and agents close to your consumers.

Global Inference Network

List all agents

Create agent by name

Get agent by name

Update agent by name

Delete agent by name

List all agent deployments

Get agent deployment by environment name

Create or update agent deployment by environment name

Delete agent deployment by environment name

Get agents deployments history

Get agents deployments history 1

Update agent's history by request ID

Delete agents deployments history

Get agents deployments logs

Get agents deployments metrics

Get agent metrics

Create release for a agent from an environment

List all configurations

Returns a list of all environments in the workspace.

List environments

Create environment

Get environment

Update environment

Delete environment

Returns metrics for an environment by name.

Get environment metrics

List all functions

Create function

Get function by name

Update function by name

Delete function by name

List all function deployments

Get function deployment by environment name

Create or update function deployment by environment name

Delete function deployment by environment name

Get functions deployments logs

Get functions deployments metrics

Get function metrics

Create release for a function from an environment

Get historyagents

Get all history for a specific request ID from all agents

Get historyagents 1

List integrations connections

Returns a list of all models for an integration.

List integration models

Returns a model for an integration by ID.

Get integration model

Returns a list of all connections integrations in the workspace.

Create integration

Returns an integration connection by integration name and connection name.

Get integration

Update an integration connection by integration name and connection name.

Update integration connection

Deletes an integration connection by integration name and connection name.

Delete integration

Returns a list of all models for an integration connection.

List integration connection models

Returns a model for an integration connection by ID.

Returns a list of all locations available with status.

List locations

Returns metrics for the workspace's deployments.

Get metrics for a workspace

Returns a list of all integrations in the workspace.

List model providers

Create model provider

Get model provider

Update model provider

Delete model provider

Returns a list of all models in the workspace.

List models

Create model

Get model

Create or update model

Delete model

Returns a list of all deployments for a model.

List model deployments

Returns a deployment for a model by name.

Get model deployment

Creates or updates a deployment for a model by name.

Create or update model deployment

Deletes a deployment for a model by name.

Delete model deployment

Returns logs for a model deployment by name.

Get models deployments logs

Returns metrics for a model deployment by name.

Get models deployments metrics

Get model metrics

Make a release for a model from an environment to another.

Release model from an environment

Returns a list of all policies in the workspace.

List policies

Create policy

Get policy

Update policy

Delete policy

Returns a list of all pending invitations in the workspace.

List pending invitations

Returns a list of all service accounts in the workspace.

Get workspace service accounts

Creates a service account in the workspace.

Create workspace service account

Update workspace service account

Delete workspace service account

Returns a list of all API keys for a service account.

List API keys for service account

Creates an API key for a service account.

Create API key for service account

Deletes an API key for a service account.

Delete API key for service account

List all store agent

Get store agent by name

List all store agent functions

Get store agent function by name

Returns a list of all users in the workspace.

List users in workspace

Invites a user to the workspace by email.

Invite user to workspace

Updates the role of a user in the workspace.

Update user role in workspace

Removes a user from the workspace (or revokes an invitation if the user has not accepted the invitation yet).

Get Started

Examples

Agents

Functions

Model APIs

Integrations

Administration & security

Cli reference