Skip to content

Get the assistant's platform settings

The assistant.platform_settings.get operation: GET /api/v1/platform/assistant/settings in the REST API and the assistant_platform_settings_get tool in the MCP server.

GET/api/v1/platform/assistant/settings

Platform staff: the in-platform assistant's platform-wide settings stored in platform_settings: the OpenRouter model and its ordered fallbacks, the provider base URL (EU in-region routing or our own router), and the monthly spend cap in integer USD micros. A null field means the environment's value applies (ASSISTANT_MODEL, ASSISTANT_FALLBACK_MODELS, OPENROUTER_BASE_URL, ASSISTANT_MONTHLY_BUDGET_USD: a decimal amount in USD with at most 6 decimals, such as 1500 or 1500.50).

At a glance

  • REST: GET /api/v1/platform/assistant/settings
  • MCP tool: assistant_platform_settings_get
  • Operation ID: assistant.platform_settings.get
  • Scope: Platform
  • Permission: platform:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Authentication: API key with the platform:read scope
  • Since: M11

Request

Query parameters

This operation takes no query parameters.

Response

200 OK with a JSON object:

FieldTypeDescription
object"assistant_platform_settings"
modelstring or nullThe OpenRouter model; null: ASSISTANT_MODEL.
fallbackModelsarray of string or nullOrdered fallbacks; null: ASSISTANT_FALLBACK_MODELS.
baseUrlstring or nullThe provider base URL; null: OPENROUTER_BASE_URL.
monthlyBudgetMicrosstring or nullThe platform-wide monthly spend cap in integer USD micros; null: ASSISTANT_MONTHLY_BUDGET_USD.
versioninteger (at least 1)
updatedAtdate-time

Examples

Everything from the environment

HTTP
GET /api/v1/platform/assistant/settings
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "object": "assistant_platform_settings",
  "model": null,
  "fallbackModels": null,
  "baseUrl": null,
  "monthlyBudgetMicros": null,
  "version": 1,
  "updatedAt": "2026-10-26T09:15:00.000Z"
}

Errors

CodeHTTP statusWhenWhat to do
permission_denied403You aren't platform staff.Ask an organization owner or admin for a role or scope that allows this action.
resource_not_found404The platform isn't bootstrapped yet.Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.

It can also return these common errors: validation_failed, api_version_unsupported, authentication_required, api_key_invalid, dry_run_not_supported, rate_limited, internal_error.