Aliases

Model alias management — routing shortcuts and fallback cascades.

Overview

The Aliases resource manages tenant-level model aliases. Aliases let you reference models by short names (e.g., "fast", "smart") and define fallback cascades (arrays of models tried in order).

Methods

list()

Read the current tenant's model alias map.

const map = await client.aliases.list();
// { aliases: { fast: "anthropic/claude-haiku-4-5", smart: "anthropic/claude-sonnet-4" } }

aliases = client.aliases.list()

set(aliases)

Replace the entire alias map atomically.

await client.aliases.set({
  fast: "anthropic/claude-haiku-4-5",
  smart: ["anthropic/claude-sonnet-4", "openai/gpt-4o"],  // fallback cascade
});

client.aliases.set({
    "fast": "anthropic/claude-haiku-4-5",
    "smart": ["anthropic/claude-sonnet-4", "openai/gpt-4o"],
})

patch(aliases)

Merge aliases into the existing map. Set a key to null/None to delete it.

await client.aliases.patch({
  fast: null,  // delete this alias
  budget: "openai/gpt-4o-mini",  // add new alias
});

client.aliases.patch({
    "fast": None,     # delete this alias
    "budget": "openai/gpt-4o-mini",  # add new alias
})

Usage with Completions

Once aliases are configured, use them anywhere a model ID is accepted:

const response = await client.chat.completions.create({
  model: "fast", // resolves to anthropic/claude-haiku-4-5
  messages: [{ role: "user", content: "Hello" }],
});

MCP Tools

Tool	Description	Permission
br_set_alias	Set a single alias	config.write
br_list_aliases	List all tenant aliases	config.read
br_patch_aliases	Bulk update aliases (null values delete)	config.write