getAiSettings

GET

/settings/ai

const url = 'http://localhost:8080/api/v1/settings/ai';
const options = {method: 'GET', headers: {cookie: 'hs_session=<hs_session>'}};

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:8080/api/v1/settings/ai \
  --cookie hs_session=<hs_session>

Coming in 1.0. Defined in the contract, not implemented on main yet (task S-17); the server answers 501 with code not_implemented.

Authorizations

cookieAuth
bearerAuth

Responses

200

AI settings (the API key is never returned).

application/json

object

provider

required

string

Allowed values: openrouter none

apiKeySet

required

boolean

model

required

string

fallbackModels

required

Array<string>

<= 3 items

dataCollection

required

OpenRouter provider routing; fixed in v1.

string

Allowed values: deny

extractEnabled

required

boolean

summariesEnabled

required

boolean

maxImagesPerRequest

required

integer

concurrency

required

integer

spentUsdThisMonth

required

From OpenRouter usage accounting; informational only.

number

promptOverrides

required

Prompt files found in /data/prompts (names only).

Array<string>

Examples

seed

Derived from fixtures/seed.json.

{
  "apiKeySet": true,
  "concurrency": 2,
  "dataCollection": "deny",
  "extractEnabled": true,
  "fallbackModels": [],
  "maxImagesPerRequest": 40,
  "model": "xiaomi/mimo-v2.6-pro",
  "promptOverrides": [],
  "provider": "openrouter",
  "spentUsdThisMonth": 3.42,
  "summariesEnabled": true
}