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 a SDK in TypeScript. To install, follow the instructions below.

​
Install

To manage Blaxel resources, use the core SDK @blaxel/core: 

pnpm install @blaxel/core
For automatic trace and metric exports when running workloads with Blaxel SDK, you’ll want to use @blaxel/telemetry. Import this SDK at your project’s entry point. 

pnpm install @blaxel/telemetry
For compatibility with agent’s frameworks (i.e. to import tools and models in the framework’s format), import the corresponding SDK: 

pnpm install @blaxel/langgraph

pnpm install @blaxel/vercel

pnpm install @blaxel/mastra

pnpm install @blaxel/llamaindex

​
Prerequisites

To use this 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. For other authentication options, see Variables and secrets. Alternatively, you can authenticate via the Blaxel CLI: 
bl login
When you deploy on Blaxel, authentication is handled automatically.

​
Guides

Create sandboxes

Use Blaxel SDK to create and connect to sandboxes and sandbox previews.

Interact with a sandbox

Use Blaxel SDK to manage the filesystem, processes and logs of a sandbox.

Connect to MCP servers

Use Blaxel SDK to retrieve tools from a deployed MCP server.

Connect to model APIs

Use Blaxel SDK to retrieve an LLM client when building agents.

Deploy your MCP server

Use Blaxel SDK to create and host a custom MCP server.

Chain agents

Use Blaxel SDK to chain calls to multiple agents.

​
Complete SDK reference

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

TypeScript SDK

Open the GitHub repository for Blaxel SDK in TypeScript.
Last modified on April 7, 2026