@blaxel/core

Blaxel Typescript SDK

Blaxel is a computing platform for AI agent builders, with all the services and infrastructure to build and deploy agents efficiently. This repository contains the TypeScript SDK to create and manage resources on Blaxel.

Table of Contents

• Installation
  • Optional libraries
  • Authentication
• Features
• Quickstart
• Contributing
• License

Installation

Install Blaxel core SDK, which lets you manage Blaxel resources.

## npm
npm install @blaxel/core

## pnpm
pnpm i @blaxel/core

## yarn
yarn add @blaxel/core

Optional libraries

Blaxel SDK is split between multiple packages. core is the minimal package to connect to Blaxel. You can find other packages to help you integrate with your favorite AI framework, or set up telemetry.

• @blaxel/telemetry
• @blaxel/vercel
• @blaxel/llamaindex
• @blaxel/langgraph
• @blaxel/mastra

Instrumentation happens automatically when workloads run on Blaxel. To enable telemetry, simply require the SDK in your project's entry point.

import "@blaxel/telemetry";

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.

Features

• Agents & MCP servers
  • Create MCP servers
  • Connect to MCP servers and model APIs hosted on Blaxel
  • Call agents from another agent
  • Deploy on Blaxel
• Sandboxes
  • Create and update sandboxes and sandbox previews
  • Run filesystem operations and processes on a sandbox
• Use environment variables or secrets

Quickstart

Blaxel CLI gives you a quick way to create new applications: agents, MCP servers, jobs, etc - and deploy them to Blaxel.

Prerequisites:

• Node.js: v18 or later.
• Blaxel CLI: Make sure you have Blaxel CLI installed. If not, install it:

  curl -fsSL \
  https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \
  | BINDIR=/usr/local/bin sudo -E sh

• Blaxel login: Login to Blaxel:

    bl login YOUR-WORKSPACE

bl create-agent-app myfolder
cd myfolder
bl deploy

Also available:

• bl create-mcp-server
• bl create-job

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.