Get per-world LLM role overrides

GET

/api/v1/config/llm-roles

const url = 'http://localhost:11044/api/v1/config/llm-roles';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/config/llm-roles \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

The role→model map realms resolve against (e.g. code_best→gpt-4.1). Empty = inherit deployment defaults.

Authorizations

apiKeyAuth
basicAuth

Responses

200

LLM role overrides

*/*

object

key

additional properties

How one purpose, or one role override, picks its model: by role or by pinned model, with optional temperature and reasoning effort. Read and written by the /config/llms, /config/chat and /config/llm-roles endpoints

object

description

What a custom role in llmRoles is for, since built-in roles are described by the catalogue; unused on a purpose setting

string

model

Model name to pin. For a purpose, used only when no role is set; in an llmRoles entry, the model the role resolves to. Null or blank pins nothing

string

reasoningEffort

Reasoning effort: none, minimal, low, medium, high or xhigh (none turns a thinking model’s reasoning off); null leaves the provider’s default

string

role

Role id to select the model by (e.g. chat_best, code_best); for a purpose it takes precedence over model. Not used in an llmRoles entry

string

temperature

Sampling temperature; null keeps the default’s temperature

number format: double