Emails of the workspace members to set as editors of the agent. Omitting this field keeps the current editors; providing it replaces the whole list.
Example:
["alice@example.com"]
skills
object[]
Replaces the skills enabled on the agent configuration.
Show child attributes
toolset
object[]
Replaces the full set of tools on the agent. Any tool not present in this array is removed, so send the complete desired toolset. Each entry resolves an MCP server by name (see configuration.mcp_server_name). Entries that cannot be resolved are not applied and are returned in the skippedActions field of the response rather than causing the whole request to fail.
Show child attributes
Response
Successfully updated agent configuration
agentConfiguration
object
Show child attributes
skippedActions
object[]
Toolset entries that could not be applied (e.g. the referenced MCP server was not found, is not shared to an accessible space, or the name was ambiguous). The request still succeeds; inspect this list to confirm every intended tool was attached.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ruby Docs","colors":{"primary":"#0284C7","light":"#7DD3FC","dark":"#38BDF8"},"logo":{"light":"https://mintcdn.com/ruby-ai/6ikFcKxC_qkkSD3O/branding/ruby-icon.png?fit=max\u0026auto=format\u0026n=6ikFcKxC_qkkSD3O\u0026q=85\u0026s=52c94238d53b46396e117b7fc123cf72","dark":"https://mintcdn.com/ruby-ai/6ikFcKxC_qkkSD3O/branding/ruby-icon.png?fit=max\u0026auto=format\u0026n=6ikFcKxC_qkkSD3O\u0026q=85\u0026s=52c94238d53b46396e117b7fc123cf72"},"favicon":"https://mintcdn.com/ruby-ai/6ikFcKxC_qkkSD3O/branding/ruby-icon.png?fit=max\u0026auto=format\u0026n=6ikFcKxC_qkkSD3O\u0026q=85\u0026s=52c94238d53b46396e117b7fc123cf72","fonts":{"heading":{"family":"Ruby Serif","weight":300,"source":"fonts/RubySerif.woff2","format":"woff2"},"body":{"family":"Ruby Sans","weight":400,"source":"fonts/RubySans-RegularText.woff2","format":"woff2"}},"contextual":{"options":["copy","download-spec"],"display":"header"},"thumbnails":{"appearance":"light"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ruby-ai","hasAudioNarration":false,"actualSubdomain":"ruby-ai","customDomains":["docs.ruby.ad"],"gitSource":{"type":"github","owner":"ruby-ai-ops","repo":"ruby-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ad9209d2f28b0ccba1c5f3b","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Capabilities","count":90},{"language":"default","tag":"Developers","count":76},{"language":"default","tag":"Ruby API Documentation","count":69},{"language":"default","tag":"Tools","count":56},{"language":"default","tag":"Use cases","count":49},{"language":"default","tag":"Admins","count":42},{"language":"default","tag":"FAQ","count":29},{"language":"default","tag":"Agents","count":27},{"language":"default","tag":"Datasources","count":16},{"language":"default","tag":"Integrations","count":15}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":is(h1,h2,h3,h4,h5,h6){font-family:\"Ruby Serif\", Georgia, serif!important;font-weight:300!important}:is(h1,h2,h3,h4,h5,h6) :is(span,strong,b){font-family:inherit!important;font-weight:inherit!important}body,:is(#navbar,#sidebar,#content-area,#table-of-contents,#mobile-nav) :is(p,li,a,button,label,small,span){font-family:\"Ruby Sans\", Arial, sans-serif;letter-spacing:0.012em}:is(#sidebar,#mobile-nav) .sidebar-title,:is(#sidebar,#mobile-nav) .sidebar-title span{font-family:\"Ruby Serif\", Georgia, serif;font-weight:300}:is(#sidebar,#mobile-nav) a[aria-current=\"page\"],:is(#sidebar,#mobile-nav) a[aria-current=\"page\"] *{font-weight:400!important;text-shadow:none!important}#content-area :is(p,li,blockquote,figcaption),#content-area [data-as=\"p\"],#content-area [data-component-part=\"card-content\"],#content-area [data-component-part=\"card-content\"] *{font-weight:300!important}#content-area :is(strong,b){font-weight:500!important}html.dark :is(#navbar,#sidebar,#mobile-nav,#table-of-contents,#content-area){color:#fff}html.dark :is(#navbar,#sidebar,#mobile-nav,#table-of-contents) :is(a,button,label,small,span),html.dark #content-area :is(h1,h2,h3,h4,h5,h6,p,li,dt,dd,blockquote,figcaption,th,td,a,button,label,small,strong,b),html.dark #content-area [data-component-part=\"card-content\"],html.dark #content-area [data-component-part=\"card-content\"] *,html.dark #content-area :is(h1,h2,h3,h4,h5,h6,p,li,dt,dd,blockquote,figcaption,th,td,a,button,label,small)>span{color:#fff!important;opacity:1!important}html.dark :is(#navbar,#sidebar,#mobile-nav,#table-of-contents,#content-area) :is(a,button):hover{color:#7dd3fc!important}"}]}
{"page":{"pagePath":"api-reference/agents/update-agent-configuration","slug":"/api-reference/agents/update-agent-configuration","pageMetadata":{"title":"Update agent configuration","description":"Update the agent configuration identified by {sId} in the workspace identified by {wId}.","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json patch /api/v1/w/{wId}/assistant/agent_configurations/{sId}","href":"/api-reference/agents/update-agent-configuration","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Update the agent configuration identified by \", \" in the workspace identified by \", \".\"]\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":{"title":"Update agent configuration","description":"Update the agent configuration identified by {sId} in the workspace identified by {wId}.","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json patch /api/v1/w/{wId}/assistant/agent_configurations/{sId}","href":"/api-reference/agents/update-agent-configuration","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update agent configuration","description":"Update the agent configuration identified by {sId} in the workspace identified by {wId}.","tags":["Agents"],"parameters":["1bd92ee5-4bd5-4c3b-859a-9f8112d8f34a","179285c1-14de-4dae-8ab5-c5c043940754"],"requestBody":"f571ad82-98ae-4b3f-aae0-29cb06c5ca4a","security":["71124445-bcf9-4ce5-98e1-e1bd1e0765a8"],"responses":{"200":"a1560861-287f-4a2b-b6da-4614c34e4840","400":"97c80821-b629-4306-af09-2ab6e550dc5b","401":"10bea615-cedb-443c-a63a-10dccc4a5b9c","403":"228976de-2031-4880-aafd-5323391479ee","404":"8eced24a-76b2-45a3-853e-c0ea30fab7a6","500":"b4ce1aac-db2d-4de6-8588-d41ce1a609df"},"method":"patch","type":"path","servers":["51bbd201-d386-49c6-a605-c8c992b93b27"],"path":"/api/v1/w/{wId}/assistant/agent_configurations/{sId}","baseUrlOptions":["https://app.ruby.ad"],"title":"Update agent configuration","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1bd92ee5-4bd5-4c3b-859a-9f8112d8f34a":{"in":"path","name":"wId","required":true,"description":"ID of the workspace","schema":{"type":"string","isRequired":true,"description":"ID of the workspace","uniqueKey":"","typeLabel":"string"}},"179285c1-14de-4dae-8ab5-c5c043940754":{"in":"path","name":"sId","required":true,"description":"ID of the agent configuration","schema":{"type":"string","isRequired":true,"description":"ID of the agent configuration","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userFavorite":{"type":"boolean","uniqueKey":"userFavorite","typeLabel":"boolean"},"agent":{"type":"object","properties":{"handle":{"type":"string","uniqueKey":"agent.handle","typeLabel":"string"},"description":{"type":"string","uniqueKey":"agent.description","typeLabel":"string"},"scope":{"type":"string","enum":["visible","hidden"],"uniqueKey":"agent.scope","typeLabel":"enum\u003cstring>"},"avatar_url":{"type":"string","uniqueKey":"agent.avatar_url","typeLabel":"string"},"max_steps_per_run":{"type":"number","uniqueKey":"agent.max_steps_per_run","typeLabel":"number"},"visualization_enabled":{"type":"boolean","uniqueKey":"agent.visualization_enabled","typeLabel":"boolean"}},"uniqueKey":"agent","typeLabel":"object"},"instructions":{"type":"string","uniqueKey":"instructions","typeLabel":"string"},"generation_settings":{"type":"object","properties":{"model_id":{"type":"string","uniqueKey":"generation_settings.model_id","typeLabel":"string"},"provider_id":{"type":"string","uniqueKey":"generation_settings.provider_id","typeLabel":"string"},"temperature":{"type":"number","uniqueKey":"generation_settings.temperature","typeLabel":"number"},"reasoning_effort":{"type":"string","uniqueKey":"generation_settings.reasoning_effort","typeLabel":"string"}},"uniqueKey":"generation_settings","typeLabel":"object"},"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"tags.items.[INDEX].name","typeLabel":"string"},"kind":{"type":"string","enum":["standard","protected"],"uniqueKey":"tags.items.[INDEX].kind","typeLabel":"enum\u003cstring>"}},"uniqueKey":"tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tags","typeLabel":"object[]"},"editors":{"type":"array","description":"Emails of the workspace members to set as editors of the agent. Omitting this field keeps the current editors; providing it replaces the whole list.","items":{"type":"string","format":"email","uniqueKey":"editors.items.[INDEX]","typeLabel":"string\u003cemail>"},"example":["alice@example.com"],"uniqueKey":"editors","typeLabel":"string\u003cemail>[]"},"skills":{"type":"array","description":"Replaces the skills enabled on the agent configuration.","items":{"type":"object","required":["sId","name"],"properties":{"sId":{"type":"string","isRequired":true,"uniqueKey":"skills.items.[INDEX].sId","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"skills.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"skills.items.[INDEX]","typeLabel":"object"},"uniqueKey":"skills","typeLabel":"object[]"},"toolset":{"type":"array","description":"Replaces the full set of tools on the agent. Any tool not present in this array is removed, so send the complete desired toolset. Each entry resolves an MCP server by name (see configuration.mcp_server_name). Entries that cannot be resolved are not applied and are returned in the skippedActions field of the response rather than causing the whole request to fail.","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"toolset.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"toolset.items.[INDEX].description","typeLabel":"string"},"type":{"type":"string","enum":["MCP"],"uniqueKey":"toolset.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"configuration":{"type":"object","properties":{"mcp_server_name":{"type":"string","description":"Name of the MCP server to attach. Both built-in (internal) tools and remote MCP servers are supported. A remote MCP server must first be shared to a space (global or a regular space the caller can access); it is matched by its display name, which must be unambiguous within the workspace.","uniqueKey":"toolset.items.[INDEX].configuration.mcp_server_name","typeLabel":"string"}},"uniqueKey":"toolset.items.[INDEX].configuration","typeLabel":"object"}},"uniqueKey":"toolset.items.[INDEX]","typeLabel":"object"},"uniqueKey":"toolset","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"userFavorite":true,"agent":{"handle":"\u003cstring>","description":"\u003cstring>","avatar_url":"\u003cstring>","max_steps_per_run":123,"visualization_enabled":true},"instructions":"\u003cstring>","generation_settings":{"model_id":"\u003cstring>","provider_id":"\u003cstring>","temperature":123,"reasoning_effort":"\u003cstring>"},"tags":[{"name":"\u003cstring>"}],"editors":["alice@example.com"],"skills":[{"sId":"\u003cstring>","name":"\u003cstring>"}],"toolset":[{"name":"\u003cstring>","description":"\u003cstring>","type":"MCP","configuration":{"mcp_server_name":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a1560861-287f-4a2b-b6da-4614c34e4840":{"description":"Successfully updated agent configuration","content":{"application/json":{"schema":{"type":"object","properties":{"agentConfiguration":{"type":"object","properties":{"id":{"type":"integer","example":12345,"uniqueKey":"agentConfiguration.id","typeLabel":"integer"},"agentModelId":{"oneOf":[{"type":"integer","description":"Stable identifier of the agent across versions; null for global agents","example":6789,"uniqueKey":"agentConfiguration.agentModelId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Stable identifier of the agent across versions; null for global agents","example":6789,"uniqueKey":"agentConfiguration.agentModelId.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentConfiguration.agentModelId","typeLabel":"integer | null"},"sId":{"type":"string","description":"Unique string identifier for the agent configuration","example":"7f3a9c2b1e","uniqueKey":"agentConfiguration.sId","typeLabel":"string"},"version":{"type":"integer","example":2,"uniqueKey":"agentConfiguration.version","typeLabel":"integer"},"versionCreatedAt":{"oneOf":[{"type":"string","description":"Timestamp of when the version was created","example":"2023-06-15T14:30:00Z","uniqueKey":"agentConfiguration.versionCreatedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timestamp of when the version was created","example":"2023-06-15T14:30:00Z","uniqueKey":"agentConfiguration.versionCreatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentConfiguration.versionCreatedAt","typeLabel":"string | null"},"versionAuthorId":{"oneOf":[{"type":"string","description":"ID of the user who created this version","example":"0ec9852c2f","uniqueKey":"agentConfiguration.versionAuthorId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the user who created this version","example":"0ec9852c2f","uniqueKey":"agentConfiguration.versionAuthorId.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentConfiguration.versionAuthorId","typeLabel":"string | null"},"name":{"type":"string","description":"Name of the agent configuration","example":"Customer Support Agent","uniqueKey":"agentConfiguration.name","typeLabel":"string"},"description":{"type":"string","description":"Description of the agent configuration","example":"An AI agent designed to handle customer support inquiries","uniqueKey":"agentConfiguration.description","typeLabel":"string"},"instructions":{"oneOf":[{"type":"string","description":"Instructions for the agent","example":"Always greet the customer politely and try to resolve their issue efficiently.","uniqueKey":"agentConfiguration.instructions.oneOf.0","typeLabel":"string"},{"type":"null","description":"Instructions for the agent","example":"Always greet the customer politely and try to resolve their issue efficiently.","uniqueKey":"agentConfiguration.instructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentConfiguration.instructions","typeLabel":"string | null"},"pictureUrl":{"type":"string","description":"URL of the agent's picture","example":"https://example.com/agent-images/support-agent.png","uniqueKey":"agentConfiguration.pictureUrl","typeLabel":"string"},"status":{"type":"string","description":"Current status of the agent configuration","example":"active","uniqueKey":"agentConfiguration.status","typeLabel":"string"},"scope":{"type":"string","description":"Scope of the agent configuration","example":"workspace","uniqueKey":"agentConfiguration.scope","typeLabel":"string"},"userFavorite":{"type":"boolean","description":"Status of the user favorite for this configuration","example":true,"uniqueKey":"agentConfiguration.userFavorite","typeLabel":"boolean"},"model":{"type":"object","properties":{"providerId":{"type":"string","description":"ID of the model provider","example":"openai","uniqueKey":"agentConfiguration.model.providerId","typeLabel":"string"},"modelId":{"type":"string","description":"ID of the specific model","example":"gpt-4","uniqueKey":"agentConfiguration.model.modelId","typeLabel":"string"},"temperature":{"type":"number","example":0.7,"uniqueKey":"agentConfiguration.model.temperature","typeLabel":"number"}},"uniqueKey":"agentConfiguration.model","typeLabel":"object"},"actions":{"type":"array","example":[],"uniqueKey":"agentConfiguration.actions","typeLabel":"array"},"skills":{"type":"array","description":"Skills attached to the agent. Returned by the agent GET endpoints (list and single-agent) whatever the requested variant. Empty both for an agent with no skill and for an agent whose details were redacted for the caller (canRead false).","items":{"type":"object","description":"A skill attached to an agent configuration.","properties":{"sId":{"type":"string","description":"Unique string identifier for the skill","example":"skill_abc123","uniqueKey":"agentConfiguration.skills.items.[INDEX].sId","typeLabel":"string"},"name":{"type":"string","description":"Name of the skill","example":"Customer Support","uniqueKey":"agentConfiguration.skills.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"agentConfiguration.skills.items.[INDEX]","typeLabel":"object"},"uniqueKey":"agentConfiguration.skills","typeLabel":"object[]"},"tags":{"type":"array","description":"Tags attached to the agent","items":{"type":"object","properties":{"sId":{"type":"string","example":"3f9d1c7a5b","uniqueKey":"agentConfiguration.tags.items.[INDEX].sId","typeLabel":"string"},"name":{"type":"string","example":"Support","uniqueKey":"agentConfiguration.tags.items.[INDEX].name","typeLabel":"string"},"kind":{"type":"string","enum":["standard","protected"],"uniqueKey":"agentConfiguration.tags.items.[INDEX].kind","typeLabel":"enum\u003cstring>"}},"uniqueKey":"agentConfiguration.tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"agentConfiguration.tags","typeLabel":"object[]"},"requestedSpaceIds":{"type":"array","description":"Identifiers of the spaces the agent needs access to","items":{"type":"string","uniqueKey":"agentConfiguration.requestedSpaceIds.items.[INDEX]","typeLabel":"string"},"example":["vlt_a1b2c3d4e5"],"uniqueKey":"agentConfiguration.requestedSpaceIds","typeLabel":"string[]"},"maxStepsPerRun":{"type":"integer","example":10,"uniqueKey":"agentConfiguration.maxStepsPerRun","typeLabel":"integer"},"templateId":{"oneOf":[{"type":"string","description":"ID of the template used for this configuration","example":"b4e2f1a9c7","uniqueKey":"agentConfiguration.templateId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the template used for this configuration","example":"b4e2f1a9c7","uniqueKey":"agentConfiguration.templateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentConfiguration.templateId","typeLabel":"string | null"}},"uniqueKey":"agentConfiguration","typeLabel":"object"},"skippedActions":{"type":"array","description":"Toolset entries that could not be applied (e.g. the referenced MCP server was not found, is not shared to an accessible space, or the name was ambiguous). The request still succeeds; inspect this list to confirm every intended tool was attached.","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"skippedActions.items.[INDEX].name","typeLabel":"string"},"reason":{"type":"string","uniqueKey":"skippedActions.items.[INDEX].reason","typeLabel":"string"}},"uniqueKey":"skippedActions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"skippedActions","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agentConfiguration":{"id":12345,"agentModelId":6789,"sId":"7f3a9c2b1e","version":2,"versionCreatedAt":"2023-06-15T14:30:00Z","versionAuthorId":"0ec9852c2f","name":"Customer Support Agent","description":"An AI agent designed to handle customer support inquiries","instructions":"Always greet the customer politely and try to resolve their issue efficiently.","pictureUrl":"https://example.com/agent-images/support-agent.png","status":"active","scope":"workspace","userFavorite":true,"model":{"providerId":"openai","modelId":"gpt-4","temperature":0.7},"actions":[],"skills":[{"sId":"skill_abc123","name":"Customer Support"}],"tags":[{"sId":"3f9d1c7a5b","name":"Support","kind":"standard"}],"requestedSpaceIds":["vlt_a1b2c3d4e5"],"maxStepsPerRun":10,"templateId":"b4e2f1a9c7"},"skippedActions":[{"name":"\u003cstring>","reason":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"97c80821-b629-4306-af09-2ab6e550dc5b":{"description":"Bad Request. Invalid or missing parameters.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"10bea615-cedb-443c-a63a-10dccc4a5b9c":{"description":"Unauthorized. Invalid or missing authentication token.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"228976de-2031-4880-aafd-5323391479ee":{"description":"Forbidden. Only admins can update agents.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"8eced24a-76b2-45a3-853e-c0ea30fab7a6":{"description":"Agent configuration not found.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b4ce1aac-db2d-4de6-8588-d41ce1a609df":{"description":"Internal Server Error.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"71124445-bcf9-4ce5-98e1-e1bd1e0765a8":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Your RUBY API key is a Bearer token.","scopes":[]}}},"servers":{"51bbd201-d386-49c6-a605-c8c992b93b27":{"url":"https://app.ruby.ad","description":"Ruby API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your RUBY API key is a Bearer token.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your RUBY API key is a Bearer token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"docs/developer-platform/ruby-api-documentation/openapi.json"},"subdomain":"ruby-ai","siteName":"Ruby Docs","title":"Update agent configuration - Ruby Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T16:58:23.846Z","originalFileLocation":"api-reference/agents/update-agent-configuration.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=\"Update the agent configuration identified by {sId} in the workspace identified by {wId}.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ruby Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ruby-ai/jrSlsO_Xe0HYKbrT/_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/ruby-ai/jrSlsO_Xe0HYKbrT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ruby-ai/jrSlsO_Xe0HYKbrT/_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/ruby-ai/jrSlsO_Xe0HYKbrT/_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/ruby-ai/jrSlsO_Xe0HYKbrT/_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/ruby-ai/jrSlsO_Xe0HYKbrT/_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/ruby-ai/jrSlsO_Xe0HYKbrT/_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/ruby-ai/jrSlsO_Xe0HYKbrT/_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/ruby-ai/jrSlsO_Xe0HYKbrT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update agent configuration - Ruby Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update the agent configuration identified by {sId} in the workspace identified by {wId}.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ruby Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ruby-ai.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+agent+configuration\u0026amp;description=Update+the+agent+configuration+identified+by+%7BsId%7D+in+the+workspace+identified+by+%7BwId%7D.\u0026amp;theme=4fcb5a886c9ab05f8fe21117\u0026amp;signature=ede2cd1c2c4d797b4febd3e4291b9a2639c1e9677b48ca4ea68789962e278ece\">\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=\"Update agent configuration - Ruby Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update the agent configuration identified by {sId} in the workspace identified by {wId}.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ruby-ai.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+agent+configuration\u0026amp;description=Update+the+agent+configuration+identified+by+%7BsId%7D+in+the+workspace+identified+by+%7BwId%7D.\u0026amp;theme=4fcb5a886c9ab05f8fe21117\u0026amp;signature=ede2cd1c2c4d797b4febd3e4291b9a2639c1e9677b48ca4ea68789962e278ece\">\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/ruby-ai/jrSlsO_Xe0HYKbrT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ruby Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0284C7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agents/update-agent-configuration.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ruby.ad/#organization\",\"name\":\"Ruby Docs\",\"url\":\"https://docs.ruby.ad\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ruby-ai/6ikFcKxC_qkkSD3O/branding/ruby-icon.png?fit=max\u0026auto=format\u0026n=6ikFcKxC_qkkSD3O\u0026q=85\u0026s=52c94238d53b46396e117b7fc123cf72\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ruby.ad#website\",\"name\":\"Ruby Docs\",\"url\":\"https://docs.ruby.ad\",\"publisher\":{\"@id\":\"https://docs.ruby.ad/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration#webpage\",\"url\":\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration\",\"name\":\"Update agent configuration\",\"description\":\"Update the agent configuration identified by {sId} in the workspace identified by {wId}.\",\"dateModified\":\"2026-09-23T16:58:23.846Z\",\"isPartOf\":{\"@id\":\"https://docs.ruby.ad#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Developers\",\"item\":\"https://docs.ruby.ad/docs/user-documentation/developers/client-side-mcp-server\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ruby API Documentation\",\"item\":\"https://docs.ruby.ad/docs/developer-platform/ruby-api-documentation/openapi-and-postman\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Agents\",\"item\":\"https://docs.ruby.ad/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update agent configuration\",\"item\":\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration#apireference\",\"headline\":\"Update agent configuration\",\"name\":\"Update agent configuration\",\"description\":\"Update the agent configuration identified by {sId} in the workspace identified by {wId}.\",\"url\":\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ruby.ad/api-reference/agents/update-agent-configuration#webpage\"},\"dateModified\":\"2026-09-23T16:58:23.846Z\",\"publisher\":{\"@id\":\"https://docs.ruby.ad/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ruby.ad#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ruby Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ruby Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/agents/update-agent-configuration.md","siteName":"Ruby Docs","nav":{"global":null,"groups":[{"group":"Latest Updates","pages":[{"title":"Product updates","href":"/docs/changelog"}]},{"group":"Use cases","pages":[{"title":"Intro to Ruby","href":"/docs/user-documentation/getting-started/intro-to-ruby"},{"title":"Home and starter suggestions","href":"/docs/user-documentation/getting-started/home-and-suggestions"},{"title":"Customize Ruby","href":"/docs/user-documentation/getting-started/customization"},{"group":"Ruby Rollout Guide","root":{"title":"Ruby Rollout Guide","href":"/docs/user-documentation/getting-started/ruby-rollout-guide/index"},"pages":[{"title":"Welcome to Ruby","href":"/docs/user-documentation/getting-started/ruby-rollout-guide/welcome-to-ruby"},{"title":"Launch strategy","href":"/docs/user-documentation/getting-started/ruby-rollout-guide/launch-strategy"},{"title":"Team onboarding material","href":"/docs/user-documentation/getting-started/ruby-rollout-guide/team-onboarding-material"},{"title":"Build your builder community","href":"/docs/user-documentation/getting-started/ruby-rollout-guide/build-your-builder-community"},{"title":"Admin guide: set up your Ruby workspace","href":"/docs/user-documentation/getting-started/ruby-rollout-guide/admin-guide-set-up-your-ruby-workspace"},{"title":"Designing use cases","href":"/docs/user-documentation/getting-started/ruby-rollout-guide/designing-use-cases"},{"title":"Educate \u0026 activate","href":"/docs/user-documentation/getting-started/ruby-rollout-guide/educate-activate"},{"title":"Measure \u0026 expand","href":"/docs/user-documentation/getting-started/ruby-rollout-guide/measure-expand"}]},{"group":"Use Cases \u0026 Guides","root":{"title":"Use Cases \u0026 Guides","href":"/docs/user-documentation/getting-started/use-cases-and-guides/index"},"pages":[{"title":"🤝 Sales","href":"/docs/user-documentation/getting-started/use-cases-and-guides/sales"},{"title":"🏆 Customer Support","href":"/docs/user-documentation/getting-started/use-cases-and-guides/customer-support"},{"title":"📣 Marketing \u0026 Content","href":"/docs/user-documentation/getting-started/use-cases-and-guides/marketing"},{"title":"🤖 Engineering","href":"/docs/user-documentation/getting-started/use-cases-and-guides/engineering"},{"title":"📈 Data Analytics","href":"/docs/user-documentation/getting-started/use-cases-and-guides/data-analytics"},{"title":"📖 Knowledge","href":"/docs/user-documentation/getting-started/use-cases-and-guides/knowledge"},{"title":"👥 Recruiting \u0026 People","href":"/docs/user-documentation/getting-started/use-cases-and-guides/recruiting-and-people"},{"title":"📦 Product","href":"/docs/user-documentation/getting-started/use-cases-and-guides/product-and-design"},{"title":"🤝 Collaboration","href":"/docs/user-documentation/getting-started/use-cases-and-guides/collaboration"}]},{"group":"FAQ","root":{"title":"FAQ","href":"/docs/user-documentation/getting-started/faq/index"},"pages":[{"group":"General questions","pages":[{"title":"What data sources can be connected to Ruby?","href":"/docs/user-documentation/getting-started/faq/general-questions/what-data-sources-can-be-connected-to-ruby"},{"title":"What AI models are available in Ruby?","href":"/docs/user-documentation/getting-started/faq/general-questions/what-ai-models-are-available-in-ruby"},{"title":"What tools are available in Ruby?","href":"/docs/user-documentation/getting-started/faq/general-questions/what-tools-are-available-in-ruby"},{"title":"What are the pricing plans for Ruby?","href":"/docs/user-documentation/getting-started/faq/general-questions/what-are-the-pricing-plans-for-ruby"},{"title":"How does Ruby handle user data?","href":"/docs/user-documentation/getting-started/faq/general-questions/how-does-ruby-handle-user-data"},{"title":"How do I change the language in Ruby?","href":"/docs/user-documentation/getting-started/faq/general-questions/how-to-change-the-language-in-ruby"}]},{"group":"Managing agents","pages":[{"title":"I don't know how to start creating an agent, what should I do?","href":"/docs/user-documentation/getting-started/faq/managing-agents/i-dont-know-how-to-start-creating-an-agent-what-should-i-do"},{"title":"How do I edit a custom agent?","href":"/docs/user-documentation/getting-started/faq/managing-agents/how-do-i-edit-a-custom-agent"},{"title":"What settings / model should I use?","href":"/docs/user-documentation/getting-started/faq/managing-agents/what-settings-model-should-i-use"},{"title":"Can agents create a new file or document directly into Notion, Google Drive or other connected platforms?","href":"/docs/user-documentation/getting-started/faq/managing-agents/can-agents-create-a-new-file-or-document-directly-into-notion-google-drive-or-other-connected-platforms"},{"title":"What data do the agents have access to?","href":"/docs/user-documentation/getting-started/faq/managing-agents/what-data-do-the-agents-have-access-to"},{"title":"Do the agents have access to the internet?","href":"/docs/user-documentation/getting-started/faq/managing-agents/do-the-agents-have-access-to-the-internet"},{"title":"Does the Ruby agent give accurate and safe responses?","href":"/docs/user-documentation/getting-started/faq/managing-agents/does-the-ruby-agent-give-accurate-and-safe-responses"},{"title":"Is there a Ruby conversation API?","href":"/docs/user-documentation/getting-started/faq/managing-agents/is-there-a-ruby-conversation-api"},{"title":"Can I share a conversation?","href":"/docs/user-documentation/getting-started/faq/managing-agents/can-i-share-a-conversation"},{"title":"Can I delete or rename a conversation?","href":"/docs/user-documentation/getting-started/faq/managing-agents/can-i-delete-or-rename-a-conversation"},{"title":"Can I use the Ruby agents in different languages?","href":"/docs/user-documentation/getting-started/faq/managing-agents/can-i-use-the-ruby-agents-in-different-languages"},{"title":"How can I find the ID of an agent?","href":"/docs/user-documentation/getting-started/faq/managing-agents/how-can-i-find-the-id-of-an-agent"}]},{"group":"Troubleshooting \u0026 Limitations","pages":[{"title":"When asking a question about data within Slack, the link to the thread isn't always the right one","href":"/docs/user-documentation/getting-started/faq/troubleshooting-and-limitations/when-asking-a-question-about-data-within-slack-the-link-to-the-thread-isnt-always-the-right-one"},{"title":"I haven't received a login, or I am having trouble logging in","href":"/docs/user-documentation/getting-started/faq/troubleshooting-and-limitations/i-havent-received-a-login-or-i-am-having-trouble-logging-in"},{"title":"I try to create an agent using the Table Query tool, but it doesn't work","href":"/docs/user-documentation/getting-started/faq/troubleshooting-and-limitations/i-try-to-create-an-agent-using-the-table-query-tool-but-it-doesnt-work"},{"title":"The agent is producing links that don't work and falsely claiming something untrue, what's going on?","href":"/docs/user-documentation/getting-started/faq/troubleshooting-and-limitations/the-agent-is-producing-links-that-dont-work-and-falsely-claiming-something-untrue-whats-going-on"},{"title":"Why doesn't the agent remember what I said earlier in a conversation?","href":"/docs/user-documentation/getting-started/faq/troubleshooting-and-limitations/why-doesnt-the-agent-remember-what-i-said-earlier-in-a-conversation"},{"title":"Why isn't my recently updated document showing in agent responses?","href":"/docs/user-documentation/getting-started/faq/troubleshooting-and-limitations/why-isnt-my-recently-updated-document-showing-in-agent-responses"},{"title":"Can Ruby remember and incorporate my feedback in the future?","href":"/docs/user-documentation/getting-started/faq/troubleshooting-and-limitations/can-ruby-remember-and-incorporate-my-feedback-in-the-future"},{"title":"Is Ruby available?","href":"/docs/user-documentation/getting-started/faq/troubleshooting-and-limitations/is-ruby-down"},{"title":"Why is Ruby slow or my agent taking too long to respond?","href":"/docs/user-documentation/getting-started/faq/troubleshooting-and-limitations/why-is-ruby-slow-or-my-agent-taking-too-long-to-respond"}]},{"title":"File size limits","href":"/docs/user-documentation/getting-started/faq/file-size-limits"},{"title":"How to Change Your Email Address in Ruby","href":"/docs/user-documentation/getting-started/faq/how-to-change-your-email-address-in-ruby"}]}]},{"group":"Agents","pages":[{"title":"Create your first agent","href":"/docs/user-documentation/agents/create-your-first-agent"},{"title":"Conversational building","href":"/docs/user-documentation/agents/conversational-building"},{"title":"Ruby Live","href":"/docs/user-documentation/agents/ruby-live"},{"title":"Auto models and the model picker","href":"/docs/user-documentation/agents/model-selection"},{"group":"LLM Best practices","pages":[{"title":"How to write effective instructions","href":"/docs/user-documentation/agents/llm-best-practices/how-to-write-effective-instructions"},{"title":"Choosing the Right AI Model for Your Ruby Agent","href":"/docs/user-documentation/agents/llm-best-practices/choosing-the-right-ai-model"},{"title":"Understanding LLMs Context Windows","href":"/docs/user-documentation/agents/llm-best-practices/understanding-llms-context-windows"},{"title":"Understanding LLM Limitations: Counting and Parsing Structured Data","href":"/docs/user-documentation/agents/llm-best-practices/understanding-llm-limitations"},{"title":"Understanding Retrieval Augmented Generation (RAG) and the search method in Ruby","href":"/docs/user-documentation/agents/llm-best-practices/understanding-rag"}]},{"title":"Templates","href":"/docs/user-documentation/agents/templates"},{"group":"Ruby default agents","pages":[{"title":"@ruby Agent","href":"/docs/user-documentation/agents/default-agents/ruby"},{"title":"@deep-dive Agent","href":"/docs/user-documentation/agents/default-agents/deep-dive-agent"},{"title":"@help Agent","href":"/docs/user-documentation/agents/default-agents/help"},{"title":"@analyst Agent","href":"/docs/user-documentation/agents/default-agents/analyst"},{"title":"Sidekick","href":"/docs/user-documentation/agents/default-agents/agent-builder-sidekick"}]},{"title":"Troubleshooting your agent","href":"/docs/user-documentation/agents/troubleshooting-your-agent"},{"title":"Structured output format","href":"/docs/user-documentation/agents/structured-output-format"},{"title":"Steering: Conversations that keep up with you","href":"/docs/user-documentation/agents/steering-conversations"},{"title":"Branch a Conversation","href":"/docs/user-documentation/agents/branch-a-conversation"},{"title":"Context Compaction","href":"/docs/user-documentation/agents/context-compaction"}]},{"group":"Skills","pages":[{"title":"Overview","href":"/docs/user-documentation/agents/skills/skills-overview"},{"title":"Skills management","href":"/docs/user-documentation/agents/skills/skills-management"},{"title":"Skill Examples","href":"/docs/user-documentation/agents/skills/skill-examples"},{"title":"Skill Availability","href":"/docs/user-documentation/agents/skill-availability"},{"title":"Discover Knowledge","href":"/docs/user-documentation/agents/discover-knowledge"},{"title":"Discover Skills","href":"/docs/user-documentation/agents/discover-skills"},{"title":"Discover Tools","href":"/docs/user-documentation/agents/discover-tools"},{"title":"Go Deep","href":"/docs/user-documentation/agents/go-deep"},{"title":"Ruby Support","href":"/docs/user-documentation/agents/ruby-support"},{"title":"Self Improving Skills","href":"/docs/user-documentation/agents/self-improving-skills"}]},{"group":"Capabilities","pages":[{"group":"Knowledge","root":{"title":"Knowledge","href":"/docs/user-documentation/agents/knowledge/index"},"pages":[{"title":"Search data sources","href":"/docs/user-documentation/agents/knowledge/search-data-sources"},{"title":"Table queries","href":"/docs/user-documentation/agents/knowledge/table-queries"},{"title":"Extract data","href":"/docs/user-documentation/agents/knowledge/extract-data"},{"title":"Include data","href":"/docs/user-documentation/agents/knowledge/include-data"},{"title":"Overview","href":"/docs/user-documentation/data-sources/overview"},{"title":"Connections","href":"/docs/user-documentation/data-sources/connections"},{"title":"Websites","href":"/docs/user-documentation/data-sources/websites"},{"title":"Folders","href":"/docs/user-documentation/data-sources/folders"},{"group":"Conversation Files","pages":[{"title":"Conversation Files","href":"/docs/user-documentation/data-sources/conversation-files/conversation-files"},{"title":"Read images","href":"/docs/user-documentation/data-sources/conversation-files/read-images"},{"title":"Videos","href":"/docs/user-documentation/data-sources/conversation-files/videos"}]},{"group":"Custom connections","pages":[{"title":"[Zapier] Automatically add any datasource to Ruby","href":"/docs/user-documentation/data-sources/custom-connections/zapier-automatically-add-datasource"}]}]},{"group":"Tools","root":{"title":"Tools","href":"/docs/user-documentation/agents/tools/index"},"pages":[{"title":"Airtable","href":"/docs/user-documentation/agents/tools/airtable"},{"title":"Agent Memory","href":"/docs/user-documentation/agents/tools/agent-memory"},{"title":"Asana","href":"/docs/user-documentation/agents/tools/asana"},{"title":"Ashby","href":"/docs/user-documentation/agents/tools/ashby"},{"title":"Attio","href":"/docs/user-documentation/agents/tools/attio"},{"title":"Canva","href":"/docs/user-documentation/agents/tools/canva"},{"title":"Confluence","href":"/docs/user-documentation/agents/tools/confluence"},{"title":"Databricks","href":"/docs/user-documentation/agents/tools/databricks"},{"title":"Fathom","href":"/docs/user-documentation/agents/tools/fathom"},{"title":"Gong","href":"/docs/user-documentation/agents/tools/gong"},{"title":"Freshservice","href":"/docs/user-documentation/agents/tools/freshservice"},{"title":"Front","href":"/docs/user-documentation/agents/tools/front"},{"title":"GitHub","href":"/docs/user-documentation/agents/tools/github"},{"title":"Gmail","href":"/docs/user-documentation/agents/tools/gmail"},{"title":"Google Calendar","href":"/docs/user-documentation/agents/tools/google-calendar"},{"title":"Google Drive","href":"/docs/user-documentation/agents/tools/google-drive"},{"title":"[Deprecated] Google Sheets","href":"/docs/user-documentation/agents/tools/google-sheets-deprecated"},{"title":"HubSpot","href":"/docs/user-documentation/agents/tools/hubspot"},{"title":"Image Generation","href":"/docs/user-documentation/agents/tools/image-generation"},{"title":"Jira","href":"/docs/user-documentation/agents/tools/jira"},{"title":"JIT tools","href":"/docs/user-documentation/agents/tools/jit-tools"},{"group":"Meta","root":{"title":"Meta","href":"/docs/user-documentation/agents/tools/meta"},"pages":[{"title":"WhatsApp Business","href":"/docs/user-documentation/agents/tools/meta-whatsapp"},{"title":"Facebook Pages","href":"/docs/user-documentation/agents/tools/meta-facebook-pages"},{"title":"Instagram","href":"/docs/user-documentation/agents/tools/meta-instagram"},{"title":"Meta Ads","href":"/docs/user-documentation/agents/tools/meta-ads"},{"title":"Meta Commerce","href":"/docs/user-documentation/agents/tools/meta-commerce"}]},{"title":"Microsoft Outlook","href":"/docs/user-documentation/agents/tools/microsoft-outlook"},{"title":"Microsoft Sharepoint and OneDrive tools","href":"/docs/user-documentation/agents/tools/microsoft-sharepoint-and-onedrive"},{"title":"Microsoft Teams","href":"/docs/user-documentation/agents/tools/microsoft-teams"},{"title":"Microsoft Excel","href":"/docs/user-documentation/agents/tools/microsoft-excel"},{"title":"Miro","href":"/docs/user-documentation/agents/tools/miro"},{"title":"Monday","href":"/docs/user-documentation/agents/tools/monday-com"},{"title":"NetSuite","href":"/docs/user-documentation/agents/tools/netsuite"},{"title":"Notion","href":"/docs/user-documentation/agents/tools/notion"},{"title":"Power BI","href":"/docs/user-documentation/agents/tools/power-bi"},{"title":"Productboard","href":"/docs/user-documentation/agents/tools/productboard"},{"title":"Slack tools","href":"/docs/user-documentation/agents/tools/slack-tools"},{"title":"UKG Ready","href":"/docs/user-documentation/agents/tools/ukg-ready"},{"title":"Val Town","href":"/docs/user-documentation/agents/tools/val-town"},{"title":"Vanta","href":"/docs/user-documentation/agents/tools/vanta"},{"title":"Voice and sound generation","href":"/docs/user-documentation/agents/tools/voice-and-sound-generation"},{"title":"Salesloft","href":"/docs/user-documentation/agents/tools/salesloft"},{"title":"Semrush","href":"/docs/user-documentation/agents/tools/semrush"},{"title":"ServiceNow","href":"/docs/user-documentation/agents/tools/servicenow"},{"title":"Slab","href":"/docs/user-documentation/agents/tools/slab"},{"title":"Snowflake","href":"/docs/user-documentation/agents/tools/snowflake"},{"title":"Statuspage","href":"/docs/user-documentation/agents/tools/statuspage"},{"title":"Run agent","href":"/docs/user-documentation/agents/tools/run-agent"},{"title":"Web Search \u0026 Browse","href":"/docs/user-documentation/agents/tools/web-search-and-browse"},{"title":"Zendesk","href":"/docs/user-documentation/agents/tools/zendesk"},{"title":"Wake-ups","href":"/docs/user-documentation/agents/tools/wake-ups"},{"title":"Computer","href":"/docs/user-documentation/agents/tools/computer"},{"group":"YouTube","root":{"title":"YouTube","href":"/docs/user-documentation/agents/tools/youtube"},"pages":[{"title":"YouTube Analytics","href":"/docs/user-documentation/agents/tools/youtube-analytics"},{"title":"YouTube Live","href":"/docs/user-documentation/agents/tools/youtube-live"}]},{"group":"TikTok","root":{"title":"TikTok","href":"/docs/user-documentation/agents/tools/tiktok"},"pages":[{"title":"TikTok Ads","href":"/docs/user-documentation/agents/tools/tiktok-ads"}]}]},{"group":"Triggers","root":{"title":"Triggers","href":"/docs/user-documentation/agents/triggers/index"},"pages":[{"title":"Credits usage","href":"/docs/user-documentation/agents/triggers/credits-usage"},{"title":"Schedules","href":"/docs/user-documentation/agents/triggers/schedules"},{"title":"Meta triggers","href":"/docs/user-documentation/agents/triggers/meta-triggers"},{"group":"Webhooks","root":{"title":"Webhooks","href":"/docs/user-documentation/agents/triggers/webhooks/index"},"pages":[{"title":"Filter webhooks payload","href":"/docs/user-documentation/agents/triggers/webhooks/filter-webhooks-payload"},{"title":"Rate Limiting","href":"/docs/user-documentation/agents/triggers/webhooks/rate-limiting"}]}]},{"group":"Frames","pages":[{"title":"Overview","href":"/docs/user-documentation/agents/frames/overview"},{"title":"Frames v2 (beta)","href":"/docs/user-documentation/agents/frames/frames-v2"},{"title":"White-labeled Frames","href":"/docs/user-documentation/agents/frames/white-labeled-frames"}]},{"group":"Integrations","root":{"title":"Integrations","href":"/docs/user-documentation/agents/integrations/index"},"pages":[{"title":"Ruby MCP Server","href":"/docs/user-documentation/agents/integrations/ruby-mcp-server"},{"group":"Ruby in Slack","root":{"title":"Ruby in Slack","href":"/docs/user-documentation/agents/integrations/ruby-in-slack/index"},"pages":[{"title":"Slack Auto-Reply without @mention","href":"/docs/user-documentation/agents/integrations/ruby-in-slack/slack-auto-reply"},{"title":"[Beta] Slack Auto-Join","href":"/docs/user-documentation/agents/integrations/ruby-in-slack/slack-auto-join"},{"title":"Slack workflows","href":"/docs/user-documentation/agents/integrations/ruby-in-slack/slack-workflows"}]},{"title":"Send and Forward Email to Agents","href":"/docs/user-documentation/agents/integrations/send-and-forward-email-to-agents"},{"title":"Zapier","href":"/docs/user-documentation/agents/integrations/zapier"},{"title":"Make.com","href":"/docs/user-documentation/agents/integrations/make-com"},{"title":"Use Ruby with n8n","href":"/docs/user-documentation/agents/integrations/n8n"},{"title":"Power Automate","href":"/docs/user-documentation/agents/integrations/power-automate"},{"title":"Meeting transcripts","href":"/docs/user-documentation/agents/integrations/meeting-transcripts"},{"title":"Google Sheets Add-on","href":"/docs/user-documentation/agents/integrations/google-sheets-add-on"},{"title":"Ruby in Zendesk","href":"/docs/user-documentation/agents/integrations/ruby-in-zendesk"},{"title":"Browser extension","href":"/docs/user-documentation/agents/integrations/browser-extension"},{"title":"Raycast Extension","href":"/docs/user-documentation/agents/integrations/raycast-extension"},{"title":"Ruby in Microsoft Teams","href":"/docs/user-documentation/agents/integrations/ruby-in-teams"}]}]},{"group":"Pods","pages":[{"title":"Overview","href":"/docs/user-documentation/pods/overview"},{"title":"Members and roles","href":"/docs/user-documentation/pods/members-and-roles"},{"title":"Tasks","href":"/docs/user-documentation/pods/tasks"},{"title":"Conversations","href":"/docs/user-documentation/pods/conversations"},{"title":"Files","href":"/docs/user-documentation/pods/files"},{"title":"Frames","href":"/docs/user-documentation/pods/frames"},{"title":"Agent tools","href":"/docs/user-documentation/pods/agent-tools"},{"title":"Admin controls","href":"/docs/user-documentation/pods/admin-controls"},{"group":"Examples","pages":[{"title":"Shared asset library","href":"/docs/user-documentation/pods/examples/shared-asset-library"},{"title":"Personal second brain","href":"/docs/user-documentation/pods/examples/personal-second-brain"},{"title":"Initiative and project management","href":"/docs/user-documentation/pods/examples/initiative-and-project-management"},{"title":"Ticket handling and support knowledge","href":"/docs/user-documentation/pods/examples/ticket-handling-and-support-knowledge"},{"title":"One Pod per customer","href":"/docs/user-documentation/pods/examples/one-pod-per-customer"},{"title":"Content and editorial production","href":"/docs/user-documentation/pods/examples/content-and-editorial-production"},{"title":"Competitive intelligence","href":"/docs/user-documentation/pods/examples/competitive-intelligence"}]}]},{"group":"Admins","pages":[{"title":"Quickstart","href":"/docs/user-documentation/admins/quickstart"},{"group":"Admin Governance","pages":[{"title":"Workspace Governance: Roles, Groups \u0026 Permissions ","href":"/docs/user-documentation/admins/admin-governance/workspace-governance-roles-groups-and-permissions"},{"title":"Group managers","href":"/docs/user-documentation/admins/admin-governance/group-managers"},{"title":"Access Controls and Permissions","href":"/docs/user-documentation/admins/admin-governance/access-controls-and-permissions"},{"title":"EU-hosted models","href":"/docs/user-documentation/admins/admin-governance/eu-hosted-models"},{"group":"Single Sign-On (SSO)","pages":[{"title":"Single Sign-On (SSO)","href":"/docs/user-documentation/admins/admin-governance/single-sign-on-sso/single-sign-on-sso"},{"title":"SAML SSO","href":"/docs/user-documentation/admins/admin-governance/single-sign-on-sso/saml-sso"}]},{"title":"Users and groups provisioning","href":"/docs/user-documentation/admins/admin-governance/users-and-groups-provisioning"},{"title":"Merging user accounts","href":"/docs/user-documentation/admins/admin-governance/merging-user-accounts"}]},{"title":"Spaces management","href":"/docs/user-documentation/admins/spaces-management"},{"title":"Agents management","href":"/docs/user-documentation/admins/agents-management"},{"group":"Connections Management","root":{"title":"Connections Management","href":"/docs/user-documentation/admins/connections-management/index"},"pages":[{"title":"Google Drive","href":"/docs/user-documentation/admins/connections-management/google-drive"},{"title":"Notion","href":"/docs/user-documentation/admins/connections-management/notion"},{"title":"Confluence","href":"/docs/user-documentation/admins/connections-management/confluence"},{"title":"Intercom","href":"/docs/user-documentation/admins/connections-management/intercom"},{"title":"Github","href":"/docs/user-documentation/admins/connections-management/github"},{"title":"Microsoft","href":"/docs/user-documentation/admins/connections-management/microsoft"},{"title":"Zendesk","href":"/docs/user-documentation/admins/connections-management/zendesk"},{"title":"Snowflake","href":"/docs/user-documentation/admins/connections-management/snowflake"},{"title":"BigQuery","href":"/docs/user-documentation/admins/connections-management/bigquery"},{"title":"Gong","href":"/docs/user-documentation/admins/connections-management/gong"},{"title":"Slack connection","href":"/docs/user-documentation/admins/connections-management/slack"}]},{"group":"Tools management","pages":[{"title":"Add an MCP server","href":"/docs/user-documentation/admins/tools-management/adding-an-mcp-server"},{"title":"Static egress IP addresses","href":"/docs/user-documentation/admins/tools-management/static-egress-ips"},{"title":"Personal vs Shared Credentials for Tools \u0026 MCP Servers","href":"/docs/user-documentation/admins/tools-management/personal-vs-shared-credentials"},{"group":"Salesforce","pages":[{"title":"Salesforce","href":"/docs/user-documentation/admins/tools-management/salesforce/salesforce"},{"title":"Salesforce - Notes on API limit and permissions","href":"/docs/user-documentation/admins/tools-management/salesforce/salesforce-notes-on-api-limit-and-permissions"}]},{"title":"Managing Microsoft tools","href":"/docs/user-documentation/admins/tools-management/managing-microsoft-tools"},{"title":"Computer admin setup","href":"/docs/user-documentation/admins/tools-management/computer-admin-setup"}]},{"title":"Analytics","href":"/analytics"},{"title":"API keys","href":"/docs/user-documentation/admins/api-keys"},{"group":"Audit Logs","pages":[{"title":"Audit Logs","href":"/docs/user-documentation/admins/audit-logs/audit-logs"},{"title":"Audit Logs: Events Reference","href":"/docs/user-documentation/admins/audit-logs/audit-logs-events-reference"}]},{"group":"Usage, seats \u0026 credits","pages":[{"title":"Seat management","href":"/docs/user-documentation/admins/usage-seats-and-credits/seat-management"},{"title":"Credits","href":"/docs/user-documentation/admins/usage-seats-and-credits/credits"},{"title":"Credit management","href":"/docs/user-documentation/admins/usage-seats-and-credits/credit-management"},{"title":"Optimize credit consumption","href":"/docs/user-documentation/admins/usage-seats-and-credits/optimize-credit-consumption"},{"title":"Model access tiers","href":"/docs/user-documentation/admins/usage-seats-and-credits/model-access-tiers"},{"title":"Train your team on credit optimization","href":"/docs/user-documentation/admins/usage-seats-and-credits/train-team-credit-optimization"}]},{"group":"Billing","pages":[{"title":"Subscriptions \u0026 Payments","href":"/docs/user-documentation/admins/billing/subscriptions-and-payments"}]},{"group":"Admin Troubleshooting","pages":[{"title":"Troubleshooting","href":"/docs/user-documentation/admins/admin-troubleshooting/admin-troubleshooting"},{"title":"Slack Troubleshooting","href":"/docs/user-documentation/admins/admin-troubleshooting/slack-troubleshooting"}]}]},{"group":"Developers","pages":[{"title":"Client Side MCP Server (Preview)","href":"/docs/user-documentation/developers/client-side-mcp-server"},{"group":"Overview","pages":[{"title":"Developer platform","href":"/docs/developer-platform/overview/developer-platform"},{"title":"JavaScript SDK","href":"/docs/developer-platform/overview/javascript-sdk"}]},{"group":"Core Concepts","pages":[{"title":"Datasources","href":"/docs/developer-platform/core-concepts/datasources"},{"title":"Chunks and Documents","href":"/docs/developer-platform/core-concepts/chunks-and-documents"},{"title":"Rate Limits","href":"/docs/developer-platform/core-concepts/rate-limits"}]},{"group":"Ruby API Documentation","pages":[{"title":"OpenAPI specification","href":"/docs/developer-platform/ruby-api-documentation/openapi-and-postman"},{"group":"Analytics","pages":[{"title":"Export consumption analytics","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/analytics/consumption/export","href":"/api-reference/analytics/export-consumption-analytics"},{"title":"Export workspace analytics","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/analytics/export","href":"/api-reference/analytics/export-workspace-analytics"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/agent_configurations","href":"/api-reference/agents/list-agents"},{"title":"Export agent configuration as YAML","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/agent_configurations/{sId}/export/yaml","href":"/api-reference/agents/export-agent-configuration-as-yaml"},{"title":"Get agent configuration","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/agent_configurations/{sId}","href":"/api-reference/agents/get-agent-configuration"},{"title":"Archive agent configuration","description":"Archive the agent configuration identified by {sId} in the workspace identified by {wId}. The agent is soft-archived and its triggers are disabled.","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json delete /api/v1/w/{wId}/assistant/agent_configurations/{sId}","href":"/api-reference/agents/archive-agent-configuration"},{"title":"Update agent configuration","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json patch /api/v1/w/{wId}/assistant/agent_configurations/{sId}","href":"/api-reference/agents/update-agent-configuration"},{"title":"Import agent configuration","description":"Create a new agent configuration from a JSON body matching the agent config schema.","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/agent_configurations/import","href":"/api-reference/agents/import-agent-configuration"},{"title":"Search agents by name","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/agent_configurations/search","href":"/api-reference/agents/search-agents-by-name"}]},{"group":"Conversations","pages":[{"title":"Cancel message generation in a conversation","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/conversations/{cId}/cancel","href":"/api-reference/conversations/cancel-message-generation-in-a-conversation"},{"title":"Create a content fragment","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/conversations/{cId}/content_fragments","href":"/api-reference/conversations/create-a-content-fragment"},{"title":"Get the events for a conversation","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/conversations/{cId}/events","href":"/api-reference/conversations/get-the-events-for-a-conversation"},{"title":"Download a conversation-scoped file by path","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/conversations/{cId}/files/{rel}","href":"/api-reference/conversations/download-a-conversation-scoped-file-by-path"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/conversations/{cId}","href":"/api-reference/conversations/get-a-conversation"},{"title":"Update a conversation","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json patch /api/v1/w/{wId}/assistant/conversations/{cId}","href":"/api-reference/conversations/update-a-conversation"},{"title":"Answer a user question in a conversation message","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/conversations/{cId}/messages/{mId}/answer-question","href":"/api-reference/conversations/answer-a-user-question-in-a-conversation-message"},{"title":"Edit an existing message in a conversation","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/conversations/{cId}/messages/{mId}/edit","href":"/api-reference/conversations/edit-an-existing-message-in-a-conversation"},{"title":"Get events for a message","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/conversations/{cId}/messages/{mId}/events","href":"/api-reference/conversations/get-events-for-a-message"},{"title":"Validate an action in a conversation message","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/conversations/{cId}/messages/{mId}/validate-action","href":"/api-reference/conversations/validate-an-action-in-a-conversation-message"},{"title":"Create a message","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/conversations/{cId}/messages","href":"/api-reference/conversations/create-a-message"},{"title":"Create a new conversation","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/conversations","href":"/api-reference/conversations/create-a-new-conversation"},{"title":"Create a file upload URL","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/files","href":"/api-reference/conversations/create-a-file-upload-url"}]},{"group":"Feedbacks","pages":[{"title":"Get feedbacks for a conversation","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/conversations/{cId}/feedbacks","href":"/api-reference/feedbacks/get-feedbacks-for-a-conversation"},{"title":"Submit feedback for a specific message in a conversation","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/conversations/{cId}/messages/{mId}/feedbacks","href":"/api-reference/feedbacks/submit-feedback-for-a-specific-message-in-a-conversation"},{"title":"Delete feedback for a specific message","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json delete /api/v1/w/{wId}/assistant/conversations/{cId}/messages/{mId}/feedbacks","href":"/api-reference/feedbacks/delete-feedback-for-a-specific-message"}]},{"group":"Mentions","pages":[{"title":"Get mention suggestions for a conversation","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/conversations/{cId}/mentions/suggestions","href":"/api-reference/mentions/get-mention-suggestions-for-a-conversation"},{"title":"Parse mentions in markdown text","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/assistant/mentions/parse","href":"/api-reference/mentions/parse-mentions-in-markdown-text"},{"title":"Get mention suggestions","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/assistant/mentions/suggestions","href":"/api-reference/mentions/get-mention-suggestions"}]},{"group":"MCP","pages":[{"title":"Deregister a client-side MCP server","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/mcp/deregister","href":"/api-reference/mcp/deregister-a-client-side-mcp-server"},{"title":"Update heartbeat for a client-side MCP server","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/mcp/heartbeat","href":"/api-reference/mcp/update-heartbeat-for-a-client-side-mcp-server"},{"title":"Register a client-side MCP server","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/mcp/register","href":"/api-reference/mcp/register-a-client-side-mcp-server"},{"title":"Stream MCP tool requests for a workspace","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/mcp/requests","href":"/api-reference/mcp/stream-mcp-tool-requests-for-a-workspace"},{"title":"Submit MCP tool execution results","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/mcp/results","href":"/api-reference/mcp/submit-mcp-tool-execution-results"}]},{"group":"Search","pages":[{"title":"Search for nodes in the workspace (streaming)","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/search","href":"/api-reference/search/search-for-nodes-in-the-workspace-streaming"},{"title":"Search for nodes in the workspace","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/search","href":"/api-reference/search/search-for-nodes-in-the-workspace"},{"title":"Upload a tool file","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/search/tools/upload","href":"/api-reference/search/upload-a-tool-file"}]},{"group":"Skills","pages":[{"title":"Archive a skill","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json delete /api/v1/w/{wId}/skills/{skillId}","href":"/api-reference/skills/archive-a-skill"},{"title":"List skills","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/skills","href":"/api-reference/skills/list-skills"},{"title":"Import skills from uploaded files","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/skills","href":"/api-reference/skills/import-skills-from-uploaded-files"}]},{"group":"Apps","pages":[{"title":"Get an app run","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/apps/{aId}/runs/{runId}","href":"/api-reference/apps/get-an-app-run"},{"title":"Create an app run","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/spaces/{spaceId}/apps/{aId}/runs","href":"/api-reference/apps/create-an-app-run"},{"title":"List apps","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/apps","href":"/api-reference/apps/list-apps"}]},{"group":"DatasourceViews","pages":[{"title":"Get a data source view","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_source_views/{dsvId}","href":"/api-reference/datasourceviews/get-a-data-source-view"},{"title":"Delete a data source view","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json delete /api/v1/w/{wId}/spaces/{spaceId}/data_source_views/{dsvId}","href":"/api-reference/datasourceviews/delete-a-data-source-view"},{"title":"Update a data source view","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json patch /api/v1/w/{wId}/spaces/{spaceId}/data_source_views/{dsvId}","href":"/api-reference/datasourceviews/update-a-data-source-view"},{"title":"Search the data source view","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_source_views/{dsvId}/search","href":"/api-reference/datasourceviews/search-the-data-source-view"},{"title":"List Data Source Views","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_source_views","href":"/api-reference/datasourceviews/list-data-source-views"}]},{"group":"Datasources","pages":[{"title":"Check the upsert queue status for a data source","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/check_upsert_queue","href":"/api-reference/datasources/check-the-upsert-queue-status-for-a-data-source"},{"title":"Retrieve a document from a data source","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/documents/{documentId}","href":"/api-reference/datasources/retrieve-a-document-from-a-data-source"},{"title":"Upsert a document in a data source","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/documents/{documentId}","href":"/api-reference/datasources/upsert-a-document-in-a-data-source"},{"title":"Delete a document from a data source","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json delete /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/documents/{documentId}","href":"/api-reference/datasources/delete-a-document-from-a-data-source"},{"title":"Update the parents of a document","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/documents/{documentId}/parents","href":"/api-reference/datasources/update-the-parents-of-a-document"},{"title":"Get documents","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/documents","href":"/api-reference/datasources/get-documents"},{"title":"Search the data source","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/search","href":"/api-reference/datasources/search-the-data-source"},{"title":"Get a table","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables/{tId}","href":"/api-reference/datasources/get-a-table"},{"title":"Delete a table","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json delete /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables/{tId}","href":"/api-reference/datasources/delete-a-table"},{"title":"Get a row","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables/{tId}/rows/{rId}","href":"/api-reference/datasources/get-a-row"},{"title":"Delete a row","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json delete /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables/{tId}/rows/{rId}","href":"/api-reference/datasources/delete-a-row"},{"title":"List rows","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables/{tId}/rows","href":"/api-reference/datasources/list-rows"},{"title":"Upsert rows","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables/{tId}/rows","href":"/api-reference/datasources/upsert-rows"},{"title":"Get tables","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables","href":"/api-reference/datasources/get-tables"},{"title":"Upsert a table","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables","href":"/api-reference/datasources/upsert-a-table"},{"title":"Get data sources","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/data_sources","href":"/api-reference/datasources/get-data-sources"}]},{"group":"Tools","pages":[{"title":"List available MCP server views.","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces/{spaceId}/mcp_server_views","href":"/api-reference/tools/list-available-mcp-server-views"}]},{"group":"Spaces","pages":[{"title":"List available spaces.","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/spaces","href":"/api-reference/spaces/list-available-spaces"}]},{"group":"Triggers","pages":[{"title":"Get a trigger","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/triggers/{tId}","href":"/api-reference/triggers/get-a-trigger"},{"title":"Receive external webhook to trigger flows","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json post /api/v1/w/{wId}/triggers/hooks/{webhookSourceId}","href":"/api-reference/triggers/receive-external-webhook-to-trigger-flows"},{"title":"List triggers","deprecated":null,"version":null,"openapi":"/docs/developer-platform/ruby-api-documentation/openapi.json get /api/v1/w/{wId}/triggers","href":"/api-reference/triggers/list-triggers"}]}]},{"group":"Ruby CLI","pages":[{"title":"Ruby CLI","href":"/docs/developer-platform/ruby-cli/ruby-cli"}]}]}]},"basePath":"","title":"Update agent configuration - Ruby Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}