The message sent by the agent to initiate an interaction. This property supports Handlebars template format where you have access to the user and agent parameters. You can use these parameters to add context and personalize the message.
The system prompt that will be injected at the beginning of each interaction. This property supports Handlebars template format where you have access to the user and agent parameters. You can use these parameters to provide rich context to the agent and steer it in a specific direction.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Proficient AI Documentation","colors":{"primary":"#8535f0","light":"#5659f0","dark":"#5659f0"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/proficientai/FLSho9m8n9aeXKxf/logo/light.png?fit=max\u0026auto=format\u0026n=FLSho9m8n9aeXKxf\u0026q=85\u0026s=6689e8fc19bf2b816777d3c19dd24acc","dark":"https://mintcdn.com/proficientai/FLSho9m8n9aeXKxf/logo/dark.png?fit=max\u0026auto=format\u0026n=FLSho9m8n9aeXKxf\u0026q=85\u0026s=612c2a3f66e74b1825dde3f1097c771e","href":"https://proficientai.com"},"api":{"openapi":["admin-openapi.yml","client-openapi.yml"],"playground":{"display":"interactive"},"mdx":{"server":"https://api.proficientai.com","auth":{"method":"key","name":null}}},"background":{"image":"https://mintlify.s3.us-west-1.amazonaws.com/proficientai/images/bg.png","decoration":null,"color":{"light":"#f9f7fc","dark":"#14111C"}},"navbar":{"links":[{"label":"GitHub","href":"https://github.com/proficientai/js"}],"primary":{"type":"button","label":"Request Access","href":"https://proficientai.com/access"}},"footer":{"socials":{"discord":"https://discord.gg/DVbwTM8erb","github":"https://github.com/proficientai","twitter":"https://twitter.com/proficientai","linkedin":"https://linkedin.com/company/proficientai"}},"integrations":{"posthog":{"apiKey":"phc_9KnDgBFBrOLG4Sp9dbn6nVpighZAkNDbimz0CGib5Uo"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"proficientai","hasAudioNarration":false,"actualSubdomain":"proficientai","customDomains":["docs.proficientai.com"],"gitSource":{"type":"github","owner":"proficientai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c35512ef21155ee551bc","collectionId":"8b5d8ba7-4b73-472a-9401-c4dac5099a89","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c35512ef21155ee551bc:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Admin API Reference","count":17},{"language":"default","tag":"Client API Reference","count":16},{"language":"default","tag":"Agents","count":11},{"language":"default","tag":"Documentation","count":9},{"language":"default","tag":"Users","count":7},{"language":"default","tag":"Interactions","count":5},{"language":"default","tag":"Messages","count":4},{"language":"default","tag":"SDKs","count":4},{"language":"default","tag":"Admin API","count":3},{"language":"default","tag":"Client API","count":3}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"admin-api/agents/get_config","slug":"/admin-api/agents/get_config","pageMetadata":{"openapi":"admin-openapi GET /agents/{agent_id}/config","title":"Retrieve agent configuration","description":"Retrieves the current configuration of the specified agent.","href":"/admin-api/agents/get_config"},"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: \"Retrieves the current configuration of the specified agent.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"admin-openapi GET /agents/{agent_id}/config","title":"Retrieve agent configuration","description":"Retrieves the current configuration of the specified agent.","href":"/admin-api/agents/get_config"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Retrieves the current configuration of the specified agent.","operationId":"agents_getConfig","tags":["Agents"],"parameters":["53a506cb-20a3-4f85-8807-b2079edc6362"],"responses":{"200":"c42856bc-18ee-41a0-9473-62680d7a483a","404":"f1007098-60da-4ecb-9d4d-520ed45b6654","500":"1e9a95f3-eaa3-4746-a1be-ad70a54f84a5"},"summary":"Retrieve agent configuration","method":"get","type":"path","servers":["76f8aeb6-3235-4ed5-883a-5725d9224d30","fd0568a0-83ce-4ce5-bd5e-1c5c98c70b96","e1076228-7f3f-4a79-b955-74162433967d"],"security":[],"path":"/agents/{agent_id}/config","baseUrlOptions":["https://api.proficientai.com","https://main-64bxvpctea-uc.a.run.app","http://localhost:8080"],"title":"Retrieve agent configuration","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"53a506cb-20a3-4f85-8807-b2079edc6362":{"name":"agent_id","in":"path","required":true,"schema":{"title":"AgentId","type":"string","description":"The unique identifier of the agent","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"c42856bc-18ee-41a0-9473-62680d7a483a":{"description":"","content":{"application/json":{"schema":{"title":"AgentConfig","type":"object","description":"Represents the current configuration of the agent. This is an admin-level resource that is not exposed to the users.","properties":{"object":{"title":"AgentConfigObjectType","type":"string","enum":["agent_config"],"description":"The type of the `AgentConfig` object","isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"anthropic":{"title":"AnthropicConfig","type":"object","description":"The configuration that is applied to Anthropic models.","properties":{"temperature":{"oneOf":[{"title":"AnthropicConfigTemperature","type":"number","format":"double","description":"\u003cp>Determines the level of randomness in the generated output. Can take values between 0 and 1.0, with higher values like 0.8 resulting in more randomness, and lower values like 0.2 making the output more predictable. See original \u003ca href=\"https://console.anthropic.com/docs/api/reference\">definition\u003c/a>.\u003c/p>","uniqueKey":"anthropic.temperature.oneOf.0","typeLabel":"number\u003cdouble>"},{"title":"AnthropicConfigTemperature","type":"null","format":"double","description":"\u003cp>Determines the level of randomness in the generated output. Can take values between 0 and 1.0, with higher values like 0.8 resulting in more randomness, and lower values like 0.2 making the output more predictable. See original \u003ca href=\"https://console.anthropic.com/docs/api/reference\">definition\u003c/a>.\u003c/p>","uniqueKey":"anthropic.temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"anthropic.temperature","typeLabel":"number\u003cdouble> | null"},"top_k":{"oneOf":[{"title":"AnthropicConfigTopK","type":"integer","description":"\u003cp>Only sample from the top K options for each subsequent token. Used to remove \"long tail\" low probability responses. Defaults to -1, which disables it. See original \u003ca href=\"https://console.anthropic.com/docs/api/reference\">definition\u003c/a>. See \u003ca href=\"https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277\">technical details\u003c/a>.\u003c/p>","uniqueKey":"anthropic.top_k.oneOf.0","typeLabel":"integer"},{"title":"AnthropicConfigTopK","type":"null","description":"\u003cp>Only sample from the top K options for each subsequent token. Used to remove \"long tail\" low probability responses. Defaults to -1, which disables it. See original \u003ca href=\"https://console.anthropic.com/docs/api/reference\">definition\u003c/a>. See \u003ca href=\"https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277\">technical details\u003c/a>.\u003c/p>","uniqueKey":"anthropic.top_k.oneOf.1","typeLabel":"null"}],"uniqueKey":"anthropic.top_k","typeLabel":"integer | null"},"top_p":{"oneOf":[{"title":"AnthropicConfigTopP","type":"number","format":"double","description":"\u003cp>An alternative to the \u003ccode>temperature\u003c/code> option. Uses a method called nucleus sampling, which involves considering only the tokens with the highest probability mass. It specifies the proportion of the probability mass to consider, with a value of 0.1 indicating that only the tokens comprising the top 10% probability mass will be taken into account. In essence, \u003ccode>top_p\u003c/code> determines the size of the set of tokens to choose from, based on their probabilities. Defaults to -1, which disables it. See original \u003ca href=\"https://console.anthropic.com/docs/api/reference\">definition\u003c/a>.\u003c/p>","uniqueKey":"anthropic.top_p.oneOf.0","typeLabel":"number\u003cdouble>"},{"title":"AnthropicConfigTopP","type":"null","format":"double","description":"\u003cp>An alternative to the \u003ccode>temperature\u003c/code> option. Uses a method called nucleus sampling, which involves considering only the tokens with the highest probability mass. It specifies the proportion of the probability mass to consider, with a value of 0.1 indicating that only the tokens comprising the top 10% probability mass will be taken into account. In essence, \u003ccode>top_p\u003c/code> determines the size of the set of tokens to choose from, based on their probabilities. Defaults to -1, which disables it. See original \u003ca href=\"https://console.anthropic.com/docs/api/reference\">definition\u003c/a>.\u003c/p>","uniqueKey":"anthropic.top_p.oneOf.1","typeLabel":"null"}],"uniqueKey":"anthropic.top_p","typeLabel":"number\u003cdouble> | null"}},"isRequired":true,"uniqueKey":"anthropic","typeLabel":"AnthropicConfig · object"},"agent_id":{"title":"AgentId","type":"string","description":"The unique identifier of the agent","isRequired":true,"uniqueKey":"agent_id","typeLabel":"string"},"greeting_message":{"title":"GreetingMessage","type":"string","description":"\u003cp>The message sent by the agent to initiate an interaction. This property supports \u003ca href=\"https://handlebarsjs.com/guide/#what-is-handlebars\">Handlebars\u003c/a> template format where you have access to the \u003ccode>user\u003c/code> and \u003ccode>agent\u003c/code> parameters. You can use these parameters to add context and personalize the message.\u003c/p>","isRequired":true,"uniqueKey":"greeting_message","typeLabel":"string"},"initial_turn":{"title":"InitialTurn","type":"string","enum":["user","agent"],"description":"Indicates who sends the first message in each interaction. Defaults to `\"user\"`.","isRequired":true,"uniqueKey":"initial_turn","typeLabel":"enum\u003cstring>"},"model":{"title":"Model","type":"string","enum":["anthropic.claude-v1","anthropic.claude-v1-100k","anthropic.claude-instant-v1","anthropic.claude-instant-v1-100k","openai.gpt-4","openai.gpt-3.5-turbo","openai.gpt-3.5-turbo-16k"],"description":"The underlying model that powers the agent.","isRequired":true,"uniqueKey":"model","typeLabel":"enum\u003cstring>"},"openai":{"title":"OpenAIConfig","type":"object","description":"The configuration that is applied to OpenAI models.","properties":{"frequency_penalty":{"oneOf":[{"title":"OpenAIConfigFrequencyPenalty","type":"number","format":"double","description":"\u003cp>Can take values between -2.0 and 2.0, with positive values penalizing the model for generating new tokens that have already appeared frequently in the generated text so far. This reduces the likelihood of the model repeating the same line or phrase verbatim. In essence, a higher positive value for \u003ccode>frequency_penalty\u003c/code> encourages the model to use less frequently used tokens in the generated text. See original \u003ca href=\"https://platform.openai.com/docs/api-reference/completions/create#completions/create-frequency_penalty\">definition\u003c/a>.\u003c/p>","uniqueKey":"openai.frequency_penalty.oneOf.0","typeLabel":"number\u003cdouble>"},{"title":"OpenAIConfigFrequencyPenalty","type":"null","format":"double","description":"\u003cp>Can take values between -2.0 and 2.0, with positive values penalizing the model for generating new tokens that have already appeared frequently in the generated text so far. This reduces the likelihood of the model repeating the same line or phrase verbatim. In essence, a higher positive value for \u003ccode>frequency_penalty\u003c/code> encourages the model to use less frequently used tokens in the generated text. See original \u003ca href=\"https://platform.openai.com/docs/api-reference/completions/create#completions/create-frequency_penalty\">definition\u003c/a>.\u003c/p>","uniqueKey":"openai.frequency_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"openai.frequency_penalty","typeLabel":"number\u003cdouble> | null"},"presence_penalty":{"oneOf":[{"title":"OpenAIConfigPresencePenalty","type":"number","format":"double","description":"\u003cp>Can take values between -2.0 and 2.0, with positive values penalizing the model for generating new tokens that have already appeared in the generated text. This encourages the model to generate text about new topics and increases the likelihood of generating more diverse content. In essence, a higher positive value for \u003ccode>presence_penalty\u003c/code> will lead to more avoidance of repeating previously used tokens in the generated text. See original \u003ca href=\"https://platform.openai.com/docs/api-reference/completions/create#completions/create-presence_penalty\">definition\u003c/a>.\u003c/p>","uniqueKey":"openai.presence_penalty.oneOf.0","typeLabel":"number\u003cdouble>"},{"title":"OpenAIConfigPresencePenalty","type":"null","format":"double","description":"\u003cp>Can take values between -2.0 and 2.0, with positive values penalizing the model for generating new tokens that have already appeared in the generated text. This encourages the model to generate text about new topics and increases the likelihood of generating more diverse content. In essence, a higher positive value for \u003ccode>presence_penalty\u003c/code> will lead to more avoidance of repeating previously used tokens in the generated text. See original \u003ca href=\"https://platform.openai.com/docs/api-reference/completions/create#completions/create-presence_penalty\">definition\u003c/a>.\u003c/p>","uniqueKey":"openai.presence_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"openai.presence_penalty","typeLabel":"number\u003cdouble> | null"},"temperature":{"oneOf":[{"title":"OpenAIConfigTemperature","type":"number","format":"double","description":"\u003cp>Determines the level of randomness in the generated output. Can take values between 0 and 2.0, with higher values like 0.8 resulting in more randomness, and lower values like 0.2 making the output more predictable. See original \u003ca href=\"https://platform.openai.com/docs/api-reference/completions/create#completions/create-temperature\">definition\u003c/a>.\u003c/p>","uniqueKey":"openai.temperature.oneOf.0","typeLabel":"number\u003cdouble>"},{"title":"OpenAIConfigTemperature","type":"null","format":"double","description":"\u003cp>Determines the level of randomness in the generated output. Can take values between 0 and 2.0, with higher values like 0.8 resulting in more randomness, and lower values like 0.2 making the output more predictable. See original \u003ca href=\"https://platform.openai.com/docs/api-reference/completions/create#completions/create-temperature\">definition\u003c/a>.\u003c/p>","uniqueKey":"openai.temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"openai.temperature","typeLabel":"number\u003cdouble> | null"},"top_p":{"oneOf":[{"title":"OpenAIConfigTopP","type":"number","format":"double","description":"\u003cp>An alternative to the \u003ccode>temperature\u003c/code> option. Uses a method called nucleus sampling, which involves considering only the tokens with the highest probability mass. It specifies the proportion of the probability mass to consider, with a value of 0.1 indicating that only the tokens comprising the top 10% probability mass will be taken into account. In essence, \u003ccode>top_p\u003c/code> determines the size of the set of tokens to choose from, based on their probabilities. See original \u003ca href=\"https://platform.openai.com/docs/api-reference/completions/create#completions/create-top_p\">definition\u003c/a>.\u003c/p>","uniqueKey":"openai.top_p.oneOf.0","typeLabel":"number\u003cdouble>"},{"title":"OpenAIConfigTopP","type":"null","format":"double","description":"\u003cp>An alternative to the \u003ccode>temperature\u003c/code> option. Uses a method called nucleus sampling, which involves considering only the tokens with the highest probability mass. It specifies the proportion of the probability mass to consider, with a value of 0.1 indicating that only the tokens comprising the top 10% probability mass will be taken into account. In essence, \u003ccode>top_p\u003c/code> determines the size of the set of tokens to choose from, based on their probabilities. See original \u003ca href=\"https://platform.openai.com/docs/api-reference/completions/create#completions/create-top_p\">definition\u003c/a>.\u003c/p>","uniqueKey":"openai.top_p.oneOf.1","typeLabel":"null"}],"uniqueKey":"openai.top_p","typeLabel":"number\u003cdouble> | null"}},"isRequired":true,"uniqueKey":"openai","typeLabel":"OpenAIConfig · object"},"system_message":{"title":"SystemMessage","type":"string","description":"\u003cp>The system prompt that will be injected at the beginning of each interaction. This property supports \u003ca href=\"https://handlebarsjs.com/guide/#what-is-handlebars\">Handlebars\u003c/a> template format where you have access to the \u003ccode>user\u003c/code> and \u003ccode>agent\u003c/code> parameters. You can use these parameters to provide rich context to the agent and steer it in a specific direction.\u003c/p>","isRequired":true,"uniqueKey":"system_message","typeLabel":"string"}},"required":["object","anthropic","agent_id","greeting_message","initial_turn","model","openai","system_message"],"uniqueKey":"","typeLabel":"AgentConfig · object"},"examples":{"Example":{"title":"Example","value":{"object":"agent_config","anthropic":{"temperature":123,"top_k":123,"top_p":123},"agent_id":"\u003cstring>","greeting_message":"\u003cstring>","initial_turn":"user","model":"anthropic.claude-v1","openai":{"frequency_penalty":123,"presence_penalty":123,"temperature":123,"top_p":123},"system_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f1007098-60da-4ecb-9d4d-520ed45b6654":{"description":"","content":{"application/json":{"schema":{"title":"ApiError","type":"object","description":"Represents the general interface of an API error. The body of every error returned by the API contains `code` and `message` fields.","properties":{"error":{"title":"ApiErrorBody","type":"object","properties":{"code":{"title":"ApiErrorCode","type":"string","enum":["invalid_request","invalid_credentials","forbidden","resource_not_found","conflict","unavailable","unknown"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"ApiErrorBody · object"}},"required":["error"],"uniqueKey":"","typeLabel":"ApiError · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"1e9a95f3-eaa3-4746-a1be-ad70a54f84a5":{"description":"","content":{"application/json":{"schema":{"title":"ApiError","type":"object","description":"Represents the general interface of an API error. The body of every error returned by the API contains `code` and `message` fields.","properties":{"error":{"title":"ApiErrorBody","type":"object","properties":{"code":{"title":"ApiErrorCode","type":"string","enum":["invalid_request","invalid_credentials","forbidden","resource_not_found","conflict","unavailable","unknown"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"ApiErrorBody · object"}},"required":["error"],"uniqueKey":"","typeLabel":"ApiError · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8591ab3e-53b0-4580-8ba6-9be479eb1e63":{"Key":{"name":"Key","type":"apiKey","in":"header"}}},"servers":{"76f8aeb6-3235-4ed5-883a-5725d9224d30":{"url":"https://api.proficientai.com","description":"Production (The production environment)"},"fd0568a0-83ce-4ce5-bd5e-1c5c98c70b96":{"url":"https://main-64bxvpctea-uc.a.run.app","description":"Staging (The staging environment)"},"e1076228-7f3f-4a79-b955-74162433967d":{"url":"http://localhost:8080","description":"Development (The local environment)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"name":"Key","type":"apiKey","in":"header"},"schema":{"title":"Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Key","name":"Key"}],"title":"Key"}]},"originalFileLocation":"admin-openapi.yml"},"subdomain":"proficientai","siteName":"Proficient AI Documentation","title":"Retrieve agent configuration - Proficient AI Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:48:49.660Z","originalFileLocation":"admin-api/agents/get_config.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=\"Retrieves the current configuration of the specified agent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Proficient AI Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/proficientai/UWEmv4sUfmm3I8jG/_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/proficientai/UWEmv4sUfmm3I8jG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/proficientai/UWEmv4sUfmm3I8jG/_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/proficientai/UWEmv4sUfmm3I8jG/_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/proficientai/UWEmv4sUfmm3I8jG/_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/proficientai/UWEmv4sUfmm3I8jG/_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/proficientai/UWEmv4sUfmm3I8jG/_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/proficientai/UWEmv4sUfmm3I8jG/_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/proficientai/UWEmv4sUfmm3I8jG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve agent configuration - Proficient AI Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves the current configuration of the specified agent.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Proficient AI Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.proficientai.com/admin-api/agents/get_config\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://proficientai.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Retrieve+agent+configuration\u0026amp;description=Retrieves+the+current+configuration+of+the+specified+agent.\u0026amp;theme=e9955307109407130dbb3899\u0026amp;signature=f763958fa1c950ffe71eeef9113b00926d2f06a7a29c180341af5fc204c091cd\">\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=\"Retrieve agent configuration - Proficient AI Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves the current configuration of the specified agent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://proficientai.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Retrieve+agent+configuration\u0026amp;description=Retrieves+the+current+configuration+of+the+specified+agent.\u0026amp;theme=e9955307109407130dbb3899\u0026amp;signature=f763958fa1c950ffe71eeef9113b00926d2f06a7a29c180341af5fc204c091cd\">\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/proficientai/UWEmv4sUfmm3I8jG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Proficient AI Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8535f0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.proficientai.com/admin-api/agents/get_config\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/admin-api/agents/get_config.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.proficientai.com/#organization\",\"name\":\"Proficient AI Documentation\",\"url\":\"https://docs.proficientai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/proficientai/FLSho9m8n9aeXKxf/logo/light.png?fit=max\u0026auto=format\u0026n=FLSho9m8n9aeXKxf\u0026q=85\u0026s=6689e8fc19bf2b816777d3c19dd24acc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.proficientai.com#website\",\"name\":\"Proficient AI Documentation\",\"url\":\"https://docs.proficientai.com\",\"publisher\":{\"@id\":\"https://docs.proficientai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.proficientai.com/admin-api/agents/get_config#webpage\",\"url\":\"https://docs.proficientai.com/admin-api/agents/get_config\",\"name\":\"Retrieve agent configuration\",\"description\":\"Retrieves the current configuration of the specified agent.\",\"dateModified\":\"2026-01-06T22:48:49.660Z\",\"isPartOf\":{\"@id\":\"https://docs.proficientai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.proficientai.com/admin-api/agents/get_config#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.proficientai.com/admin-api/agents/get_config#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.proficientai.com/admin-api/agents/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve agent configuration\",\"item\":\"https://docs.proficientai.com/admin-api/agents/get_config\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.proficientai.com/admin-api/agents/get_config#apireference\",\"headline\":\"Retrieve agent configuration\",\"name\":\"Retrieve agent configuration\",\"description\":\"Retrieves the current configuration of the specified agent.\",\"url\":\"https://docs.proficientai.com/admin-api/agents/get_config\",\"mainEntityOfPage\":{\"@id\":\"https://docs.proficientai.com/admin-api/agents/get_config#webpage\"},\"dateModified\":\"2026-01-06T22:48:49.660Z\",\"publisher\":{\"@id\":\"https://docs.proficientai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.proficientai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Proficient AI Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Proficient AI Documentation","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/intro"}]},{"anchor":"Client API Reference","icon":"rectangle-terminal","pages":[{"title":"Client API Reference","href":"/client-api/intro"}]},{"anchor":"Admin API Reference","icon":"rectangle-terminal","groups":[{"group":"Admin API","pages":[{"title":"Introduction","href":"/admin-api/intro"},{"title":"Authentication","href":"/admin-api/auth"},{"title":"Specification","href":"/admin-api/spec"}]},{"group":"Agents","pages":[{"openapi":"admin-openapi GET /agents","title":"List all agents","href":"/admin-api/agents/list"},{"openapi":"admin-openapi POST /agents","title":"Create an agent","href":"/admin-api/agents/create"},{"openapi":"admin-openapi GET /agents/{agent_id}","title":"Retrieve an agent","href":"/admin-api/agents/get"},{"openapi":"admin-openapi POST /agents/{agent_id}","title":"Update an agent","href":"/admin-api/agents/update"},{"openapi":"admin-openapi DELETE /agents/{agent_id}","title":"Delete an agent","description":"Permanently deletes the specified agent and all the interactions associated with it. This cannot be undone.","href":"/admin-api/agents/delete"},{"openapi":"admin-openapi GET /agents/{agent_id}/config","title":"Retrieve agent configuration","href":"/admin-api/agents/get_config"},{"openapi":"admin-openapi POST /agents/{agent_id}/config","title":"Update agent configuration","description":"Updates the configuration of the specified agent. Only the provided properties will be updated. Any properties not provided will be left unchanged.","href":"/admin-api/agents/update_config"},{"openapi":"admin-openapi POST /agents/{agent_id}/activate","title":"Activate an agent","href":"/admin-api/agents/activate"},{"openapi":"admin-openapi POST /agents/{agent_id}/deactivate","title":"Deactivate an agent","href":"/admin-api/agents/deactivate"}]},{"group":"Users","pages":[{"openapi":"admin-openapi GET /users","title":"List all users","href":"/admin-api/users/list"},{"openapi":"admin-openapi POST /users","title":"Create a user","href":"/admin-api/users/create"},{"openapi":"admin-openapi GET /users/{user_id}","title":"Retrieve a user","href":"/admin-api/users/get"},{"openapi":"admin-openapi POST /users/{user_id}","title":"Update a user","href":"/admin-api/users/update"},{"openapi":"admin-openapi DELETE /users/{user_id}","title":"Delete a user","href":"/admin-api/users/delete"}]}]},{"anchor":"Community \u0026 Support","href":"https://discord.gg/DVbwTM8erb","icon":"discord"},{"anchor":"GitHub","href":"https://github.com/proficientai/js","icon":"github"}]},"title":"Retrieve agent configuration - Proficient AI Documentation","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}