Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blaxel.ai/llms.txt

Use this file to discover all available pages before exploring further.

You can customize your Blaxel deployment with Blaxel’s configuration file blaxel.toml. The format of Blaxel’s configuration file is described below.
# resource type (optional)
# possible values: ["agent", "function", "job", "sandbox", "volume-template"]
# type = "agent"

# resource name (optional)
# defaults to the directory name
# name = "my-resource"

# public access to resource (only for resource type="agent")
# possible values: [true, false]
# defaults to false
# public = false

# deployment region (optional, for resource type="agent" or resource type="function")
# pins the resource to a specific region instead of global distribution
# required when attaching volumes to an agent
# region = "us-pdx-1"

# build configuration (optional)
# [build]
# automatic image slimming
# possible values: [true, false]
# defaults to true
# slim = true

# build-time variables (optional)
# should be used for non-secret values only
# [build.args]
# MY_BUILD_VAR = "my-value"

# entrypoint configuration (optional)
# [entrypoint]
# entrypoint command for production environment
# prod = "python main.py"

# entrypoint command for development environment
# dev = "python main.py --dev"

# environment variables (optional)
# [env]
# key-value paris
# MY_VAR = "my-value"

# runtime configuration (optional)
# [runtime]
# memory (MB)
# memory = 4096

# job configuration
# maxConcurrentTasks = 10

# task timeout in seconds  (only valid for resource type="job")
# timeout = 900

# maximum number of retries
# maxRetries=0

# volumes (optional, for resource type="agent" and resource type="sandbox")
# attaches persistent storage to the resource
# the resource must be pinned to the same region as the volume
# [[volumes]]
# volume name
# name = "my-volume"

# volume mount path
# mountPath = "/data"

# volume templates directory (only for resource type="volume-template")
# directory = "."

# volume default size in MB (only for resource type="volume-template")
# defaultSize = 1024

# job trigger (optional)
# [[triggers]]
# trigger identifier
# id = "my-trigger"

# trigger type
# possible values: ["schedule", "http", "http-async"]
# "schedule" trigger (only valid for resource type="job")
# type = "schedule"
# "http" trigger (only valid for resource type="agent" and resource type="function")
# type = "http"
# "http-async" trigger (only valid for resource type="agent")
# type = "http-async"

# [[triggers.configuration]]
# cron expression (only for trigger type="schedule")
# schedule = "0 * * * *"

# endpoint URL (only for trigger type="http" and trigger type="http-async")
# path = "/webhook"

# endpoint authentication (only for resource type="function" and trigger type="http")
# possible values: ["public", "private"]
# authenticationType = "public"

# callback URL (only for trigger type="http-async")
# callbackUrl = "https://webhook.site/3955e30a-e4b6-4fa5-8a28-598ce0f53386"
Last modified on May 1, 2026