Create or update agent deployment by environment name

PUT

agents

{agentName}

deployments

{environmentName}

object

created_at

string

created_by

string

updated_at

string

updated_by

string

agent

string

agent_chain

array

configuration

object

description

string

enabled

boolean

environment

string

flavors

array

functions

array

integration_connections

array

labels

object

model

string

pod_template

object

policies

array

runtime

object

args

array

command

array

envs

array

image

string

model

string

readiness_probe

object

resources

object

type

string

serverless_config

object

last_pod_retention_period

string

max_num_replicas

integer

metric

string

min_num_replicas

integer

scale_down_delay

string

scale_up_minimum

integer

stable_window

string

target

string

store_id

string

workspace

string

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentName

string

required

Name of the agent

environmentName

string

required

Name of the environment

Body

application/json

Agent deployment configuration

created_at

string

The date and time when the resource was created

created_by

string

The user or service account who created the resource

updated_at

string

The date and time when the resource was updated

updated_by

string

The user or service account who updated the resource

agent

string

The name of the agent

agent_chain

object[]

Agent chaining configuration

configuration

object

Agent configuration, this is a key value storage. In your agent you can retrieve the value with config[key]

description

string

Agent description, very important to have a clear description for your agent if you want to make it work with agent chaining

enabled

boolean

Whether the agent deployment is enabled

environment

string

The name of the environment

flavors

object[]

Types of hardware available for deployments

functions

string[]

Functions used by the agent, those functions needs to be created before setting it here

integration_connections

string[]

The integration connections for the model deployment

labels

object | null

Labels

model

string

Model beamlit to use for agent, it should be compatible with function calling

pod_template

object

The pod template, should be a valid Kubernetes pod template

policies

string[]

runtime

object

Set of configurations for a deployment

serverless_config

object

Configuration for a serverless deployment

store_id

string

Create from a store registered function

workspace

string

The workspace the agent deployment belongs to

Response

200 - application/json

Agent deployment configuration

created_at

string

The date and time when the resource was created

created_by

string

The user or service account who created the resource

updated_at

string

The date and time when the resource was updated

updated_by

string

The user or service account who updated the resource

agent

string

The name of the agent

agent_chain

object[]

Agent chaining configuration

configuration

object

Agent configuration, this is a key value storage. In your agent you can retrieve the value with config[key]

description

string

Agent description, very important to have a clear description for your agent if you want to make it work with agent chaining

enabled

boolean

Whether the agent deployment is enabled

environment

string

The name of the environment

flavors

object[]

Types of hardware available for deployments

functions

string[]

Functions used by the agent, those functions needs to be created before setting it here

integration_connections

string[]

The integration connections for the model deployment

labels

object | null

Labels

model

string

Model beamlit to use for agent, it should be compatible with function calling

pod_template

object

The pod template, should be a valid Kubernetes pod template

policies

string[]

runtime

object

Set of configurations for a deployment

serverless_config

object

Configuration for a serverless deployment

store_id

string

Create from a store registered function

workspace

string

The workspace the agent deployment belongs to

Get agent deployment by environment name Delete agent deployment by environment name

Overview

Inference API

agents

configurations

environments

functions

history

integrations

locations

metrics

model_providers

models

policies

invitations

service_accounts

store

workspaces

Create or update agent deployment by environment name

Authorizations

Path Parameters

Body

Response