Skip to main content

Load settings

GET /api/v1/settings

Load user settings. Retrieves the settings for the authenticated user, including LLM configuration, provider tokens, and other user preferences. Returns: GETSettingsModel: The user settings with token data Raises: 404: Settings not found 401: Invalid token

Responses

StatusDescription
200Successful Response
401Invalid token
404Settings not found

Response body

FieldTypeRequiredDescription
language`stringnull`no
user_version`integernull`no
remote_runtime_resource_factor`integernull`no
secrets_storeobjectno
enable_sound_notificationsbooleanno
enable_proactive_conversation_startersbooleanno
user_consents_to_analytics`booleannull`no
sandbox_base_container_image`stringnull`no
sandbox_runtime_container_image`stringnull`no
disabled_skills`string[]null`no
search_api_key`stringnull`no
sandbox_api_key`stringnull`no
max_budget_per_task`numbernull`no
email`stringnull`no
email_verified`booleannull`no
git_user_name`stringnull`no
git_user_email`stringnull`no
title_llm_profile`stringnull`no
git_full_clonebooleanno
v1_enabledbooleanno
agent_settingsobjectno
conversation_settingsConversationSettingsno
sandbox_grouping_strategySandboxGroupingStrategyno
default_sandbox_spec_id`stringnull`no
llm_profilesLLMProfilesnoSaved LLM profiles and the currently active profile name. See LLMProfiles for the profile-management API.
active_agent_profile_id`stringnull`no
active_agent_profile_revision`integernull`no
registered_marketplacesfaheemcode__app_server__settings__settings_models__MarketplaceRegistration[]noList of marketplace registrations for plugin resolution. Marketplaces with auto_load=True will have their plugins loaded automatically at conversation start. See MarketplaceRegistration for details.
inherited_marketplacesfaheemcode__app_server__settings__settings_models__MarketplaceRegistration[]noMarketplaces inherited from instance or organization level. These are read-only and cannot be modified by the user. Computed at runtime: Instance defaults + Org defaults.
provider_tokens_set`objectnull`no
llm_api_key_setbooleanyes
search_api_key_setbooleanno

Operation ID: load_settings_api_v1_settings_get