Skip to main content
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

​
Authentication

The Blaxel SDK authenticates with your workspace using credentials from these sources, in priority order:
  1. when running on Blaxel, authentication is handled automatically
  2. variables in your .env file (BL_WORKSPACE and BL_API_KEY, or see this page for other authentication options).
  3. environment variables from your machine
  4. configuration file created locally when you log in through Blaxel CLI (or deploy on Blaxel)
When developing locally, the recommended method is to just log in to your workspace with Blaxel CLI. 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. When running Blaxel SDK from a remote server that is not Blaxel-hosted, we recommend using environment variables as described in the third option above.

​
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.