This is the name you use to refer to the agent in your list of agents.
string
The description assists the AI in coordinating between user-facing agents by clarifying the purpose and functionality of each agent.
string
The prompt helps the AI understand what you want and how to respond. It guides
the conversation and ensures relevant and coherent answers.
select
The type of agent. Options are:
user-facing : Agent directly interacts with users conversationally in a Q&A fashion. Only a single user-facing Agent engages with the user when a new query is input into the chatbot.
background : Agent never interacts with users directly and instead monitors the conversation in an ongoing fashion. All background Agents are run whenever the user submits a new query to the chatbot.
human-escalation : Agent routes the user’s query to a human. Only one human-escalation agent is allowed in each chatbot. It requires Chatsistant UI to fully use this feature.
pre-canned : Agent returns pre-canned response to user’s query
spam-defense : Agent enables the spam defending feature for the chatbot. Only one spam-defnese agent is allowed in each chatbot
boolean
Indicates whether the agent is enabled or disabled. If disabled, the agent
will not be involved in the conversation.
string
Indicates agent modified time
string
Indicates agent creation time
List[string]
List of data sources UUIDs that the agent uses. If use_all_sources in agent’s meta is set to true, this field will be disabled.
Only for user-facing agents.
HumanEscalationSettings Object
Human escalation settings for the agent.
Only for human-escalation agents.
List[ToolFunction]
List of tool functions that the agent uses.
Only for user-facing and background agents.
List[AgentVariable]
List of variables that the agent uses.
Only for user-facing agents.
meta Object
Agent meta properties
Show properties
select
Model
Message Credits
gpt-3.5-turbo
1
gpt-3.5-turbo-16k
8
gpt-4-0125-preview-8k
35
gpt-4-1106-preview-1k
5
gpt-4-1106-preview-2k
10
gpt-4-1106-preview-4k
20
gpt-4-1106-preview-16k
60
gpt-4o-1k
3
gpt-4o-2k
5
gpt-4o-4k
10
gpt-4o-8k
20
gpt-4o-16k
40
gpt-4o-mini-4k
1
gpt-4o-mini-16k
8
Only for user-facing and background agents.
float
A higher temperature value, such as 1, allows for more randomness and
creativity in the responses. This can lead to more diverse and unexpected
answers. On the other hand, a lower temperature value, closer to 0, produces
more focused and deterministic responses, making them more conservative and
predictable. Options are values as a float between 0 and
1
Only for user-facing agents.
float
How AI supervisor should be biased towards the agent. A higher value will make the AI supervisor more biased towards the agent. Options are values as a float between 0 and 1.
Only for user-facing, human-escalation, pre-canned and spam-defense agents.
float
How sticky the AI supervisor should be stick with the agent when the lastest user’s query is handled by this agent. Options are values as a float between 0 and 1.
Only for user-facing, human-escalation, pre-canned and spam-defense agents.
string
Default message to show when the agent is triggered.
Only for pre-canned and spam-defense agents.
tags Object
Tags defined for the agent.
Only for background agents.
boolean
Use all sources for the agent.
Only for user-facing agents.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Chatsistant API","colors":{"primary":"#2E3F51","light":"#516F90","dark":"#0D001D"},"logo":{"light":"https://mintcdn.com/chatsistant/cM2IU8RXqv-3TQFG/logo/light.svg?fit=max\u0026auto=format\u0026n=cM2IU8RXqv-3TQFG\u0026q=85\u0026s=9d3655b647b4e05dab0f447b19ea9b1b","dark":"https://mintcdn.com/chatsistant/cM2IU8RXqv-3TQFG/logo/dark.svg?fit=max\u0026auto=format\u0026n=cM2IU8RXqv-3TQFG\u0026q=85\u0026s=0c4df0d7d9110175c51d84b69f63c2e6","href":"https://chatsistant.com"},"favicon":"https://mintcdn.com/chatsistant/bw0W4PPFP0FNqFg-/logo/favicon.png?fit=max\u0026auto=format\u0026n=bw0W4PPFP0FNqFg-\u0026q=85\u0026s=39134c3bd2c163914fc74c48dd7dcd76","api":{"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://app.chatsistant.com/api"}},"background":{"decoration":"gradient","color":{"light":"#FFFFFF","dark":"#111827"}},"navbar":{"links":[{"href":"mailto:hello@chatsistant.com","label":"Support"}],"primary":{"type":"button","label":"Get started","href":"https://chatsistant.com"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chatsistant","hasAudioNarration":false,"actualSubdomain":"chatsistant","customDomains":["docs.chatsistant.com"],"gitSource":{"type":"github","owner":"chatsistant","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af3fb189d3cc29fad128d11","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API References","count":38},{"language":"default","tag":"Documentation","count":19},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Data Sources","count":9},{"language":"default","tag":"Chatbots","count":6},{"language":"default","tag":"Agents","count":5},{"language":"default","tag":"Session Messages","count":5},{"language":"default","tag":"Chatbot Sessions","count":5},{"language":"default","tag":"API Usage Guides","count":4},{"language":"default","tag":"Data Source Tags","count":4}]},"assistantConfig":{},"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/agents/properties-reference","slug":"/api-reference/agents/properties-reference","pageMetadata":{"title":"Agent Properties","description":"Detailed explanation of agent's properties","href":"/api-reference/agents/properties-reference"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Detailed explanation of agent’s properties\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Expandable,ParamField,Table}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(ParamField,{body:`uuid`,type:`string`,id:`param-uuid`,children:_jsx(_components.p,{children:`Unique Id of the agent`})}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,id:`param-name`,children:_jsx(_components.p,{children:`This is the name you use to refer to the agent in your list of agents.`})}),`\n`,_jsx(ParamField,{body:`description`,type:`string`,id:`param-description`,children:_jsx(_components.p,{children:`The description assists the AI in coordinating between user-facing agents by clarifying the purpose and functionality of each agent.`})}),`\n`,_jsx(ParamField,{body:`prompt`,type:`string`,id:`param-prompt`,children:_jsx(_components.p,{children:`The prompt helps the AI understand what you want and how to respond. It guides\nthe conversation and ensures relevant and coherent answers.`})}),`\n`,_jsx(ParamField,{body:`type`,type:`select`,id:`param-type`,children:_jsxs(_components.p,{children:[`The type of agent. Options are:\n`,_jsxs(`p`,{className:`mint-font-medium`,children:[_jsx(`code`,{children:`user-facing`}),` : Agent directly interacts with users conversationally in a Q\u0026A fashion. Only a single user-facing Agent engages with the user when a new query is input into the chatbot.`]}),`\n`,_jsxs(`p`,{className:`mint-font-medium`,children:[_jsx(`code`,{children:`background`}),` : Agent never interacts with users directly and instead monitors the conversation in an ongoing fashion. All background Agents are run whenever the user submits a new query to the chatbot.`]}),`\n`,_jsxs(`p`,{className:`mint-font-medium`,children:[_jsx(`code`,{children:`human-escalation`}),` : Agent routes the user’s query to a human. Only one human-escalation agent is allowed in each chatbot. It requires Chatsistant UI to fully use this feature. `]}),`\n`,_jsxs(`p`,{className:`mint-font-medium`,children:[_jsx(`code`,{children:`pre-canned`}),` : Agent returns pre-canned response to user’s query`]}),`\n`,_jsxs(`p`,{className:`mint-font-medium`,children:[_jsx(`code`,{children:`spam-defense`}),` : Agent enables the spam defending feature for the chatbot. Only one spam-defnese agent is allowed in each chatbot`]})]})}),`\n`,_jsx(ParamField,{body:`enabled`,type:`boolean`,id:`param-enabled`,children:_jsx(_components.p,{children:`Indicates whether the agent is enabled or disabled. If disabled, the agent\nwill not be involved in the conversation.`})}),`\n`,_jsx(ParamField,{body:`modified_at`,type:`string`,id:`param-modified-at`,children:_jsx(_components.p,{children:`Indicates agent modified time`})}),`\n`,_jsx(ParamField,{body:`created_at`,type:`string`,id:`param-created-at`,children:_jsx(_components.p,{children:`Indicates agent creation time`})}),`\n`,_jsx(ParamField,{body:`data_source_uuids`,type:`List[string]`,id:`param-data-source-uuids`,children:_jsxs(_components.p,{children:[`List of data sources UUIDs that the agent uses. If `,_jsx(`code`,{children:`use_all_sources`}),` in agent’s meta is set to true, this field will be disabled.`,_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`user-facing`}),` agents.`]})}),`\n`,_jsx(ParamField,{body:`human_escalation_settings`,type:`HumanEscalationSettings Object`,id:`param-human-escalation-settings`,children:_jsxs(_components.p,{children:[`Human escalation settings for the agent. `,_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`human-escalation`}),` agents.`]})}),`\n`,_jsx(ParamField,{body:`tool_functions`,type:`List[ToolFunction]`,id:`param-tool-functions`,children:_jsxs(_components.p,{children:[`List of tool functions that the agent uses. `,_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`user-facing`}),` and `,_jsx(`code`,{children:`background`}),` agents.`]})}),`\n`,_jsx(ParamField,{body:`variables`,type:`List[AgentVariable]`,id:`param-variables`,children:_jsxs(_components.p,{children:[`List of variables that the agent uses. `,_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`user-facing`}),` agents.`]})}),`\n`,_jsxs(ParamField,{body:`meta`,type:`meta Object`,id:`param-meta`,children:[_jsx(_components.p,{children:`Agent meta properties`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`model`,type:`select`,id:`param-model`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Model`}),_jsx(_components.th,{children:`Message Credits`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-3.5-turbo`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`1`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-3.5-turbo-16k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`8`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4-0125-preview-8k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`35`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4-1106-preview-1k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`5`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4-1106-preview-2k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`10`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4-1106-preview-4k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`20`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4-1106-preview-16k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`60`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4o-1k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`3`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4o-2k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`5`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4o-4k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`10`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4o-8k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`20`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4o-16k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`40`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4o-mini-4k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`1`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`gpt-4o-mini-16k`}),_jsx(_components.td,{\"data-numeric\":`true`,children:`8`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[`Only for `,_jsx(`code`,{children:`user-facing`}),` and `,_jsx(`code`,{children:`background`}),` agents.`]}),_jsx(_components.td,{})]})]})]})}),_jsx(ParamField,{body:`temperature`,type:`float`,id:`param-temperature`,children:_jsxs(_components.p,{children:[`A higher temperature value, such as 1, allows for more randomness and\ncreativity in the responses. This can lead to more diverse and unexpected\nanswers. On the other hand, a lower temperature value, closer to 0, produces\nmore focused and deterministic responses, making them more conservative and\npredictable. Options are values as a float between `,_jsx(`code`,{children:`0`}),` and`,` `,`\n`,_jsx(`code`,{children:`1`}),_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`user-facing`}),` agents.`]})}),_jsx(ParamField,{body:`bias`,type:`float`,id:`param-bias`,children:_jsxs(_components.p,{children:[`How AI supervisor should be biased towards the agent. A higher value will make the AI supervisor more biased towards the agent. Options are values as a float between `,_jsx(`code`,{children:`0`}),` and `,_jsx(`code`,{children:`1`}),`.`,_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`user-facing`}),`, `,_jsx(`code`,{children:`human-escalation`}),`, `,_jsx(`code`,{children:`pre-canned`}),` and `,_jsx(`code`,{children:`spam-defense`}),` agents.`]})}),_jsx(ParamField,{body:`stickness`,type:`float`,id:`param-stickness`,children:_jsxs(_components.p,{children:[`How sticky the AI supervisor should be stick with the agent when the lastest user’s query is handled by this agent. Options are values as a float between `,_jsx(`code`,{children:`0`}),` and `,_jsx(`code`,{children:`1`}),`.`,_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`user-facing`}),`, `,_jsx(`code`,{children:`human-escalation`}),`, `,_jsx(`code`,{children:`pre-canned`}),` and `,_jsx(`code`,{children:`spam-defense`}),` agents.`]})}),_jsx(ParamField,{body:`default_message`,type:`string`,id:`param-default-message`,children:_jsxs(_components.p,{children:[`Default message to show when the agent is triggered. `,_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`pre-canned`}),` and `,_jsx(`code`,{children:`spam-defense`}),` agents.`]})}),_jsx(ParamField,{body:`tags`,type:`tags Object`,id:`param-tags`,children:_jsxs(_components.p,{children:[`Tags defined for the agent. `,_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`background`}),` agents.`]})}),_jsx(ParamField,{body:`use_all_sources`,type:`boolean`,id:`param-use-all-sources`,children:_jsxs(_components.p,{children:[`Use all sources for the agent.`,_jsx(`br`,{}),`\nOnly for `,_jsx(`code`,{children:`user-facing`}),` agents.`]})})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Agent Properties","description":"Detailed explanation of agent's properties","href":"/api-reference/agents/properties-reference"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-font-medium {\n font-weight: 500\n}","subdomain":"chatsistant","siteName":"Chatsistant API","title":"Agent Properties - Chatsistant API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T05:56:51.242Z","originalFileLocation":"api-reference/agents/properties-reference.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=\"Detailed explanation of agent\u0026#x27;s properties\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chatsistant API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chatsistant/jsSqGek8HR7LeVmL/_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/chatsistant/jsSqGek8HR7LeVmL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chatsistant/jsSqGek8HR7LeVmL/_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/chatsistant/jsSqGek8HR7LeVmL/_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/chatsistant/jsSqGek8HR7LeVmL/_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/chatsistant/jsSqGek8HR7LeVmL/_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/chatsistant/jsSqGek8HR7LeVmL/_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/chatsistant/jsSqGek8HR7LeVmL/_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/chatsistant/jsSqGek8HR7LeVmL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Agent Properties - Chatsistant API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Detailed explanation of agent\u0026#x27;s properties\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chatsistant API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.chatsistant.com/api-reference/agents/properties-reference\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chatsistant.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Agent+Properties\u0026amp;description=Detailed+explanation+of+agent%27s+properties\u0026amp;theme=33abd71618eceb5ad98b303c\u0026amp;signature=0a75dd29578cb7dcaa6bde0ad9ddbb0cbea7f4ad6f8250aeb07a6ce967b8b109\">\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=\"Agent Properties - Chatsistant API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Detailed explanation of agent\u0026#x27;s properties\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chatsistant.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Agent+Properties\u0026amp;description=Detailed+explanation+of+agent%27s+properties\u0026amp;theme=33abd71618eceb5ad98b303c\u0026amp;signature=0a75dd29578cb7dcaa6bde0ad9ddbb0cbea7f4ad6f8250aeb07a6ce967b8b109\">\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/chatsistant/jsSqGek8HR7LeVmL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chatsistant API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2E3F51\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.chatsistant.com/api-reference/agents/properties-reference\">\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/properties-reference.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.chatsistant.com/#organization\",\"name\":\"Chatsistant API\",\"url\":\"https://docs.chatsistant.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chatsistant/cM2IU8RXqv-3TQFG/logo/light.svg?fit=max\u0026auto=format\u0026n=cM2IU8RXqv-3TQFG\u0026q=85\u0026s=9d3655b647b4e05dab0f447b19ea9b1b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.chatsistant.com#website\",\"name\":\"Chatsistant API\",\"url\":\"https://docs.chatsistant.com\",\"publisher\":{\"@id\":\"https://docs.chatsistant.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.chatsistant.com/api-reference/agents/properties-reference#webpage\",\"url\":\"https://docs.chatsistant.com/api-reference/agents/properties-reference\",\"name\":\"Agent Properties\",\"description\":\"Detailed explanation of agent's properties\",\"dateModified\":\"2026-01-07T05:56:51.242Z\",\"isPartOf\":{\"@id\":\"https://docs.chatsistant.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.chatsistant.com/api-reference/agents/properties-reference#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.chatsistant.com/api-reference/agents/properties-reference#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Chatsistant API\",\"item\":\"https://docs.chatsistant.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agent Properties\",\"item\":\"https://docs.chatsistant.com/api-reference/agents/properties-reference\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.chatsistant.com/api-reference/agents/properties-reference#article\",\"headline\":\"Agent Properties\",\"name\":\"Agent Properties\",\"description\":\"Detailed explanation of agent's properties\",\"url\":\"https://docs.chatsistant.com/api-reference/agents/properties-reference\",\"mainEntityOfPage\":{\"@id\":\"https://docs.chatsistant.com/api-reference/agents/properties-reference#webpage\"},\"dateModified\":\"2026-01-07T05:56:51.242Z\",\"publisher\":{\"@id\":\"https://docs.chatsistant.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.chatsistant.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chatsistant API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Chatsistant API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/agents/properties-reference.md","siteName":"Chatsistant API","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"anchor":"API References","icon":"code","groups":[{"group":"API Usage Guides","pages":[{"title":"Getting a Chatsistant API Key","href":"/api-reference/api-key-setup"},{"title":"Create Chatbot","href":"/api-reference/guide-00-chatbot-create"},{"title":"Chat with Chatbot","href":"/api-reference/guide-01-chat"},{"title":"Uploading Data Sources","href":"/api-reference/guide-02-source"}]},{"group":"Chatbots","pages":[{"title":"Chatbot Properties","href":"/api-reference/chatbots/properties-reference"},{"title":"Create Chatbot","api":"POST https://app.chatsistant.com/api/v1/chatbot/create","href":"/api-reference/chatbots/create"},{"title":"Update Chatbot","api":"POST https://app.chatsistant.com/api/v1/chatbot/{uuid}/update","href":"/api-reference/chatbots/update"},{"title":"Fetch a Chatbot","api":"GET https://app.chatsistant.com/api/v1/chatbot/{uuid}","href":"/api-reference/chatbots/fetch"},{"title":"Fetch all Chatbots","api":"GET https://app.chatsistant.com/api/v1/chatbots","href":"/api-reference/chatbots/fetch_multi"},{"title":"Delete Chatbot","api":"DELETE https://app.chatsistant.com/api/v1/chatbot/{uuid}/delete","description":"Delete single chatbot base on chatbot uuid","href":"/api-reference/chatbots/delete"}]},{"group":"Agents","pages":[{"title":"Agent Properties","href":"/api-reference/agents/properties-reference"},{"title":"Create Agent","api":"POST https://app.chatsistant.com/api/v1/chatbot/\u003cuuid>/agent/create","description":"Create an agent for a chatbot specified by chatbot uuid","href":"/api-reference/agents/create"},{"title":"Update Agent","api":"POST https://app.chatsistant.com/api/v1/agent/{uuid}/update","href":"/api-reference/agents/update"},{"title":"Fetch all Agents","api":"GET https://app.chatsistant.com/api/v1/chatbot/{uuid}/agents","href":"/api-reference/agents/fetch_multi"},{"title":"Delete Agent","api":"DELETE https://app.chatsistant.com/api/v1/agent/{uuid}/delete","href":"/api-reference/agents/delete"}]},{"group":"Chatbot Sessions","pages":[{"title":"Session Properties","href":"/api-reference/sessions/properties-reference"},{"title":"Create Session","api":"POST https://app.chatsistant.com/api/v1/chatbot/{uuid}/session/create","href":"/api-reference/sessions/create"},{"title":"Fetch a Session","api":"GET https://app.chatsistant.com/api/v1/session/{uuid}","href":"/api-reference/sessions/fetch"},{"title":"Fetch all Sessions","api":"GET https://app.chatsistant.com/api/v1/chatbot/{uuid}/sessions","href":"/api-reference/sessions/fetch_multi"},{"title":"Delete Session","api":"POST https://app.chatsistant.com/api/v1/session/{uuid}/delete","href":"/api-reference/sessions/delete"}]},{"group":"Session Messages","pages":[{"title":"Message Properties","href":"/api-reference/messages/properties-reference"},{"title":"Create Message","api":"POST https://app.chatsistant.com/api/v1/session/{uuid}/message/stream","href":"/api-reference/messages/create"},{"title":"Fetch all Messages","api":"GET https://app.chatsistant.com/api/v1/session/{uuid}/messages","href":"/api-reference/messages/fetch_multi"},{"title":"Delete Message","api":"POST https://app.chatsistant.com/api/v1/message/{uuid}/delete","href":"/api-reference/messages/delete"},{"title":"Delete multiple Messages","api":"POST https://app.chatsistant.com/api/v1/messages/delete","href":"/api-reference/messages/delete_multi"}]},{"group":"Data Sources","pages":[{"title":"Source properties","href":"/api-reference/data-sources/properties-reference"},{"title":"Upload a File","api":"POST https://app.chatsistant.com/api/v1/chatbot/{uuid}/data-source/upload","href":"/api-reference/data-sources/create-file"},{"title":"Create QA Source","api":"POST https://app.chatsistant.com/api/v1/chatbot/{uuid}/data-source/qa","href":"/api-reference/data-sources/create-qa"},{"title":"Create URL Source","api":"POST https://app.chatsistant.com/api/v1/chatbot/{uuid}/data-source/url","href":"/api-reference/data-sources/create-url"},{"title":"Update Source","api":"POST https://app.chatsistant.com/api/v1/data-source/{uuid}/update","href":"/api-reference/data-sources/update"},{"title":"Fetch list of Sources","api":"GET https://app.chatsistant.com/api/v1/chatbot/{uuid}/data-sources","href":"/api-reference/data-sources/fetch_multi"},{"title":"Retrain Sources","api":"POST https://app.chatsistant.com/api/v1/data-sources/url/re-scrape","href":"/api-reference/data-sources/retrain"},{"title":"Delete Source","api":"POST https://app.chatsistant.com/api/v1/data-source/{uuid}/delete","href":"/api-reference/data-sources/delete"},{"title":"Delete multiple Sources","api":"POST https://app.chatsistant.com/api/v1/data-sources/delete","href":"/api-reference/data-sources/delete_multi"}]},{"group":"Data Source Tags","pages":[{"title":"Create Source Tag","api":"POST https://app.chatsistant.com/api/v1/chatbot/\u003cuuid>/source-tag/create","href":"/api-reference/source-tags/create"},{"title":"Fetch all Source Tags","api":"GET https://app.chatsistant.com/api/v1/chatbot/\u003cuuid>/source-tags","href":"/api-reference/source-tags/fetch-multi"},{"title":"Update Source Tag","api":"POST https://app.chatsistant.com/api/v1/source-tag/\u003cuuid>/update","href":"/api-reference/source-tags/update"},{"title":"Delete Source Tag","api":"DELETE https://app.chatsistant.com/api/v1/source-tag/{uuid}/delete","href":"/api-reference/source-tags/delete"}]}]}]},"basePath":"","title":"Agent Properties - Chatsistant API","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}