API Reference

Check if AI is configured

View Markdown

GET /api/ai/status

Operation IDgetAiStatus

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Success response body

200AI configuration status. When enabled, includes the selectable model catalog and the configured default model.

AI configuration status. When enabled, includes the selectable model catalog and the configured default model.

Content typeapplication/json

responseobject

4 properties

enabledboolean

modelsarray<object>

Selectable models (only present when enabled)

Array items

itemobject

3 properties

idstring

labelstring

descriptionstring

default_modelstring

Model used when the chat request has no model override (only present when enabled)

context_windowinteger

Model context window in tokens, used by the UI context meter (only present when enabled)

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/ai/status' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/ai/status", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);