Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blaxel.ai/llms.txt

Use this file to discover all available pages before exploring further.

Blaxel APIs allow you to interact with all resources inside of and across your workspace(s).

​
Get started

Authentication to the Blaxel APIs can either be done using API keys created from the Blaxel console, or through a classic OAuth 2.0 flow. API keys allow you to get started quickly. Simply generate an API key for your user or service account and use the API key as a bearer token in place of the authorization headers Authorization or X-Blaxel-Authorization in any call to the Blaxel APIs. For example, to list models: 
curl 'https://api.blaxel.ai/v0/models' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'X-Blaxel-Authorization: Bearer YOUR-API-KEY'
To use short-lived JWTs, see the guide on using an OAuth 2.0 flow. See the reference documentation below for more information:

Inference API

Run inference requests on your deployments.

Billing API

Programmatically retrieve cost and usage metrics.

Management API

Manage agents, functions, policies and much more.

​
API Versioning

The Blaxel API uses header-based versioning to evolve response formats and behavior without breaking existing clients.

​
Version Header

All requests should include the Blaxel-Version header: 
curl 'https://api.blaxel.ai/v0/agents' \
  -H 'X-Blaxel-Authorization: Bearer YOUR-API-KEY' \
  -H 'Blaxel-Version: 2026-04-16'

​
Version Format

Versions follow a Stripe-style date-based format:
  • Stable: YYYY-MM-DD (e.g., 2026-04-16)
  • Preview: YYYY-MM-DD.preview (e.g., 2026-04-16.preview)

​
Default Behavior

If you omit the Blaxel-Version header, the API defaults to the earliest stable version (2026-04-16). This ensures backward compatibility — existing clients work without changes.

​
Pinning to a Specific Version

To guarantee consistent response shapes across API updates, pin your client to a specific version: 
curl -H 'Blaxel-Version: 2026-04-20' https://api.blaxel.ai/v0/agents
Once a new version is released, you can update your client at your own pace.

​
Unknown Versions

If you send an unsupported version, the API returns 400 Bad Request: 
{
  "error": "invalid_api_version",
  "message": "Unknown API version \"2026-99-99\". Valid versions: 2026-04-16. See https://docs.blaxel.ai/api-reference/introduction#api-versioning for the list of supported versions."
}
Update your client to use a version from the table below.

​
Version History

VersionReleasedStatusNotes
2026-04-162026-04-16StableInitial version
Last modified on May 14, 2026