Documentation

Overview

Blaxel Documentation

Deploy your first AI agent worldwide in just 3 minutes.

Get started

Deploy your first LangChain AI agent on Blaxel.

Deploy a LangChain agent

Ship agents in any Python/TypeScript framework on Blaxel.

Frameworks on Blaxel

Learn how to leverage Blaxel with LangChain and LangGraph.

LangChain

Learn how to leverage Blaxel with CrewAI.

CrewAI

Agents

Ship your custom AI agents on Blaxel in a few clicks.

Deploy agents

Query an agent

Integrate and use Blaxel agents in your applications and communication platforms.

Integrate in your apps

Execute custom code to empower your AI agents with tools and actions.

Functions

Make invocation requests on your functions.

Invoke a function

Empower your agents with AI models from anywhere.

Model APIs

Control & secure access to AI models from top providers behind Blaxel Global Inference Network.

External model APIs

Make inference requests on your model APIs.

Query a model API

Traces

Create agents that connect to private systems, LLMs, SaaS, databases, and APIs.

Integrations

OpenAI integration

Connect your agents to LLMs from Anthropic.

Anthropic integration

Connect your agents to LLMs from Mistral AI.

Mistral AI integration

Cohere integration

xAI integration

Connect your agents to LLMs from DeepSeek.

DeepSeek integration

Deploy public or private AI models from HuggingFace.

HuggingFace integration

Connect your agents to LLMs deployed in Azure AI Inference, Azure OpenAI Service, and Azure AI Services.

Azure AI Foundry integration

Integrate Google Maps services into your agents for location-based capabilities.

Google Maps

Integrate Gmail services into your agents for email communication capabilities.

Gmail

Pactory

Create and enforce fine-grained deployment rules.

Policies

Interact with Blaxel by API or CLI using access tokens.

Access tokens

Discover templates of agents in multiple frameworks that you can deploy on Blaxel in one click.

Templates & Cookbooks

Run inferences on your Blaxel deployments.

Inference API

List all agents

Create agent by name

Get agent by name

Update agent by name

Delete agent by name

List all agent revisions

List all configurations

List all functions

Create function

Get function by name

Update function by name

Delete function by name

Returns revisions for a function by name.

List function revisions

List integrations connections

Returns a list of all connections integrations in the workspace.

Create integration

Returns an integration connection by integration name and connection name.

Get integration

Update an integration connection by integration name and connection name.

Update integration connection

Deletes an integration connection by integration name and connection name.

Delete integration

Returns a list of all endpoint configurations for a model.

Get integration connection model endpoint configurations

Returns a list of all models for an integration connection.

List integration connection models

Returns a model for an integration connection by ID.

Get integration model endpoint configurations

Returns a list of all knowledgebases in the workspace.

List knowledgebases

Create knowledgebase

Get knowledgebase

Update knowledgebase

Delete knowledgebase

Returns revisions for a knowledgebase by name.

List knowledgebase revisions

Returns a list of all locations available with status.

List locations

Get mcphub

Returns a list of all models in the workspace.

List models

Create model

Get model

Create or update model

Delete model

List model revisions

Returns a list of all policies in the workspace.

List policies

Create policy

Get policy

Update policy

Delete policy

List all private clusters

Create private cluster

Get private cluster by name

Update private cluster

Delete private cluster

Get private cluster health

Update private cluster health

Returns a list of all pending invitations in the workspace.

List pending invitations

Returns a list of all service accounts in the workspace.

Get workspace service accounts

Creates a service account in the workspace.

Create workspace service account

Update workspace service account

Delete workspace service account

Returns a list of all API keys for a service account.

List API keys for service account

Creates an API key for a service account.

Create API key for service account

Deletes an API key for a service account.

Delete API key for service account

List all store agent

Get store agent by name

List all store agent functions

Get store agent function by name

Returns a list of all users in the workspace.

List users in workspace

Invites a user to the workspace by email.

Invite user to workspace

Updates the role of a user in the workspace.

Update user role in workspace

Removes a user from the workspace (or revokes an invitation if the user has not accepted the invitation yet).

Remove user from workspace or revoke invitation

List workspaces

Create worspace

Get workspace

Update workspace

Delete workspace

Decline invitation to workspace

Accept invitation to workspace

Leave workspace

Interact with Blaxel through a command line interface.

bl login

bl workspaces

bl logout

bl create-agent-app

bl serve

bl deploy

bl run

bl chat

bl apply

bl metrics

bl get

bl get agents

bl get environments

bl get functions

bl get integrationconnections

bl get locations

bl get modelproviders

bl get models

bl get policies

bl delete

bl delete agent

bl delete function

bl delete integrationconnection

bl delete model

bl delete modelprovider

bl delete policy

bl completion

bl completion fish

bl completion powershell

bl version

Changelog

API Reference

CLI Reference

Blaxel Console

Develop agents

Use the Blaxel SDK to develop and run a custom agent in TypeScript.

Develop agents in TypeScript

Use the Blaxel SDK to develop and run a custom agent in Python.

Develop agents in Python

Control authentication and authorization over all resources in your workspace.

Users and roles

Automate the life-cycle of Blaxel resources via API through service accounts.

Service accounts

The Blaxel powerhouse to securely run AI at scale.

Overview

Authentication API

Developer API

Inference API

Management API

Tools

Cli reference