Configuration settings defining how the system will handle the agent
Show child attributes
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"ChatDash Official Documentation","colors":{"primary":"#0023E6","light":"#0023E6","dark":"#0023E6"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/chatdash/-c4JWgzAK60YXAj4/logo/chat-dash.png?fit=max\u0026auto=format\u0026n=-c4JWgzAK60YXAj4\u0026q=85\u0026s=839bd877fa7b8e43a6555dd6ab10bb87","dark":"https://mintcdn.com/chatdash/-c4JWgzAK60YXAj4/logo/chat-dash.png?fit=max\u0026auto=format\u0026n=-c4JWgzAK60YXAj4\u0026q=85\u0026s=839bd877fa7b8e43a6555dd6ab10bb87"},"navbar":{"links":[{"label":"Support","href":"mailto:support@chat-dash.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://chat-dash.com/agency/clients"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chatdash","hasAudioNarration":false,"actualSubdomain":"chatdash","customDomains":["docs.chat-dash.com"],"gitSource":{"type":"github","owner":"habeen-jun","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e628572b750f6b6f9c20","collectionId":"2c95d72b-590f-4570-934f-21f60bd17e33","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e628572b750f6b6f9c20:success","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":138},{"language":"default","tag":"Stripe Billing","count":23},{"language":"default","tag":"Clients","count":9},{"language":"default","tag":"Agents","count":8},{"language":"default","tag":"Leads","count":8},{"language":"default","tag":"Subscriptions","count":6},{"language":"default","tag":"Conversations","count":5},{"language":"default","tag":"Coupons","count":5},{"language":"default","tag":"Products","count":5},{"language":"default","tag":"Webhook Subscriptions","count":5}]},"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":"api-reference/agents/pages/get-agent","slug":"/api-reference/agents/pages/get-agent","pageMetadata":{"openapi":"get /agents/{agentId}","title":"Fetch Agent","description":"Fetch a specific agent","href":"/api-reference/agents/pages/get-agent","hidden":false},"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: \"Fetch a specific 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":"get /agents/{agentId}","title":"Fetch Agent","description":"Fetch a specific agent","href":"/api-reference/agents/pages/get-agent","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Agent"],"summary":"Fetch Agent","description":"Fetch a specific agent","parameters":["e5868067-d0f8-467d-9c31-3af9a523bbc4","74761b0a-49d5-416f-917b-90bd074bc958"],"responses":{"200":"d37a1a9f-3b61-4953-9fe0-660743e183ca","500":"c2426e38-8c29-4e6f-8aa1-57d60e9b0354"},"method":"get","type":"path","servers":["14149775-adab-4691-aa11-cd2d36d86cab"],"security":[],"path":"/agents/{agentId}","baseUrlOptions":["https://api.chat-dash.com/v1/public"],"title":"Fetch Agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e5868067-d0f8-467d-9c31-3af9a523bbc4":{"name":"Authorization","in":"header","required":true,"description":"All requests to the ChatDash API must be validated with the agency API Key found on your agency profile","schema":{"type":"string","isRequired":true,"description":"All requests to the ChatDash API must be validated with the agency API Key found on your agency profile","uniqueKey":"","typeLabel":"string"}},"74761b0a-49d5-416f-917b-90bd074bc958":{"name":"agentId","in":"path","required":true,"description":"The ID of the agent","schema":{"type":"string","isRequired":true,"description":"The ID of the agent","uniqueKey":"","typeLabel":"string"}}},"responses":{"d37a1a9f-3b61-4953-9fe0-660743e183ca":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","description":"The ID of the agent","uniqueKey":"_id","typeLabel":"string"},"clientId":{"type":"string","description":"The ID of the client the agent is assigned to","uniqueKey":"clientId","typeLabel":"string"},"name":{"type":"string","description":"The agent's name","uniqueKey":"name","typeLabel":"string"},"platform":{"type":"string","enum":["voiceflow","openai","botpress","vectorshift","flowise","vapi","retell","elevenlabs","n8n","custom"],"description":"The agent's platform","uniqueKey":"platform","typeLabel":"enum\u003cstring>"},"apiId":{"type":"string","description":"The 'ID' for interacting with the agent platform's API. Varies by platform:\n- Voiceflow: Project ID\n- OpenAI: Assistant ID\n- Botpress: Messaging API webhook URL\n- Vectorshift: Agent Name on VectorShift\n- Flowise: Chatflow ID\n- Vapi: Assistant ID\n- Retell: Agent ID\n- ElevenLabs: Agent ID\n- n8n: N/A\n- Custom: N/A","uniqueKey":"apiId","typeLabel":"string"},"apiKey":{"type":"string","description":"The 'Key' for interacting with the agent platform's API. Varies by platform:\n- Voiceflow: Dialog API Key\n- OpenAI: API Key\n- Botpress: Personal Access Token\n- Vectorshift: API Key\n- Flowise: API Key\n- Vapi: Private API Key\n- Retell: API Key\n- ElevenLabs: API Key\n- n8n: N/A\n- Custom: N/A","uniqueKey":"apiKey","typeLabel":"string"},"platformCredentials":{"oneOf":[{"type":"object","title":"Botpress","description":"Additional credentials for interacting with certain agent platform's API","properties":{"botId":{"type":"string","description":"Your Botpress bot ID","uniqueKey":"platformCredentials.oneOf.0.botId","typeLabel":"string"},"workspaceId":{"type":"string","description":"Your Botpress workspace ID","uniqueKey":"platformCredentials.oneOf.0.workspaceId","typeLabel":"string"}},"uniqueKey":"platformCredentials.oneOf.0","typeLabel":"Botpress · object"},{"type":"object","title":"Flowise","description":"Additional credentials for interacting with certain agent platform's API","properties":{"baseUrl":{"type":"string","description":"The URL of your deployed Flowise dashboard","uniqueKey":"platformCredentials.oneOf.1.baseUrl","typeLabel":"string"}},"uniqueKey":"platformCredentials.oneOf.1","typeLabel":"Flowise · object"},{"type":"object","title":"Vapi","description":"Additional credentials for interacting with certain agent platform's API","properties":{"publicKey":{"type":"string","description":"Your Vapi public key (only required for using ChatDash's web widget","uniqueKey":"platformCredentials.oneOf.2.publicKey","typeLabel":"string"}},"uniqueKey":"platformCredentials.oneOf.2","typeLabel":"Vapi · object"},{"type":"object","title":"n8n","description":"Additional credentials for interacting with certain agent platform's API","properties":{"baseUrl":{"type":"string","description":"The Chat Webook URL used to trigger your n8n workflow","uniqueKey":"platformCredentials.oneOf.3.baseUrl","typeLabel":"string"}},"uniqueKey":"platformCredentials.oneOf.3","typeLabel":"n8n · object"}],"uniqueKey":"platformCredentials","typeLabel":"Botpress · object | Flowise · object | Vapi · object | n8n · object"},"agentConfig":{"type":"object","description":"Configuration settings defining how the system will handle the agent","properties":{"usingExternalWidget":{"type":"boolean","description":"Whether the agent is using an external widget or interface over ChatDash's native widget. Varied support by platform:\n- Voiceflow: Supported\n- OpenAI: Supported\n- Botpress: Supported\n- Vectorshift: Not Supported\n- Flowise: Supported\n- Vapi: Supported\n- Retell: Supported\n- ElevenLabs: Required to be set to true\n- n8n: Not Supported","uniqueKey":"agentConfig.usingExternalWidget","typeLabel":"boolean"},"useImportWebhook":{"type":"boolean","description":"Whether the agent is using an import webhook to sync in conversations (Retell and Vapi only)","uniqueKey":"agentConfig.useImportWebhook","typeLabel":"boolean"},"isTemplate":{"type":"boolean","description":"Whether the agent is a template used for SaaS mode","uniqueKey":"agentConfig.isTemplate","typeLabel":"boolean"},"isSaas":{"type":"boolean","description":"Whether the agent was created from a template in SaaS mode","uniqueKey":"agentConfig.isSaas","typeLabel":"boolean"}},"uniqueKey":"agentConfig","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"\u003cstring>","clientId":"\u003cstring>","name":"\u003cstring>","platform":"voiceflow","apiId":"\u003cstring>","apiKey":"\u003cstring>","platformCredentials":{"botId":"\u003cstring>","workspaceId":"\u003cstring>"},"agentConfig":{"usingExternalWidget":true,"useImportWebhook":true,"isTemplate":true,"isSaas":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"c2426e38-8c29-4e6f-8aa1-57d60e9b0354":{"description":"Internal Server Error","content":{},"exampleType":"generated"}},"security":{},"servers":{"14149775-adab-4691-aa11-cd2d36d86cab":{"url":"https://api.chat-dash.com/v1/public"}}},"originalFileLocation":"api-reference/agents/openapi-agent.json"},"subdomain":"chatdash","siteName":"ChatDash Official Documentation","title":"Fetch Agent - ChatDash Official Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-15T11:14:07.140Z","originalFileLocation":"api-reference/agents/pages/get-agent.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=\"Fetch a specific agent\">\u003cmeta data-mint-head name=\"application-name\" content=\"ChatDash Official 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/chatdash/98dM2QlFg7BcfCiV/_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/chatdash/98dM2QlFg7BcfCiV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chatdash/98dM2QlFg7BcfCiV/_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/chatdash/98dM2QlFg7BcfCiV/_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/chatdash/98dM2QlFg7BcfCiV/_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/chatdash/98dM2QlFg7BcfCiV/_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/chatdash/98dM2QlFg7BcfCiV/_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/chatdash/98dM2QlFg7BcfCiV/_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/chatdash/98dM2QlFg7BcfCiV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Fetch Agent - ChatDash Official Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch a specific agent\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ChatDash Official Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chatdash.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Fetch+Agent\u0026amp;description=Fetch+a+specific+agent\u0026amp;theme=616147d62f0aaa7203aa8a78\u0026amp;signature=520148c499254f7a7adb16d6db263f8ba4d8981468329aad987725c593d8d037\">\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=\"Fetch Agent - ChatDash Official Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch a specific agent\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chatdash.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Fetch+Agent\u0026amp;description=Fetch+a+specific+agent\u0026amp;theme=616147d62f0aaa7203aa8a78\u0026amp;signature=520148c499254f7a7adb16d6db263f8ba4d8981468329aad987725c593d8d037\">\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/chatdash/98dM2QlFg7BcfCiV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ChatDash Official Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0023E6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent\">\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/pages/get-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.chat-dash.com/#organization\",\"name\":\"ChatDash Official Documentation\",\"url\":\"https://docs.chat-dash.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chatdash/-c4JWgzAK60YXAj4/logo/chat-dash.png?fit=max\u0026auto=format\u0026n=-c4JWgzAK60YXAj4\u0026q=85\u0026s=839bd877fa7b8e43a6555dd6ab10bb87\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.chat-dash.com#website\",\"name\":\"ChatDash Official Documentation\",\"url\":\"https://docs.chat-dash.com\",\"publisher\":{\"@id\":\"https://docs.chat-dash.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent#webpage\",\"url\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent\",\"name\":\"Fetch Agent\",\"description\":\"Fetch a specific agent\",\"dateModified\":\"2025-08-15T11:14:07.140Z\",\"isPartOf\":{\"@id\":\"https://docs.chat-dash.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Fetch Agent\",\"item\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent#apireference\",\"headline\":\"Fetch Agent\",\"name\":\"Fetch Agent\",\"description\":\"Fetch a specific agent\",\"url\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.chat-dash.com/api-reference/agents/pages/get-agent#webpage\"},\"dateModified\":\"2025-08-15T11:14:07.140Z\",\"publisher\":{\"@id\":\"https://docs.chat-dash.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.chat-dash.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ChatDash Official Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ChatDash Official Documentation","nav":{"global":null,"anchors":[{"anchor":"Discord Community","href":"https://discord.com/invite/R9dx4mZphS","icon":"discord"},{"anchor":"API Reference","icon":"rectangle-terminal","groups":[{"group":"Using the API","pages":[{"title":"ChatDash API Introduction","href":"/api-reference/introduction"},{"title":"Use Case Examples","href":"/api-reference/use-case-examples"}]},{"group":"API Reference","pages":[{"group":"Agents","icon":"robot","pages":[{"openapi":"get /agents","title":"Fetch Agents","description":"Fetch all agents in your agency","href":"/api-reference/agents/pages/get-agents"},{"openapi":"get /agents/{agentId}","title":"Fetch Agent","href":"/api-reference/agents/pages/get-agent"},{"openapi":"post /agents","title":"Create Agent","description":"Create a new agent","href":"/api-reference/agents/pages/post-agents"},{"openapi":"put /agents/{agentId}","title":"Update Agent","href":"/api-reference/agents/pages/put-agents"},{"openapi":"delete /agents/{agentId}","title":"Delete Agent","href":"/api-reference/agents/pages/delete-agents"},{"openapi":"get /clients/{clientId}/agents","title":"Fetch Client Agents","href":"/api-reference/agents/pages/get-client-agents"},{"openapi":"put /agents/assign","title":"Assign Agents to Client","href":"/api-reference/agents/pages/put-agents-assign"},{"openapi":"put /agents/{agentId}/unassign","title":"Unassign Agent from Client","href":"/api-reference/agents/pages/put-agents-unassign"}]},{"group":"Clients","icon":"user-tie","pages":[{"openapi":"get /clients","title":"Fetch Clients","href":"/api-reference/clients/pages/get-clients"},{"openapi":"get /clients/{clientId}","title":"Fetch Client","href":"/api-reference/clients/pages/get-client"},{"openapi":"post /clients","title":"Create Client","href":"/api-reference/clients/pages/post-clients"},{"openapi":"put /clients/{clientId}","title":"Update Client","href":"/api-reference/clients/pages/put-clients"},{"openapi":"delete /clients/{clientId}","title":"Delete Client","href":"/api-reference/clients/pages/delete-clients"},{"openapi":"get /clients/{clientId}/members","title":"Fetch Client Members","href":"/api-reference/clients/pages/get-client-members"},{"openapi":"post /clients/{clientId}/members","title":"Add Client Member","href":"/api-reference/clients/pages/post-client-members"},{"openapi":"put /clients/{clientId}/members/{memberId}","title":"Update Client Member","href":"/api-reference/clients/pages/put-client-members"},{"openapi":"delete /clients/{clientId}/members/{memberId}","title":"Remove Client Member","href":"/api-reference/clients/pages/delete-client-members"}]},{"group":"Conversations","icon":"comment","pages":[{"openapi":"get /agents/{agentId}/conversations","title":"Fetch Agent Conversations","href":"/api-reference/conversations/pages/get-agents-conversations"},{"openapi":"get /agents/{agentId}/conversations/{conversationId}","title":"Fetch Single Conversation","href":"/api-reference/conversations/pages/get-conversation"},{"openapi":"post /agents/{agentId}/conversations","title":"Create Conversation","href":"/api-reference/conversations/pages/post-agents-conversations"},{"openapi":"put /agents/{agentId}/conversations/{conversationId}","title":"Update Conversation","href":"/api-reference/conversations/pages/put-agents-conversations"},{"openapi":"delete /agents/{agentId}/conversations/{conversationId}","title":"Delete Conversation","href":"/api-reference/conversations/pages/delete-agents-conversations"}]},{"group":"Audit Logs","icon":"clipboard-list","pages":[{"openapi":"GET /agents/{agentId}/audit-logs","title":"Fetch Agent Audit Logs","href":"/api-reference/audit-logs/pages/get-agents-audit-logs"},{"openapi":"GET /conversations/{conversationId}/audit-logs","title":"Fetch Conversation Audit Logs","href":"/api-reference/audit-logs/pages/get-conversations-audit-logs"}]},{"group":"Messages","icon":"envelope","pages":[{"openapi":"get /agents/{agentId}/conversations/{conversationId}/messages","title":"Get Conversation Messages","href":"/api-reference/messages/pages/get-conversations-messages"},{"openapi":"post /agents/{agentId}/conversations/{conversationId}/messages","title":"Push Conversation Messages","href":"/api-reference/messages/pages/post-conversations-messages"},{"openapi":"put /agents/{agentId}/conversations/{conversationId}/messages","title":"Overwrite Conversation Messages","href":"/api-reference/messages/pages/put-conversations-messages"},{"openapi":"delete /agents/{agentId}/conversations/{conversationId}/messages","title":"Delete Conversation Messages","href":"/api-reference/messages/pages/delete-conversations-messages"}]},{"group":"Analytics","icon":"chart-line","pages":[{"openapi":"post /agents/{agentId}/analytics/query","title":"Query Agent Analytics","href":"/api-reference/analytics/pages/get-analytics"}]},{"group":"Leads","icon":"user-group","pages":[{"openapi":"get /agents/{agentId}/leads","title":"Fetch Agent Leads","href":"/api-reference/leads/pages/get-leads"},{"openapi":"post /agents/{agentId}/leads","title":"Create Leads","href":"/api-reference/leads/pages/post-leads"},{"openapi":"put /agents/{agentId}/leads/{leadId}","title":"Update Lead","href":"/api-reference/leads/pages/put-leads"},{"openapi":"delete /agents/{agentId}/leads/{leadId}","title":"Delete Lead","href":"/api-reference/leads/pages/delete-leads"},{"openapi":"get /agents/{agentId}/leads/tags","title":"Fetch Tags","href":"/api-reference/leads/pages/get-leads-tags"},{"openapi":"post /agents/{agentId}/leads/tags","title":"Create Tag","href":"/api-reference/leads/pages/post-leads-tags"},{"openapi":"put /agents/{agentId}/leads/tags/{tagId}","title":"Update Tag","href":"/api-reference/leads/pages/put-leads-tags"},{"openapi":"delete /agents/{agentId}/leads/tags/{tagId}","title":"Delete Tag","href":"/api-reference/leads/pages/delete-leads-tags"}]},{"group":"AI Analysis","icon":"brain","pages":[{"openapi":"post /agents/{agentId}/conversations/{conversationId}/{endpoint}","title":"Trigger AI Analysis","href":"/api-reference/ai-analysis/pages/post-ai-analysis"}]},{"group":"Stripe Billing","icon":"credit-card","pages":[{"group":"Products","pages":[{"openapi":"get /stripe/connect/accounts/{accountId}/products","title":"List Products","href":"/api-reference/stripe/pages/get-stripe-connect-products"},{"openapi":"get /stripe/connect/accounts/{accountId}/products/{productId}","title":"Get Product","href":"/api-reference/stripe/pages/get-stripe-connect-product"},{"openapi":"post /stripe/connect/accounts/{accountId}/products","title":"Create Product","href":"/api-reference/stripe/pages/post-stripe-connect-products"},{"openapi":"put /stripe/connect/accounts/{accountId}/products/{productId}","title":"Update Product","href":"/api-reference/stripe/pages/put-stripe-connect-product"},{"openapi":"delete /stripe/connect/accounts/{accountId}/products/{productId}","title":"Delete Product","href":"/api-reference/stripe/pages/delete-stripe-connect-product"}]},{"group":"Subscriptions","pages":[{"openapi":"get /stripe/connect/accounts/{accountId}/subscriptions","title":"List Subscriptions","href":"/api-reference/stripe/pages/get-stripe-connect-subscriptions"},{"openapi":"get /stripe/connect/accounts/{accountId}/subscriptions/by-customer","title":"List Subscriptions by Customer","href":"/api-reference/stripe/pages/get-stripe-connect-subscriptions-by-customer"},{"openapi":"get /stripe/connect/accounts/{accountId}/subscriptions/{subscriptionId}","title":"Get Subscription","href":"/api-reference/stripe/pages/get-stripe-connect-subscription"},{"openapi":"post /stripe/connect/accounts/{accountId}/subscriptions","title":"Create Subscription","href":"/api-reference/stripe/pages/post-stripe-connect-subscriptions"},{"openapi":"put /stripe/connect/accounts/{accountId}/subscriptions/{subscriptionId}","title":"Update Subscription","href":"/api-reference/stripe/pages/put-stripe-connect-subscription"},{"openapi":"delete /stripe/connect/accounts/{accountId}/subscriptions/{subscriptionId}","title":"Delete Subscription","href":"/api-reference/stripe/pages/delete-stripe-connect-subscription"}]},{"group":"Transactions","pages":[{"openapi":"get /stripe/connect/accounts/{accountId}/transactions","title":"List Transactions","href":"/api-reference/stripe/pages/get-stripe-connect-transactions"},{"openapi":"get /stripe/connect/accounts/{accountId}/transactions/{transactionId}","title":"Get Transaction","href":"/api-reference/stripe/pages/get-stripe-connect-transaction"}]},{"group":"Invoices","pages":[{"openapi":"get /stripe/connect/accounts/{accountId}/invoices","title":"List Invoices","href":"/api-reference/stripe/pages/get-stripe-connect-invoices"},{"openapi":"get /stripe/connect/accounts/{accountId}/invoices/{invoiceId}","title":"Get Invoice","href":"/api-reference/stripe/pages/get-stripe-connect-invoice"},{"openapi":"post /stripe/connect/accounts/{accountId}/invoices","title":"Create Invoice","href":"/api-reference/stripe/pages/post-stripe-connect-invoices"}]},{"group":"Coupons","pages":[{"openapi":"get /stripe/connect/accounts/{accountId}/coupons","title":"List Coupons","href":"/api-reference/stripe/pages/get-stripe-connect-coupons"},{"openapi":"get /stripe/connect/accounts/{accountId}/coupons/{couponId}","title":"Get Coupon","href":"/api-reference/stripe/pages/get-stripe-connect-coupon"},{"openapi":"post /stripe/connect/accounts/{accountId}/coupons","title":"Create Coupon","href":"/api-reference/stripe/pages/post-stripe-connect-coupons"},{"openapi":"put /stripe/connect/accounts/{accountId}/coupons/{couponId}","title":"Update Coupon","href":"/api-reference/stripe/pages/put-stripe-connect-coupon"},{"openapi":"delete /stripe/connect/accounts/{accountId}/coupons/{couponId}","title":"Delete Coupon","href":"/api-reference/stripe/pages/delete-stripe-connect-coupon"}]},{"group":"Promotion Codes","pages":[{"openapi":"get /stripe/connect/accounts/{accountId}/coupons/{couponId}/promotion-codes","title":"List Promotion Codes by Coupon","href":"/api-reference/stripe/pages/get-stripe-connect-promotion-codes-by-coupon"},{"openapi":"post /stripe/connect/accounts/{accountId}/promotion-codes","title":"Create Promotion Code","href":"/api-reference/stripe/pages/post-stripe-connect-promotion-codes"}]}]},{"group":"Webhook Subscriptions","icon":"webhook","pages":[{"openapi":"get /webhooks/subscriptions","title":"List Webhook Subscriptions","href":"/api-reference/webhooks/pages/get-webhook-subscriptions"},{"openapi":"post /webhooks/subscriptions","title":"Create Webhook Subscription","href":"/api-reference/webhooks/pages/post-webhook-subscriptions"},{"openapi":"get /webhooks/subscriptions/{subscriptionId}","title":"Get Webhook Subscription","href":"/api-reference/webhooks/pages/get-webhook-subscription"},{"openapi":"delete /webhooks/subscriptions/{subscriptionId}","title":"Delete Webhook Subscription","href":"/api-reference/webhooks/pages/delete-webhook-subscription"},{"openapi":"put /webhooks/subscriptions/{subscriptionId}/events","title":"Update Subscription Events","href":"/api-reference/webhooks/pages/put-webhook-subscription-events"}]},{"group":"Phone Numbers","icon":"phone","pages":[{"openapi":"get /clients/{clientId}/phone-numbers","title":"Get Phone Numbers","href":"/api-reference/phone-numbers/pages/get-phone-numbers"},{"openapi":"post /clients/{clientId}/agents/{agentId}/outbound-call","title":"Send Outbound Call","href":"/api-reference/phone-numbers/pages/post-outbound-call"}]}]}]}]},"title":"Fetch Agent - ChatDash Official Documentation","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}