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.
/api/v1/platform/assistant/settingsPlatform 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:readscope - Since: M11
Request
Query parameters
This operation takes no query parameters.
Response
200 OK with a JSON object:
| Field | Type | Description |
|---|---|---|
object | "assistant_platform_settings" | |
model | string or null | The OpenRouter model; null: ASSISTANT_MODEL. |
fallbackModels | array of string or null | Ordered fallbacks; null: ASSISTANT_FALLBACK_MODELS. |
baseUrl | string or null | The provider base URL; null: OPENROUTER_BASE_URL. |
monthlyBudgetMicros | string or null | The platform-wide monthly spend cap in integer USD micros; null: ASSISTANT_MONTHLY_BUDGET_USD. |
version | integer (at least 1) | |
updatedAt | date-time |
Examples
Everything from the environment
GET /api/v1/platform/assistant/settings
Authorization: Bearer or_test_…
Response (200):
{
"object": "assistant_platform_settings",
"model": null,
"fallbackModels": null,
"baseUrl": null,
"monthlyBudgetMicros": null,
"version": 1,
"updatedAt": "2026-10-26T09:15:00.000Z"
}
Errors
| Code | HTTP status | When | What to do |
|---|---|---|---|
permission_denied | 403 | You aren't platform staff. | Ask an organization owner or admin for a role or scope that allows this action. |
resource_not_found | 404 | The 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.