Documentation

Overview

Blaxel Documentation

Get started

Make your coding assistant access this documentation.

Connect your AI assistant

Deploy your agents as serverless auto-scalable endpoints.

Agents Hosting

Automatically deploy your GitHub repository with Blaxel.

Deploy from GitHub

Query an agent

Lightweight virtual machines where both you and your agents can run code with sub-20ms cold starts.

Sandboxes

Execute and manage processes in sandboxes.

Process execution

A simple file system interface for managing files in sandboxes.

File system

Tools and functions that are optimized for AI codegen use cases.

File management for codegen

Access logs generated by a sandbox in real time.

Log streaming

Render an application in real-time via a direct preview URL for its running sandbox.

Preview code in real-time

Operate sandboxes from a frontend client using sessions.

Client-side sessions

Scheduled jobs of batch processing tasks for your AI workflows.

Jobs

Deploy MCP servers as serverless APIs to equip your agents with tools.

MCP servers

Develop a custom MCP server

Manage variables and secrets in your agent or MCP server code.

Variables and secrets

Host your custom MCP Servers on Blaxel in a few clicks.

Deploy custom MCP servers

Make invocation requests on your MCP servers.

Query MCP servers

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

Logs & traces

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

Integrations

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 jobs in the workspace.

List jobs

Create job

Get job

Create or update job

Delete job

List job revisions

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

Get sandboxhub

Get template

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 Sandboxes in the workspace.

List Sandboxes

Create Sandbox

Get Sandbox

Update Sandbox

Delete Sandbox

Returns a list of Sandbox Previews in the workspace.

Create Sandbox Preview

Get Sandbox Preview

Update Sandbox Preview

Delete Sandbox Preview

Get tokens for Sandbox Preview

Create token for Sandbox Preview

Deletes a token for a Sandbox Preview by name.

Delete token for Sandbox Preview

Start Sandbox

Stop Sandbox

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 templates

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

Check workspace availability

Get content of a file or listing of a directory

Get file or directory information

Create or update a file or directory

Delete file or directory

Streams the path of modified files (one per line) in the given directory. Closes when the client disconnects.

Stream file modification events in a directory

Streams JSON events of modified files in the given directory. Closes when the client disconnects.

Stream file modification events in a directory via WebSocket

Start monitoring for new ports opened by a process

Start monitoring ports for a process

Stop monitoring for new ports opened by a process

Stop monitoring ports for a process

Get a list of all open ports for a process

Get open ports for a process

Get a list of all running and completed processes

List all processes

Execute a command and return process information

Execute a command

Get information about a process by its PID or name

Get process by identifier

Stop a process

Kill a process

Get the stdout and stderr output of a process

Get process logs

Streams the stdout and stderr output of a process in real time, one line per log, prefixed with 'stdout:' or 'stderr:'. Closes when the process exits or the client disconnects.

Stream process logs in real time

Streams the stdout and stderr output of a process in real time as JSON messages.

Stream process logs in real time via WebSocket

Manage Blaxel resources programmatically using our SDKs.