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.

Blaxel features SDKs in three languages: Python, TypeScript, and Go. Check out down below the installation instructions, as well as documentation on how the SDK authenticates to Blaxel.

​
Install

TypeScript SDK

Install the TypeScript SDK.

Python SDK

Install the Python SDK.

Go SDK

Install the Go SDK.

​
Prerequisites

To use any Blaxel SDK, you need a Blaxel account and the following environment variables:
VariableDescription
BL_WORKSPACEYour Blaxel workspace name
BL_API_KEYYour Blaxel API key
You can create an API key from the Blaxel console. Your workspace name is visible in the URL when you log in to the console (e.g. app.blaxel.ai/{workspace}). Set them as environment variables: 
export BL_WORKSPACE=my-workspace
export BL_API_KEY=my-api-key
Or add them to a .env file at the root of your project.

​
How authentication works

The Blaxel SDK does not accept credentials as constructor arguments. Credentials must be supplied through one of the following sources, checked in priority order:
  1. when running on Blaxel, authentication is handled automatically
  2. BL_WORKSPACE and BL_API_KEY environment variables or .env file (see this page for other authentication options)
  3. configuration file created locally when you log in through Blaxel CLI (or deploy on Blaxel)
When developing locally, you can also log in to your workspace with Blaxel CLI: 
bl login
This allows you to run Blaxel SDK functions that will automatically connect to your workspace without additional setup. When you deploy on Blaxel, this connection persists automatically.

​
Data collection and privacy

Read more about the data collected by the Blaxel SDKs.

​
Complete SDK reference

Visit the GitHub pages below for detailed documentation on each SDK’s commands and classes.

TypeScript SDK

Open the GitHub repository for Blaxel SDK in TypeScript.

Python SDK

Open the GitHub repository for Blaxel SDK in Python.

Go SDK

Open the GitHub repository for Blaxel SDK in Go.
Last modified on May 1, 2026