Skip to content

Admin Ai

Get Platform Ai Settings

Current platform AI scalars. Null fields defer to the env defaults.

Responses

StatusDescriptionBody
200Successful ResponsePlatformAISettingsResponse
422Validation ErrorHTTPValidationError

Update Platform Ai Settings

Update platform AI scalars.

Values land in platform_settings and are re-read per run, so a change here reaches running workers within their catalog/settings TTL — no deploy.

The default model is checked against the catalog before it is stored: it is what every org without a default of its own runs on, so a typo’d or retired id here would silently break all of them at the next turn instead of here, now, with a list of the ids that would have worked.

Request body (required)

FieldTypeRequiredDescription
compaction_enabledbooleanno
compaction_thresholdnumberno
default_modelPlatformDefaultModelInputno
default_reasoning_effortstringno
max_reasoning_effortstringno
thinking_enabledbooleanno

Responses

StatusDescriptionBody
200Successful ResponsePlatformAISettingsResponse
422Validation ErrorHTTPValidationError

List Catalog Models

Every catalog row, enabled or not, in display order.

Responses

StatusDescriptionBody
200Successful ResponseModelCatalogEntryResponse[]
422Validation ErrorHTTPValidationError

Create Catalog Model

Add a model. key must be unique — it’s what agents store.

Request body (required)

FieldTypeRequiredDescription
allowed_effortsstring[]no
cache_write_price_per_1mnumber | stringno
cached_input_price_per_1mnumber | stringno
cost_tierstringno
enabledbooleanno
input_price_per_1mnumber | stringno
keystringyes
kindstringno
labelstringyes
max_output_tokensintegerno
output_price_per_1mnumber | stringno
providerstringyes
replacement_model_idstring (uuid)no
sort_orderintegerno
supports_reasoningbooleanno
supports_visionbooleanno

Responses

StatusDescriptionBody
201Successful ResponseModelCatalogEntryResponse
422Validation ErrorHTTPValidationError

Update Catalog Model

Update a model. Switching enabled off takes effect platform-wide.

Runs already pinned to a disabled model are not rewritten: they resolve to replacement_model_id (or the platform default) lazily at dispatch.

Parameters

NameInTypeRequiredDescription
entry_idpathstring (uuid)yes

Request body (required)

FieldTypeRequiredDescription
allowed_effortsstring[]no
cache_write_price_per_1mnumber | stringno
cached_input_price_per_1mnumber | stringno
cost_tierstringno
deprecatedbooleanno
enabledbooleanno
input_price_per_1mnumber | stringno
kindstringno
labelstringno
max_output_tokensintegerno
output_price_per_1mnumber | stringno
providerstringno
replacement_model_idstring (uuid)no
sort_orderintegerno
supports_reasoningbooleanno
supports_visionbooleanno

Responses

StatusDescriptionBody
200Successful ResponseModelCatalogEntryResponse
422Validation ErrorHTTPValidationError

Delete Catalog Model

Remove a model from the catalog.

Prefer disabling: a deleted row loses its replacement pointer, so anything still pinned to the key falls all the way through to the platform default.

Parameters

NameInTypeRequiredDescription
entry_idpathstring (uuid)yes

Responses

StatusDescriptionBody
204Successful Response
422Validation ErrorHTTPValidationError

POST /api/admin/models/{entry_id}/sync-price

Section titled “POST /api/admin/models/{entry_id}/sync-price”

Sync Catalog Model Price

Re-price one model from the community LiteLLM dataset.

A convenience for identifying prices, not a runtime dependency: runs bill from the catalog, and this is one way to fill it. Deliberate per-row action, so it does overwrite what’s there — the boot-time sweep is the one that only fills blanks, precisely so a hand-typed price survives it.

Parameters

NameInTypeRequiredDescription
entry_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseModelCatalogEntryResponse
422Validation ErrorHTTPValidationError

Get Org Ai Settings

One org’s runtime overrides, plus the platform values behind its nulls.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseOrgRuntimeSettingsResponse
422Validation ErrorHTTPValidationError

PATCH /api/admin/orgs/{org_id}/ai-settings

Section titled “PATCH /api/admin/orgs/{org_id}/ai-settings”

Update Org Ai Settings

Set (or clear) one org’s runtime overrides on its behalf.

Writes the same rows the org’s own settings page writes, so support flipping a single org and that org flipping itself are the same operation — and the platform tier stays where everyone else reads it.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes

Request body (required)

FieldTypeRequiredDescription
compaction_enabledbooleanno
compaction_thresholdnumberno
thinking_enabledbooleanno

Responses

StatusDescriptionBody
200Successful ResponseOrgRuntimeSettingsResponse
422Validation ErrorHTTPValidationError