Settings - Exo

What this family does

Settings are small and deliberately so: qualityMode and learnModeDefault. A subject that has never written settings reads the server defaults rather than an empty object. Patching is an upsert over the fields you send. Resetting restores the server defaults and returns them.

Routes

Method	Path	Scope	What it does
`GET`	`/v1/settings`	`read`	Get settings
`PATCH`	`/v1/settings`	`write`	Update settings
`POST`	`/v1/settings/reset`	`write`	Reset settings

Headers that apply here

Neither header is declared as an OpenAPI parameter, so neither appears in the generated schema tables.

X-Exo-Subject selects which subject the call acts for on the subject-aware routes above. Omit it to act as the key owner. See Subjects.
Idempotency-Key makes a retry safe on POST /v1/settings/reset. See Idempotency.

The shape of a call

Read settings.

curl https://api.get-exo.com/v1/settings \
  -H "X-Exo-API-Key: $EXO_KEY"

import httpx

response = httpx.get(
    "https://api.get-exo.com/v1/settings",
    headers={"X-Exo-API-Key": EXO_KEY},
)

const response = await fetch("https://api.get-exo.com/v1/settings", {
  headers: { "X-Exo-API-Key": process.env.EXO_KEY! },
});

The response:

{
  "qualityMode": "balanced",
  "learnModeDefault": false
}

Traps

An unknown field is a 422, not a silent no-op. The patch body is validated, so a typo fails loudly. Settings operations are not metered. Reads and patches are free. A reset is recorded for audit.

API reference

Base URL, authentication, and the conventions every route shares.

Errors

The problem envelope and the full code catalogue.

Bucketed usage metering

Get settings

⌘I

​What this family does

​Routes

​Headers that apply here

​The shape of a call

​Traps

​Related