​
Install

​
Python SDK

Run the following command

Python

uv init && uv add blaxel

​
TypeScript SDK

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

​
How it works

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 second option above.

​
Full documentation

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.