Compares the provided settings with existing stored settings for the authenticated user.
If changes are detected, the settings are updated accordingly. If no settings exist,
a new settings record is created for the user.
Args:
payload (Settings): A Settings object containing updated user preferences or values.
Returns:
dict: A confirmation message indicating whether the settings were updated or skipped.
Raises:
HTTPException 500: If a runtime error occurs during update.
Preferred UI language code, e.g. 'en', 'he', or 'ja'.
Response
Successful Response
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Apigene","colors":{"primary":"#626AE9","light":"#626AE9","dark":"#626AE9"},"logo":{"light":"https://mintcdn.com/apigene/uc-Z_RqMQ0uSxRnH/logo/logo.png?fit=max\u0026auto=format\u0026n=uc-Z_RqMQ0uSxRnH\u0026q=85\u0026s=d3f920afe0cff7053c8f87cd7a3666b7","dark":"https://mintcdn.com/apigene/uc-Z_RqMQ0uSxRnH/logo/logo.png?fit=max\u0026auto=format\u0026n=uc-Z_RqMQ0uSxRnH\u0026q=85\u0026s=d3f920afe0cff7053c8f87cd7a3666b7"},"favicon":"https://mintcdn.com/apigene/uc-Z_RqMQ0uSxRnH/favicon.ico?fit=max\u0026auto=format\u0026n=uc-Z_RqMQ0uSxRnH\u0026q=85\u0026s=ab16204ce88247688a93f6f50a6956d5","navbar":{"links":[{"href":"mailto:support@apigene.ai","label":"Support"}],"primary":{"type":"button","label":"Sign in","href":"https://app.apigene.ai/"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"apigene","hasAudioNarration":false,"actualSubdomain":"apigene","customDomains":["docs.apigene.ai"],"gitSource":{"type":"github","owner":"apigene","repo":"apigene-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aea47f999e95b77fa608c4b","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":168},{"language":"default","tag":"API Specs","count":28},{"language":"default","tag":"User Guide","count":26},{"language":"default","tag":"MCP","count":13},{"language":"default","tag":"Workflows","count":12},{"language":"default","tag":"GPT","count":11},{"language":"default","tag":"MCP Server","count":10},{"language":"default","tag":"Organization","count":9},{"language":"default","tag":"Skill","count":9},{"language":"default","tag":"Task","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/user/settings-update","slug":"/api-reference/user/settings-update","pageMetadata":{"openapi":"post /api/user/settings/update","title":"Settings Update","description":"Endpoint to update user-specific settings.\n\nCompares the provided settings with existing stored settings for the authenticated user.\nIf changes are detected, the settings are updated accordingly. If no settings exist,\na new settings record is created for the user.\n\nArgs:\n payload (Settings): A `Settings` object containing updated user preferences or values.\n\nReturns:\n dict: A confirmation message indicating whether the settings were updated or skipped.\n\nRaises:\n HTTPException 500: If a runtime error occurs during update.","href":"/api-reference/user/settings-update"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Endpoint to update user-specific settings.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Compares the provided settings with existing stored settings for the authenticated user.\\nIf changes are detected, the settings are updated accordingly. If no settings exist,\\na new settings record is created for the user.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Args:\\npayload (Settings): A \", _jsx(_components.code, {\n children: \"Settings\"\n }), \" object containing updated user preferences or values.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Returns:\\ndict: A confirmation message indicating whether the settings were updated or skipped.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Raises:\\nHTTPException 500: If a runtime error occurs during update.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /api/user/settings/update","title":"Settings Update","description":"Endpoint to update user-specific settings.\n\nCompares the provided settings with existing stored settings for the authenticated user.\nIf changes are detected, the settings are updated accordingly. If no settings exist,\na new settings record is created for the user.\n\nArgs:\n payload (Settings): A `Settings` object containing updated user preferences or values.\n\nReturns:\n dict: A confirmation message indicating whether the settings were updated or skipped.\n\nRaises:\n HTTPException 500: If a runtime error occurs during update.","href":"/api-reference/user/settings-update"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["User"],"summary":"Settings Update","description":"Endpoint to update user-specific settings.\n\nCompares the provided settings with existing stored settings for the authenticated user.\nIf changes are detected, the settings are updated accordingly. If no settings exist,\na new settings record is created for the user.\n\nArgs:\n payload (Settings): A `Settings` object containing updated user preferences or values.\n\nReturns:\n dict: A confirmation message indicating whether the settings were updated or skipped.\n\nRaises:\n HTTPException 500: If a runtime error occurs during update.","operationId":"settings_update","requestBody":"5f6beb64-b0ef-4f97-a699-b7d0bab0645e","responses":{"200":"65d1a62b-6a31-43a1-85ae-0752d2f716fe","422":"67244296-514d-487d-9dfd-3934591d631a"},"security":["9069fd66-eee7-40a7-869b-d08756ee7e29"],"method":"post","type":"path","servers":["938e511d-5b6a-4be8-96ca-1315e9e9ad20"],"path":"/api/user/settings/update","baseUrlOptions":["https://app.apigene.ai"],"title":"Settings Update","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"conversation_starters":{"oneOf":[{"type":"array","items":{"properties":{"name":{"type":"string","title":"Name","description":"Conversation name.","isRequired":true,"uniqueKey":"conversation_starters.oneOf.0.items.[INDEX].name","typeLabel":"string"},"action":{"items":{"properties":{"api_name":{"type":"string","title":"Api Name","description":"Name of the API.","isRequired":true,"uniqueKey":"conversation_starters.oneOf.0.items.[INDEX].action.items.[INDEX].api_name","typeLabel":"string"},"domain_url":{"type":"string","title":"Domain Url","description":"API domain url.","isRequired":true,"uniqueKey":"conversation_starters.oneOf.0.items.[INDEX].action.items.[INDEX].domain_url","typeLabel":"string"},"user_input":{"type":"string","title":"User Input","description":"User input data.","isRequired":true,"uniqueKey":"conversation_starters.oneOf.0.items.[INDEX].action.items.[INDEX].user_input","typeLabel":"string"}},"type":"object","required":["api_name","domain_url","user_input"],"title":"ConversationAction","uniqueKey":"conversation_starters.oneOf.0.items.[INDEX].action.items.[INDEX]","typeLabel":"ConversationAction · object"},"type":"array","title":"Action","isRequired":true,"uniqueKey":"conversation_starters.oneOf.0.items.[INDEX].action","typeLabel":"ConversationAction · object[]"}},"type":"object","required":["name","action"],"title":"ConversationStarter","uniqueKey":"conversation_starters.oneOf.0.items.[INDEX]","typeLabel":"ConversationStarter · object"},"title":"Conversation Starters","description":"conversational starters.","uniqueKey":"conversation_starters.oneOf.0","typeLabel":"ConversationStarter · object[]"},{"type":"null","title":"Conversation Starters","description":"conversational starters.","uniqueKey":"conversation_starters.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation_starters","typeLabel":"ConversationStarter · object[] | null"},"dark_mode":{"oneOf":[{"type":"string","title":"Dark Mode","description":"User dark mode information.","uniqueKey":"dark_mode.oneOf.0","typeLabel":"string"},{"type":"null","title":"Dark Mode","description":"User dark mode information.","uniqueKey":"dark_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"dark_mode","typeLabel":"string | null"},"personal_context":{"oneOf":[{"type":"object","title":"PersonalContext","description":"User personal context information.","required":["name","position","traits","additional_personalization"],"properties":{"name":{"oneOf":[{"type":"string","title":"Name","description":"Name","isRequired":true,"uniqueKey":"personal_context.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Name","isRequired":true,"uniqueKey":"personal_context.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"personal_context.oneOf.0.name","typeLabel":"string | null"},"position":{"oneOf":[{"type":"string","title":"Position","description":"Position","isRequired":true,"uniqueKey":"personal_context.oneOf.0.position.oneOf.0","typeLabel":"string"},{"type":"null","title":"Position","description":"Position","isRequired":true,"uniqueKey":"personal_context.oneOf.0.position.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"personal_context.oneOf.0.position","typeLabel":"string | null"},"traits":{"oneOf":[{"type":"string","title":"Traits","description":"Traits","isRequired":true,"uniqueKey":"personal_context.oneOf.0.traits.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traits","description":"Traits","isRequired":true,"uniqueKey":"personal_context.oneOf.0.traits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"personal_context.oneOf.0.traits","typeLabel":"string | null"},"additional_personalization":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"personal_context.oneOf.0.additional_personalization.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Additional Personalization","description":"Additional personalization","isRequired":true,"uniqueKey":"personal_context.oneOf.0.additional_personalization.oneOf.0","typeLabel":"Additional Personalization · object[]"},{"type":"null","title":"Additional Personalization","description":"Additional personalization","isRequired":true,"uniqueKey":"personal_context.oneOf.0.additional_personalization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"personal_context.oneOf.0.additional_personalization","typeLabel":"Additional Personalization · object[] | null"}},"uniqueKey":"personal_context.oneOf.0","typeLabel":"PersonalContext · object"},{"type":"null","description":"User personal context information.","uniqueKey":"personal_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"personal_context","typeLabel":"PersonalContext · object | null"},"enable_follow_up_suggestions":{"oneOf":[{"type":"boolean","title":"Enable Follow Up Suggestions","description":"When true, show follow-up suggestion chips after assistant responses. Defaults to disabled when unset.","uniqueKey":"enable_follow_up_suggestions.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Enable Follow Up Suggestions","description":"When true, show follow-up suggestion chips after assistant responses. Defaults to disabled when unset.","uniqueKey":"enable_follow_up_suggestions.oneOf.1","typeLabel":"null"}],"uniqueKey":"enable_follow_up_suggestions","typeLabel":"boolean | null"},"prompt_presets":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"string","title":"Id","description":"Unique preset id.","isRequired":true,"uniqueKey":"prompt_presets.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"Display name for the preset.","isRequired":true,"uniqueKey":"prompt_presets.oneOf.0.items.[INDEX].name","typeLabel":"string"},"prompt":{"type":"string","title":"Prompt","description":"Prompt text to insert into chat.","isRequired":true,"uniqueKey":"prompt_presets.oneOf.0.items.[INDEX].prompt","typeLabel":"string"},"agent_id":{"oneOf":[{"type":"string","title":"Agent Id","description":"Optional agent id to attach when applying the preset.","uniqueKey":"prompt_presets.oneOf.0.items.[INDEX].agent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Agent Id","description":"Optional agent id to attach when applying the preset.","uniqueKey":"prompt_presets.oneOf.0.items.[INDEX].agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_presets.oneOf.0.items.[INDEX].agent_id","typeLabel":"string | null"},"agent_name":{"oneOf":[{"type":"string","title":"Agent Name","description":"Optional agent display name for the UI.","uniqueKey":"prompt_presets.oneOf.0.items.[INDEX].agent_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Agent Name","description":"Optional agent display name for the UI.","uniqueKey":"prompt_presets.oneOf.0.items.[INDEX].agent_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_presets.oneOf.0.items.[INDEX].agent_name","typeLabel":"string | null"}},"type":"object","required":["id","name","prompt"],"title":"PromptPreset","uniqueKey":"prompt_presets.oneOf.0.items.[INDEX]","typeLabel":"PromptPreset · object"},"title":"Prompt Presets","description":"Personal prompt presets (name, prompt text, optional agent).","uniqueKey":"prompt_presets.oneOf.0","typeLabel":"PromptPreset · object[]"},{"type":"null","title":"Prompt Presets","description":"Personal prompt presets (name, prompt text, optional agent).","uniqueKey":"prompt_presets.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_presets","typeLabel":"PromptPreset · object[] | null"},"language":{"oneOf":[{"type":"string","title":"Language","description":"Preferred UI language code, e.g. 'en', 'he', or 'ja'.","uniqueKey":"language.oneOf.0","typeLabel":"string"},{"type":"null","title":"Language","description":"Preferred UI language code, e.g. 'en', 'he', or 'ja'.","uniqueKey":"language.oneOf.1","typeLabel":"null"}],"uniqueKey":"language","typeLabel":"string | null"}},"type":"object","title":"Settings","uniqueKey":"","typeLabel":"Settings · object"},"examples":{"Example":{"title":"Example","value":{"conversation_starters":[{"name":"\u003cstring>","action":[{"api_name":"\u003cstring>","domain_url":"\u003cstring>","user_input":"\u003cstring>"}]}],"dark_mode":"\u003cstring>","personal_context":{"name":"\u003cstring>","position":"\u003cstring>","traits":"\u003cstring>","additional_personalization":[{}]},"enable_follow_up_suggestions":true,"prompt_presets":[{"id":"\u003cstring>","name":"\u003cstring>","prompt":"\u003cstring>","agent_id":"\u003cstring>","agent_name":"\u003cstring>"}],"language":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"65d1a62b-6a31-43a1-85ae-0752d2f716fe":{"description":"Successful Response","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"67244296-514d-487d-9dfd-3934591d631a":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9069fd66-eee7-40a7-869b-d08756ee7e29":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"938e511d-5b6a-4be8-96ca-1315e9e9ad20":{"url":"https://app.apigene.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"apigene","siteName":"Apigene","title":"Settings Update - Apigene","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-10-08T22:34:33.869Z","originalFileLocation":"api-reference/user/settings-update.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Endpoint to update user-specific settings. Compares the provided settings with existing stored settings for the authenticated user. If changes are detected, the settings are updated accordingly. If no settings exist, a new settings record is created for the user. Args: payload (Settings): A Settings object containing updated user preferences or values. Returns: dict: A confirmation message indicating whether the settings were updated or skipped. Raises: HTTPException 500: If a runtime error occurs during update.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Apigene\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Settings Update - Apigene\">\u003cmeta data-mint-head property=\"og:description\" content=\"Endpoint to update user-specific settings. Compares the provided settings with existing stored settings for the authenticated user. If changes are detected, the settings are updated accordingly. If no settings exist, a new settings record is created for the user. Args: payload (Settings): A Settings object containing updated user preferences or values. Returns: dict: A confirmation message indicating whether the settings were updated or skipped. Raises: HTTPException 500: If a runtime error occurs during update.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Apigene\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.apigene.ai/api-reference/user/settings-update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://apigene.mintlify.site/_mintlify/api/og/v2?division=User\u0026amp;title=Settings+Update\u0026amp;description=Endpoint+to+update+user-specific+settings.%0A%0ACompares+the+provided+settings+with+existing+stored+settings+for+the+authenticated+user.%0AIf+changes+are+detected%2C+th\u0026amp;theme=4640d18c07fdd791a7d31b7b\u0026amp;signature=3842efe19a4406a9f19e14a4ec52edebfe15db11b87955fd7047f298c57f8505\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Settings Update - Apigene\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Endpoint to update user-specific settings. Compares the provided settings with existing stored settings for the authenticated user. If changes are detected, the settings are updated accordingly. If no settings exist, a new settings record is created for the user. Args: payload (Settings): A Settings object containing updated user preferences or values. Returns: dict: A confirmation message indicating whether the settings were updated or skipped. Raises: HTTPException 500: If a runtime error occurs during update.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://apigene.mintlify.site/_mintlify/api/og/v2?division=User\u0026amp;title=Settings+Update\u0026amp;description=Endpoint+to+update+user-specific+settings.%0A%0ACompares+the+provided+settings+with+existing+stored+settings+for+the+authenticated+user.%0AIf+changes+are+detected%2C+th\u0026amp;theme=4640d18c07fdd791a7d31b7b\u0026amp;signature=3842efe19a4406a9f19e14a4ec52edebfe15db11b87955fd7047f298c57f8505\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Apigene\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#626AE9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.apigene.ai/api-reference/user/settings-update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/user/settings-update.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.apigene.ai/#organization\",\"name\":\"Apigene\",\"url\":\"https://docs.apigene.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/apigene/uc-Z_RqMQ0uSxRnH/logo/logo.png?fit=max\u0026auto=format\u0026n=uc-Z_RqMQ0uSxRnH\u0026q=85\u0026s=d3f920afe0cff7053c8f87cd7a3666b7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.apigene.ai#website\",\"name\":\"Apigene\",\"url\":\"https://docs.apigene.ai\",\"publisher\":{\"@id\":\"https://docs.apigene.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.apigene.ai/api-reference/user/settings-update#webpage\",\"url\":\"https://docs.apigene.ai/api-reference/user/settings-update\",\"name\":\"Settings Update\",\"description\":\"Endpoint to update user-specific settings. Compares the provided settings with existing stored settings for the authenticated user. If changes are detected, the settings are updated accordingly. If no settings exist, a new settings record is created for the user. Args: payload (Settings): A Settings object containing updated user preferences or values. Returns: dict: A confirmation message indicating whether the settings were updated or skipped. Raises: HTTPException 500: If a runtime error occurs during update.\",\"dateModified\":\"2025-10-08T22:34:33.869Z\",\"isPartOf\":{\"@id\":\"https://docs.apigene.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.apigene.ai/api-reference/user/settings-update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.apigene.ai/api-reference/user/settings-update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"User\",\"item\":\"https://docs.apigene.ai/api-reference/user/user-me\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Settings Update\",\"item\":\"https://docs.apigene.ai/api-reference/user/settings-update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.apigene.ai/api-reference/user/settings-update#apireference\",\"headline\":\"Settings Update\",\"name\":\"Settings Update\",\"description\":\"Endpoint to update user-specific settings. Compares the provided settings with existing stored settings for the authenticated user. If changes are detected, the settings are updated accordingly. If no settings exist, a new settings record is created for the user. Args: payload (Settings): A Settings object containing updated user preferences or values. Returns: dict: A confirmation message indicating whether the settings were updated or skipped. Raises: HTTPException 500: If a runtime error occurs during update.\",\"url\":\"https://docs.apigene.ai/api-reference/user/settings-update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.apigene.ai/api-reference/user/settings-update#webpage\"},\"dateModified\":\"2025-10-08T22:34:33.869Z\",\"publisher\":{\"@id\":\"https://docs.apigene.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.apigene.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Apigene\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Apigene","nav":{"global":null,"tabs":[{"tab":"User Guide","pages":[{"title":"User Guide","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"API Reference","href":"/api-reference"},{"title":"API Authentication","href":"/api-reference/api-authentication"}]},{"group":"API Specs","pages":[{"openapi":"get /api/specs","title":"Specs List","href":"/api-reference/spec/specs-list"},{"openapi":"post /api/spec_from_file/","title":"Spec Create From File","href":"/api-reference/spec/spec-create-from-file"},{"openapi":"post /api/spec_from_url/","title":"Spec Create From Url","href":"/api-reference/spec/spec-create-from-url"},{"openapi":"post /api/spec_from_wsdl/","title":"Spec Create From Wsdl","href":"/api-reference/spec/spec-create-from-wsdl"},{"openapi":"post /api/wsdl_ports/","title":"Wsdl List Ports","href":"/api-reference/spec/spec-wsdl-ports"},{"openapi":"get /api/spec/{api_name}","title":"Spec Get","href":"/api-reference/spec/spec-get"},{"openapi":"delete /api/spec/{api_name}","title":"Spec Delete","href":"/api-reference/spec/spec-delete"},{"openapi":"get /api/spec/{api_name}/agentic_metadata","title":"Spec Get Agentic Metadata","href":"/api-reference/spec/spec-get-agentic-metadata"},{"openapi":"get /api/spec/{api_name}/agentic_metadata_common_parameteres","title":"Spec Get Agentic Metadata Common Parameteres","href":"/api-reference/spec/spec-get-agentic-metadata-common-parameteres"},{"openapi":"get /api/spec/{api_name}/available_scopes","title":"Spec Scopes","href":"/api-reference/spec/spec-scopes"},{"openapi":"post /api/spec/{api_name}/clone","title":"Spec Clone","href":"/api-reference/spec/spec-clone"},{"openapi":"get /api/spec/{api_name}/export","title":"Export provisioned spec","href":"/api-reference/spec/spec-export"},{"openapi":"post /api/spec/import","title":"Import provisioned spec","href":"/api-reference/spec/spec-import"},{"openapi":"post /api/spec/{api_name}/create_agentic_metadata","title":"Spec Create Agentic Metadata","href":"/api-reference/spec/spec-create-agentic-metadata"},{"openapi":"get /api/spec/{api_name}/insigths","title":"Spec Insights","href":"/api-reference/spec/spec-insights"},{"openapi":"post /api/spec/{api_name}/operation_examples","title":"Spec Operation Examples","href":"/api-reference/spec/spec-operation-examples"},{"openapi":"post /api/spec/{api_name}/operation_schema","title":"Spec Operation Schema","href":"/api-reference/spec/spec-operation-schema"},{"openapi":"get /api/spec/{api_name}/operations","title":"Spec Operations","href":"/api-reference/spec/spec-operations"},{"openapi":"post /api/spec/{api_name}/reindex","title":"Spec Reindex","href":"/api-reference/spec/spec-reindex"},{"openapi":"get /api/spec/{api_name}/reindex_status/active","title":"Spec Reindex Status Active","href":"/api-reference/spec/spec-reindex-status-active"},{"openapi":"get /api/spec/{api_name}/schema","title":"Spec Get Schema","href":"/api-reference/spec/spec-get-schema"},{"openapi":"get /api/spec/{api_name}/shared-security","title":"Spec Get Shared Security","href":"/api-reference/spec/spec-get-shared-security"},{"openapi":"put /api/spec/{api_name}/shared-security","title":"Spec Set Shared Security","href":"/api-reference/spec/spec-set-shared-security"},{"openapi":"post /api/spec/{api_name}/summary","title":"Spec Summary","href":"/api-reference/spec/spec-summary"},{"openapi":"post /api/spec/{api_name}/update","title":"Spec Update","href":"/api-reference/spec/spec-update"},{"openapi":"put /api/spec/{api_name}/update_agentic_metadata","title":"Spec Update Agentic Metadata","href":"/api-reference/spec/spec-update-agentic-metadata"},{"openapi":"post /api/spec/{api_name}/use_cases","title":"Spec Use Cases","href":"/api-reference/spec/spec-use-cases"},{"openapi":"get /api/spec/{task_id}/reindex_status","title":"Spec Reindex Status","href":"/api-reference/spec/spec-reindex-status"}]},{"group":"Interaction","pages":[{"openapi":"post /api/interaction/activity-timeline","title":"Get Activity Timeline","href":"/api-reference/interaction/get-activity-timeline"},{"openapi":"post /api/interaction/create","title":"Interaction Create","href":"/api-reference/interaction/interaction-create"},{"openapi":"post /api/interaction/list","title":"List Interactions","href":"/api-reference/interaction/list-interactions"},{"openapi":"post /api/interaction/record-mcp-tool","title":"Record Mcp Tool","href":"/api-reference/interaction/interaction-record-mcp-tool"},{"openapi":"post /api/interaction/summary","title":"Get Summary","href":"/api-reference/interaction/get-summary"},{"openapi":"get /api/interaction/insights/{app_name}","title":"Get App Insights","href":"/api-reference/interaction/get-app-insights"},{"openapi":"get /api/interaction/{interaction_id}","title":"Get Interaction Detail","href":"/api-reference/interaction/get-interaction-detail"}]},{"group":"MCP","pages":[{"openapi":"get /api/mcp/app_get_action_details","title":"App Get Action Details","href":"/api-reference/mcp/mcp-app-get-action-details"},{"openapi":"get /api/mcp/app_get_actions","title":"App Get Actions","href":"/api-reference/mcp/mcp-app-get-actions"},{"openapi":"get /api/mcp/appconfig","title":"Get App Config","href":"/api-reference/mcp/mcp-appconfig"},{"openapi":"get /api/mcp/apps_list","title":"Apps List","href":"/api-reference/mcp/mcp-apps-list"},{"openapi":"get /api/mcp/apps_search_actions","title":"Apps Search Actions","href":"/api-reference/mcp/mcp-apps-search-actions"},{"openapi":"get /api/mcp/get_context","title":"Get Context","href":"/api-reference/mcp/mcp-get-context"},{"openapi":"get /api/mcp/get_instructions","title":"Get Instructions","href":"/api-reference/mcp/mcp-get-instructions"},{"openapi":"get /api/mcp/get_skill","title":"Get Skill","href":"/api-reference/mcp/get-skill"},{"openapi":"get /api/mcp/get_skill_content","title":"Get Skill Content","href":"/api-reference/mcp/get-skill-content"},{"openapi":"get /api/mcp/list_contexts","title":"List Contexts","href":"/api-reference/mcp/mcp-list-contexts"},{"openapi":"get /api/mcp/list_skills","title":"List Skills","href":"/api-reference/mcp/list-skills"},{"openapi":"post /api/mcp/app_execute_action","title":"App Execute Action","href":"/api-reference/mcp/mcp-app-execute-action"},{"openapi":"post /api/mcp/create_skill","title":"Create Skill","href":"/api-reference/mcp/mcp-create-skill"}]},{"group":"MCP Server","pages":[{"openapi":"get /api/mcp-server/list","title":"Mcp Servers List","href":"/api-reference/mcp-server/mcp-servers-list"},{"openapi":"post /api/mcp-server/create","title":"Mcp Server Create","href":"/api-reference/mcp-server/mcp-server-create"},{"openapi":"post /api/mcp-server/create_from_api","title":"Mcp Create From Api","href":"/api-reference/mcp-server/mcp-create-from-api"},{"openapi":"delete /api/mcp-server/delete/{server_id}","title":"Mcp Server Delete","href":"/api-reference/mcp-server/mcp-server-delete"},{"openapi":"get /api/mcp-server/get/{server_id}","title":"Mcp Server Get","href":"/api-reference/mcp-server/mcp-server-get"},{"openapi":"post /api/mcp-server/refresh-tools/{server_id}","title":"Mcp Server Refresh Tools","href":"/api-reference/mcp-server/mcp-server-refresh-tools"},{"openapi":"post /api/mcp-server/login/{server_id}","title":"Mcp Server Login","href":"/api-reference/mcp-server/mcp-server-login"},{"openapi":"post /api/mcp-server/logout/{server_id}","title":"Mcp Server Logout","href":"/api-reference/mcp-server/mcp-server-logout"},{"openapi":"post /api/mcp-server/update-tools-cache/{server_id}","title":"Mcp Server Update Tools Cache","href":"/api-reference/mcp-server/mcp-server-update-tools-cache"},{"openapi":"put /api/mcp-server/update/{server_id}","title":"Mcp Server Update","href":"/api-reference/mcp-server/mcp-server-update"}]},{"group":"Official MCP Server","pages":[{"openapi":"get /api/official-mcp-server","title":"Official Mcp Server List","href":"/api-reference/official-mcp-server/official-mcp-server-list"},{"openapi":"post /api/official-mcp-server","title":"Official Mcp Server Create","href":"/api-reference/official-mcp-server/official-mcp-server-create"},{"openapi":"get /api/official-mcp-server/{server_id}","title":"Official Mcp Server Get","href":"/api-reference/official-mcp-server/official-mcp-server-get"},{"openapi":"put /api/official-mcp-server/{server_id}","title":"Official Mcp Server Update","href":"/api-reference/official-mcp-server/official-mcp-server-update"},{"openapi":"delete /api/official-mcp-server/{server_id}","title":"Official Mcp Server Delete","href":"/api-reference/official-mcp-server/official-mcp-server-delete"}]},{"group":"Agent","pages":[{"openapi":"get /api/agent/get_by_name","title":"Agent Get By Name","href":"/api-reference/agent/agent-get-by-name"},{"openapi":"get /api/agent/list","title":"Agents List","href":"/api-reference/agent/agents-list"},{"openapi":"post /api/agent/create","title":"Agent Create","href":"/api-reference/agent/agent-create"},{"openapi":"delete /api/agent/delete/{agent_id}","title":"Agent Delete","href":"/api-reference/agent/agent-delete"},{"openapi":"get /api/agent/get/{agent_id}","title":"Agent Get","href":"/api-reference/agent/agent-get"},{"openapi":"put /api/agent/update/{agent_id}","title":"Agent Update","href":"/api-reference/agent/agent-update"}]},{"group":"Skill","pages":[{"openapi":"get /api/skill","title":"Skill List","href":"/api-reference/skill/skill-list"},{"openapi":"get /api/skill/search","title":"Skill Search","href":"/api-reference/skill/skill-search"},{"openapi":"post /api/skill","title":"Skill Create","href":"/api-reference/skill/skill-create"},{"openapi":"post /api/skill/upload","title":"Skill Upload","href":"/api-reference/skill/skill-upload"},{"openapi":"post /api/skill/validate","title":"Skill Validate","href":"/api-reference/skill/skill-validate"},{"openapi":"get /api/skill/{skill_id}","title":"Skill Get","href":"/api-reference/skill/skill-get"},{"openapi":"put /api/skill/{skill_id}","title":"Skill Update","href":"/api-reference/skill/skill-update"},{"openapi":"delete /api/skill/{skill_id}","title":"Skill Delete","href":"/api-reference/skill/skill-delete"},{"openapi":"get /api/skill/{skill_id}/file","title":"Skill Get File","href":"/api-reference/skill/skill-get-file"}]},{"group":"Workflows","pages":[{"openapi":"get /api/workflows/{agent_name}","title":"List workflows for an agent","href":"/api-reference/workflow/workflow-list"},{"openapi":"post /api/workflows/{agent_name}","title":"Create a workflow for an agent","href":"/api-reference/workflow/workflow-create"},{"openapi":"post /api/workflows/runs/list","title":"List workflow run history (org-wide, summary projection)","href":"/api-reference/workflow/workflow-runs-history-list"},{"openapi":"get /api/workflows/runs/{run_id}","title":"Get a workflow run by id (full detail, no checkpoint)","href":"/api-reference/workflow/workflow-run-history-get"},{"openapi":"post /api/workflows/runs/activity-timeline","title":"Workflow run activity histogram by status","href":"/api-reference/workflow/workflow-runs-activity-timeline"},{"openapi":"get /api/workflows/{agent_name}/runs/{run_id}","title":"Get a persisted HITL workflow run by id","href":"/api-reference/workflow/workflow-run-get"},{"openapi":"post /api/workflows/{agent_name}/runs/{run_id}/resume","title":"Resume a waiting_human workflow run (starter only)","href":"/api-reference/workflow/workflow-run-resume"},{"openapi":"get /api/workflows/{agent_name}/{workflow_id}","title":"Get a workflow by id","href":"/api-reference/workflow/workflow-get"},{"openapi":"put /api/workflows/{agent_name}/{workflow_id}","title":"Update a workflow","href":"/api-reference/workflow/workflow-update"},{"openapi":"delete /api/workflows/{agent_name}/{workflow_id}","title":"Delete a workflow","href":"/api-reference/workflow/workflow-delete"},{"openapi":"post /api/workflows/{agent_name}/{workflow_id}/run","title":"Run a stored workflow by id","href":"/api-reference/workflow/workflow-run"},{"openapi":"get /api/workflows/{agent_name}/{workflow_id}/runs","title":"List runs for a workflow","href":"/api-reference/workflow/workflow-runs-list"}]},{"group":"Task","pages":[{"openapi":"get /api/task","title":"Task List","href":"/api-reference/task/task-list"},{"openapi":"post /api/task","title":"Task Create","href":"/api-reference/task/task-create"},{"openapi":"post /api/task/generate","title":"Task Generate","href":"/api-reference/task/task-generate"},{"openapi":"get /api/task/{task_id}","title":"Task Get","href":"/api-reference/task/task-get"},{"openapi":"put /api/task/{task_id}","title":"Task Update","href":"/api-reference/task/task-update"},{"openapi":"delete /api/task/{task_id}","title":"Task Delete","href":"/api-reference/task/task-delete"},{"openapi":"post /api/task/{task_id}/background_run","title":"Task Background Run","href":"/api-reference/task/task-background-run"},{"openapi":"get /api/task/{task_id}/scheduled_runs_results","title":"Task Get Scheduled Runs Results","href":"/api-reference/task/task-get-scheduled-runs-results"}]},{"group":"Context","pages":[{"openapi":"get /api/context","title":"Context List","href":"/api-reference/context/context-list"},{"openapi":"get /api/context/search","title":"Context Search","href":"/api-reference/context/context-search"},{"openapi":"post /api/context","title":"Context Create","href":"/api-reference/context/context-create"},{"openapi":"get /api/context/{context_id}","title":"Context Get","href":"/api-reference/context/context-get"},{"openapi":"put /api/context/{context_id}","title":"Context Update","href":"/api-reference/context/context-update"},{"openapi":"delete /api/context/{context_id}","title":"Context Delete","href":"/api-reference/context/context-delete"}]},{"group":"Context Type","pages":[{"openapi":"get /api/context-type","title":"Context Type List","href":"/api-reference/context-type/context-type-list"},{"openapi":"get /api/context-type/defaults","title":"Context Type List Defaults","href":"/api-reference/context-type/context-type-list-defaults"},{"openapi":"post /api/context-type","title":"Context Type Create","href":"/api-reference/context-type/context-type-create"},{"openapi":"get /api/context-type/{context_type_id}","title":"Context Type Get","href":"/api-reference/context-type/context-type-get"},{"openapi":"put /api/context-type/{context_type_id}","title":"Context Type Update","href":"/api-reference/context-type/context-type-update"},{"openapi":"delete /api/context-type/{context_type_id}","title":"Context Type Delete","href":"/api-reference/context-type/context-type-delete"}]},{"group":"GPT","pages":[{"openapi":"get /api/gpts/list","title":"Gpts List","href":"/api-reference/gpt/gpts-list"},{"openapi":"post /api/gpt/create","title":"Gpt Create","href":"/api-reference/gpt/gpt-create"},{"openapi":"post /api/gpt/create_all","title":"Gpt Create All","href":"/api-reference/gpt/gpt-create-all"},{"openapi":"post /api/gpt/create_from_api","title":"Gpt Create From Api","href":"/api-reference/gpt/gpt-create-from-api"},{"openapi":"post /api/gpt/update","title":"Gpt Update","href":"/api-reference/gpt/gpt-update"},{"openapi":"get /api/gpt/redirect/{token}","title":"redirect the shorten url to full authorization url","href":"/api-reference/gpt/gpt-redirect-to-authorization"},{"openapi":"delete /api/gpt/{genai_app}/delete","title":"Gpt Delete","href":"/api-reference/gpt/gpt-delete"},{"openapi":"post /api/gpt/{genai_app}/generate_token","title":"Gpt Generate Token","href":"/api-reference/gpt/gpt-generate-token"},{"openapi":"get /api/gpt/{genai_app}/get","title":"Retrieve Custom GPT Details","href":"/api-reference/gpt/gpt-get"},{"openapi":"get /api/gpt/{genai_app}/read_token","title":"Gpt Read Token","href":"/api-reference/gpt/gpt-read-token-id"},{"openapi":"post /api/gpt/{genai_app}/revoke_token","title":"Gpt Revoke Token","href":"/api-reference/gpt/gpt-revoke-token"}]},{"group":"GPT Public","pages":[{"openapi":"get /api/gpt_public/app_get_actions","title":"App Get Actions","href":"/api-reference/gpt-public/app-get-actions"},{"openapi":"get /api/gpt_public/apps_list","title":"Apps List","href":"/api-reference/gpt-public/apps-list"},{"openapi":"get /api/gpt_public/apps_search_actions","title":"Apps Search Actions","href":"/api-reference/gpt-public/apps-search-actions"},{"openapi":"get /api/openapi","title":"Get Gpt Public Openapi","href":"/api-reference/gpt-public/get-gpt-public-openapi"},{"openapi":"post /api/gpt_public/app_execute_action","title":"App Execute Action","href":"/api-reference/gpt-public/app-execute-action"}]},{"group":"UI Templates","pages":[{"openapi":"get /api/ui-templates","title":"List all APIs with their templates","href":"/api-reference/ui-templates/ui-templates-list-all"},{"openapi":"get /api/ui-templates/{api_name}","title":"List all UI templates for an API","href":"/api-reference/ui-templates/ui-templates-list-by-api"},{"openapi":"get /api/ui-templates/{api_name}/operations/{operation_id}","title":"List UI templates for an operation","href":"/api-reference/ui-templates/ui-templates-list-by-operation"},{"openapi":"get /api/ui-templates/{api_name}/{template_id}","title":"Get a UI template by ID","href":"/api-reference/ui-templates/ui-template-get"},{"openapi":"put /api/ui-templates/{api_name}/{template_id}","title":"Create or update a UI template","href":"/api-reference/ui-templates/ui-template-upsert"},{"openapi":"delete /api/ui-templates/{api_name}/{template_id}","title":"Delete a UI template","href":"/api-reference/ui-templates/ui-template-delete"},{"openapi":"put /api/ui-templates/{api_name}/{template_id}/set-default","title":"Set a UI template as the default for its operation","href":"/api-reference/ui-templates/ui-template-set-default"}]},{"group":"Generative UI Templates","pages":[{"openapi":"get /api/generative-ui-templates/{agent_name}","title":"List generative UI templates for an agent","href":"/api-reference/generative-ui-templates/generative-ui-template-list"},{"openapi":"post /api/generative-ui-templates/{agent_name}","title":"Create a generative UI template for an agent","href":"/api-reference/generative-ui-templates/generative-ui-template-create"},{"openapi":"get /api/generative-ui-templates/{agent_name}/{template_id}","title":"Get a generative UI template by id","href":"/api-reference/generative-ui-templates/generative-ui-template-get"},{"openapi":"put /api/generative-ui-templates/{agent_name}/{template_id}","title":"Update a generative UI template","href":"/api-reference/generative-ui-templates/generative-ui-template-update"},{"openapi":"delete /api/generative-ui-templates/{agent_name}/{template_id}","title":"Delete a generative UI template","href":"/api-reference/generative-ui-templates/generative-ui-template-delete"}]},{"group":"GitHub Sync","pages":[{"openapi":"post /api/ui-templates/github/connect/{api_name}/{template_id}","title":"Connect template to GitHub repository","href":"/api-reference/github-sync/github-sync-connect"},{"openapi":"delete /api/ui-templates/github/disconnect/{api_name}/{template_id}","title":"Disconnect template from GitHub","href":"/api-reference/github-sync/github-sync-disconnect"},{"openapi":"get /api/ui-templates/github/history/{api_name}/{template_id}","title":"Get GitHub sync history","href":"/api-reference/github-sync/github-sync-history"},{"openapi":"get /api/ui-templates/github/status/{api_name}/{template_id}","title":"Get GitHub sync status","href":"/api-reference/github-sync/github-sync-status"},{"openapi":"post /api/ui-templates/github/sync/{api_name}/{template_id}","title":"Sync template with GitHub","href":"/api-reference/github-sync/github-sync"}]},{"group":"Audit","pages":[{"openapi":"get /api/audit/audit-logs","title":"Get Audit Logs","href":"/api-reference/audit/audit-logs"},{"openapi":"get /api/audit/audit-logs/resource/{resource_type}/{resource_id}","title":"Get Resource Audit History","href":"/api-reference/audit/resource-audit-history"}]},{"group":"Organization","pages":[{"openapi":"get /api/org/settings","title":"Retrieve Organization settings","href":"/api-reference/org/retrieve-organization-settings"},{"openapi":"post /api/org/add_user/","title":"Org Add User","href":"/api-reference/org/org-add-user"},{"openapi":"post /api/org/create/","title":"Org Create","href":"/api-reference/org/org-create"},{"openapi":"post /api/org/settings/update","title":"Org Settings Update","href":"/api-reference/org/org-settings-update"},{"openapi":"post /api/org/apply_license","title":"Apply OnPrem License","href":"/api-reference/org/org-apply-license"},{"openapi":"delete /api/org/delete/{org_name}","title":"Org Delete","href":"/api-reference/org/org-delete"},{"openapi":"get /api/org/details/{org_name}","title":"Org Get Details","href":"/api-reference/org/org-get-details"},{"openapi":"delete /api/org/remove_user/{username}","title":"Org Remove User","href":"/api-reference/org/org-remove-user"},{"openapi":"post /api/org/{org_name}/generate_token","title":"Org Generate Token","href":"/api-reference/org/org-generate-token"}]},{"group":"User","pages":[{"openapi":"get /api/user/me","title":"User Me","href":"/api-reference/user/user-me"},{"openapi":"get /api/user/settings","title":"Retrieve User settings","description":"This endpoint retrieves a user settings configuration.","href":"/api-reference/user/retrieve-user-settings"},{"openapi":"post /api/user/settings/update","title":"Settings Update","href":"/api-reference/user/settings-update"},{"openapi":"post /api/user/signup/","title":"User Signup","description":"Endpoint for user registration.\n\nThis endpoint allows users to sign up by providing necessary user data.\nUpon successful registration, a new user is created and added to the database.\nSelf-service signup with org_name creates an Admin user and provisions the organization.\n\nParameters:\n- user_data: UserCreate - Data required to create a new user.\n\nReturns:\n- dict: A dictionary containing a success message upon successful user creation.","href":"/api-reference/user/user-signup"},{"openapi":"post /api/user/token","title":"User Token","href":"/api-reference/user/user-token"}]},{"group":"System","pages":[{"openapi":"get /api/health","title":"Health Check","href":"/api-reference/system/health-check"},{"openapi":"get /api/platform/version","title":"Get Platform Version Endpoint","href":"/api-reference/system/get-platform-version-endpoint"},{"openapi":"get /api/version","title":"Get Version","href":"/api-reference/system/get-version"}]},{"group":"Cache","pages":[{"openapi":"get /api/cache/key","title":"Get Cache Key","href":"/api-reference/cache/get-cache-key"},{"openapi":"get /api/cache/keys","title":"Get Tenant Cache Keys","href":"/api-reference/cache/get-tenant-cache-keys"},{"openapi":"post /api/cache_clear","title":"Clear Tenant Cache","href":"/api-reference/cache/clear-tenant-cache"},{"openapi":"delete /api/cache/key","title":"Delete Cache Key","href":"/api-reference/cache/delete-cache-key"}]}]}]},"basePath":"","title":"Settings Update - Apigene","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}