Blaxel SDK
Manage Blaxel resources programmatically using our SDKs.
Install
Python SDK
Run the following command
TypeScript SDK
To manage Blaxel resources, use the core SDK @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.
For compatibility with agent’s frameworks (to import tools and models in the framework’s format), import the corresponding SDK:
How it works
The Blaxel SDK authenticates with your workspace using credentials from these sources, in priority order:
- when running on Blaxel, authentication is handled automatically
- variables in your
.env
file (BL_WORKSPACE
andBL_API_KEY
, or see this page for other authentication options). - environment variables from your machine
- 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.