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.
Unlike user-facing Agents, background Agents are designed to monitor conversations and provide
assistance in the background by assigning tags or calling functions when certain criteria are met.
Agents are completely isolated from one another. This means that you cannot
direct the behavior, bias, or selection priority of one Agent from inside
another Agent.
Background Agents are always run whenever the user submits a new query into the chatbot.
This enables you to create “multi-threaded” workflows that significantly improves the accuracy and
consistency of your chatbots. Instead of tasking a single Agent to coordinate among a multitude of
potentially independent and unrelated tasks, having multiple specialized Agents simultaneously
monitor the conversation and handle subsequent actions will yield much better results.When configuring a background Agent, the prompt should be very simple and concise. Since background
Agents do not generate direct “conversational” output, your instructions should be restricted to variations of
“monitor the conversation for certain user behavior or intent”. You can instruct the background Agent
to set tags or call functions when the corresponding triggers are met.In certain cases, you may still wish to enable RAG for background Agents (if you need to evaluate a
user’s claim against certain policies or historical records before assigning a tag, for instance).
If this is true, you should give the Agent access to the necessary knowledge sources by going to the “Knowledge” tab in the Agent edit dialog.A common user case for background Agents is conversation tagging. For an example of how to use background Agents to assign
conversation tags, see Frustration Detection.
Here’s a fun setup that detects any mention of various fruits during the conversation and assigns the appropriate tags.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"GPT-trainer API","colors":{"primary":"#2E3F51","light":"#516F90","dark":"#0D001D"},"favicon":"https://mintcdn.com/paladinmaxinc/_odr0HDBZYr--Le1/logo/favicon.png?fit=max\u0026auto=format\u0026n=_odr0HDBZYr--Le1\u0026q=85\u0026s=d04dff53c81245c4d48f0301bad6209f","logo":{"light":"https://mintcdn.com/paladinmaxinc/_odr0HDBZYr--Le1/logo/light.svg?fit=max\u0026auto=format\u0026n=_odr0HDBZYr--Le1\u0026q=85\u0026s=e282ced1ff19648529968cefe4eb3deb","dark":"https://mintcdn.com/paladinmaxinc/_odr0HDBZYr--Le1/logo/dark.svg?fit=max\u0026auto=format\u0026n=_odr0HDBZYr--Le1\u0026q=85\u0026s=bee6ec229dfdcd8e2a9654329a38a3c6"},"api":{"mdx":{"server":"https://app.gpt-trainer.com/api","auth":{"method":"bearer","name":null}}},"background":{"decoration":null,"color":{"light":null,"dark":"#111827"}},"navbar":{"links":[{"label":"Support","href":"mailto:hello@gpt-trainer.com"}],"primary":null},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paladinmaxinc","hasAudioNarration":false,"actualSubdomain":"paladinmaxinc","customDomains":["guide.gpt-trainer.com"],"gitSource":{"type":"github","owner":"ks-collab","repo":"gpt-trainer-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e61733a4518725aab1a4","collectionId":"176b19f7-2d23-4aaa-b976-d711aa6932e6","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e61733a4518725aab1a4:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API References","count":39},{"language":"default","tag":"Documentation","count":15},{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Data Sources","count":9},{"language":"default","tag":"Chatbots","count":6},{"language":"default","tag":"Session Messages","count":6},{"language":"default","tag":"Whitelabel","count":6},{"language":"default","tag":"Agents","count":5},{"language":"default","tag":"Chatbot Sessions","count":5},{"language":"default","tag":"Integrations","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"background-agents","slug":"/background-agents","pageMetadata":{"title":"Background Agents","description":null,"href":"/background-agents"},"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={a:`a`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Frame,Note,OptimizedImage}=_components;if(!Frame)_missingMdxReference(`Frame`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`GPT-trainer has 2 types of Agents:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`User-facing:`}),` Agent directly interacts with users conversationally in a Q\u0026A fashion.\nOnly a single user-facing Agent engages with the user when a new query is input into the chatbot.`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Background:`}),` Agent never interacts with users directly and instead monitors the conversation\nin an ongoing fashion. All background Agents are run whenever the user submits a new query to the chatbot.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Unlike user-facing Agents, background Agents are designed to monitor conversations and provide\nassistance in the background by `,_jsx(_components.strong,{children:`assigning tags or calling functions`}),` when certain criteria are met.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Agents are completely isolated from one another. This means that you cannot\ndirect the behavior, bias, or selection priority of one Agent from inside\nanother Agent.`})}),`\n`,_jsx(_components.p,{children:`Background Agents are always run whenever the user submits a new query into the chatbot.\nThis enables you to create “multi-threaded” workflows that significantly improves the accuracy and\nconsistency of your chatbots. Instead of tasking a single Agent to coordinate among a multitude of\npotentially independent and unrelated tasks, having multiple specialized Agents simultaneously\nmonitor the conversation and handle subsequent actions will yield much better results.`}),`\n`,_jsx(_components.p,{children:`When configuring a background Agent, the prompt should be very simple and concise. Since background\nAgents do not generate direct “conversational” output, your instructions should be restricted to variations of\n“monitor the conversation for certain user behavior or intent”. You can instruct the background Agent\nto set tags or call functions when the corresponding triggers are met.`}),`\n`,_jsx(_components.p,{children:`In certain cases, you may still wish to enable RAG for background Agents (if you need to evaluate a\nuser’s claim against certain policies or historical records before assigning a tag, for instance).\nIf this is true, you should give the Agent access to the necessary knowledge sources by going to the “Knowledge” tab in the Agent edit dialog.`}),`\n`,_jsxs(_components.p,{children:[`A common user case for background Agents is conversation tagging. For an example of how to use background Agents to assign\nconversation tags, see `,_jsx(_components.a,{href:`/frustration-detection`,children:`Frustration Detection`}),`.`]}),`\n`,_jsx(Frame,{caption:`Here’s a fun setup that detects any mention of various fruits during the conversation and assigns the appropriate tags.`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/paladinmaxinc/eQPaNa5Mj6mg9P8v/images/background-agent-1.png?fit=max\u0026auto=format\u0026n=eQPaNa5Mj6mg9P8v\u0026q=85\u0026s=ab7600e2c1fea3bcf7ac96a38d51626a`,\"data-og-width\":`3486`,width:`3486`,\"data-og-height\":`1910`,height:`1910`,\"data-path\":`images/background-agent-1.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/paladinmaxinc/eQPaNa5Mj6mg9P8v/images/background-agent-1.png?w=280\u0026fit=max\u0026auto=format\u0026n=eQPaNa5Mj6mg9P8v\u0026q=85\u0026s=3e81e9481b55b7ed8cad18b141cbf7a2 280w, https://mintcdn.com/paladinmaxinc/eQPaNa5Mj6mg9P8v/images/background-agent-1.png?w=560\u0026fit=max\u0026auto=format\u0026n=eQPaNa5Mj6mg9P8v\u0026q=85\u0026s=b8690991cdbc3c50c6616cc35e54ffb2 560w, https://mintcdn.com/paladinmaxinc/eQPaNa5Mj6mg9P8v/images/background-agent-1.png?w=840\u0026fit=max\u0026auto=format\u0026n=eQPaNa5Mj6mg9P8v\u0026q=85\u0026s=4aca04c8699fad79c31f7dfe0bf8108b 840w, https://mintcdn.com/paladinmaxinc/eQPaNa5Mj6mg9P8v/images/background-agent-1.png?w=1100\u0026fit=max\u0026auto=format\u0026n=eQPaNa5Mj6mg9P8v\u0026q=85\u0026s=f230e2ecdd4e9f54efcdbc1d8f81f8cc 1100w, https://mintcdn.com/paladinmaxinc/eQPaNa5Mj6mg9P8v/images/background-agent-1.png?w=1650\u0026fit=max\u0026auto=format\u0026n=eQPaNa5Mj6mg9P8v\u0026q=85\u0026s=b6517538a1c3e8fc54b4a217727b640e 1650w, https://mintcdn.com/paladinmaxinc/eQPaNa5Mj6mg9P8v/images/background-agent-1.png?w=2500\u0026fit=max\u0026auto=format\u0026n=eQPaNa5Mj6mg9P8v\u0026q=85\u0026s=09d9417a77dc491bc0e1179569b34f63 2500w`})})]})}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":"Background Agents","description":null,"href":"/background-agents"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"paladinmaxinc","siteName":"GPT-trainer API","title":"Background Agents - GPT-trainer API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T00:48:26.417Z","originalFileLocation":"background-agents.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=\"application-name\" content=\"GPT-trainer 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/paladinmaxinc/rZh3k9QVucZqPJ9E/_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/paladinmaxinc/rZh3k9QVucZqPJ9E/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paladinmaxinc/rZh3k9QVucZqPJ9E/_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/paladinmaxinc/rZh3k9QVucZqPJ9E/_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/paladinmaxinc/rZh3k9QVucZqPJ9E/_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/paladinmaxinc/rZh3k9QVucZqPJ9E/_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/paladinmaxinc/rZh3k9QVucZqPJ9E/_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/paladinmaxinc/rZh3k9QVucZqPJ9E/_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/paladinmaxinc/rZh3k9QVucZqPJ9E/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Background Agents - GPT-trainer API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GPT-trainer API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://guide.gpt-trainer.com/background-agents\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paladinmaxinc.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Background+Agents\u0026amp;theme=d354e6b8b2605c4dee81eb93\u0026amp;signature=4d99734bd65639d85d35d44915692f4060186fad0035e68cf99cbd3a9e50bf9e\">\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=\"Background Agents - GPT-trainer API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paladinmaxinc.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Background+Agents\u0026amp;theme=d354e6b8b2605c4dee81eb93\u0026amp;signature=4d99734bd65639d85d35d44915692f4060186fad0035e68cf99cbd3a9e50bf9e\">\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/paladinmaxinc/rZh3k9QVucZqPJ9E/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GPT-trainer API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2E3F51\">\u003clink data-mint-head rel=\"canonical\" href=\"https://guide.gpt-trainer.com/background-agents\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/background-agents.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GPT-trainer API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"GPT-trainer API","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"}]},{"group":"Guides","pages":[{"title":"Create Your First Chatbot","href":"/creating-first-chatbot"},{"title":"Lead Collection","href":"/lead-collection"},{"title":"Human Support Escalation","href":"/human-support-escalation"},{"title":"Inbox Notifications","href":"/inbox-notifications"},{"title":"Conversation Labeling","href":"/conversation-labeling"},{"title":"Multi-Agents Chatbot","href":"/multi-agents-chatbot"},{"title":"Fine Tuning Agent Intents","href":"/fine-tuning-agent-intents"},{"title":"AI Supervisor Overrides","href":"/supervisor-overrides"},{"title":"Bring Your Own Key (BYOK) and Pricing","href":"/byok-pricing-guide"},{"title":"Working with Tables and CSV","href":"/working-with-tables"},{"title":"Best practices for preparing training data","href":"/best-practices"},{"title":"Why does my chatbot not answer correctly?","href":"/help"}]},{"group":"Function Calling","pages":[{"title":"RAG from an External Data Provider","href":"/rag-from-external-data-provider"}]},{"group":"Authentication Webhook","pages":[{"title":"User Identity Verification","href":"/user-identity"}]}]},{"anchor":"API References","icon":"code","groups":[{"group":"API Usage Guides","pages":[{"title":"Getting a GPT-trainer 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.gpt-trainer.com/api/v1/chatbot/create","href":"/api-reference/chatbots/create"},{"title":"Update Chatbot","api":"POST https://app.gpt-trainer.com/api/v1/chatbot/{uuid}/update","href":"/api-reference/chatbots/update"},{"title":"Fetch a Chatbot","api":"GET https://app.gpt-trainer.com/api/v1/chatbot/{uuid}","href":"/api-reference/chatbots/fetch"},{"title":"Fetch All Chatbots","api":"GET https://app.gpt-trainer.com/api/v1/chatbots","href":"/api-reference/chatbots/fetch_multi"},{"title":"Delete Chatbot","api":"DELETE https://app.gpt-trainer.com/api/v1/chatbot/{uuid}/delete","href":"/api-reference/chatbots/delete"}]},{"group":"Agents","pages":[{"title":"Agent Properties","href":"/api-reference/agents/properties-reference"},{"title":"Create Agent","api":"POST https://app.gpt-trainer.com/api/v1/chatbot/\u003cuuid>/agent/create","href":"/api-reference/agents/create"},{"title":"Update Agent","api":"POST https://app.gpt-trainer.com/api/v1/agent/{uuid}/update","href":"/api-reference/agents/update"},{"title":"Fetch All Agents","api":"GET https://app.gpt-trainer.com/api/v1/chatbot/{uuid}/agents","href":"/api-reference/agents/fetch_multi"},{"title":"Delete Agent","api":"DELETE https://app.gpt-trainer.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.gpt-trainer.com/api/v1/chatbot/{uuid}/session/create","href":"/api-reference/sessions/create"},{"title":"Fetch a Session","api":"GET https://app.gpt-trainer.com/api/v1/session/{uuid}","href":"/api-reference/sessions/fetch"},{"title":"Fetch All Sessions","api":"GET https://app.gpt-trainer.com/api/v1/chatbot/{uuid}/sessions","href":"/api-reference/sessions/fetch_multi"},{"title":"Delete Session","api":"POST https://app.gpt-trainer.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.gpt-trainer.com/api/v1/session/{uuid}/message/stream","href":"/api-reference/messages/create"},{"title":"Fetch All Messages","api":"GET https://app.gpt-trainer.com/api/v1/session/{uuid}/messages","href":"/api-reference/messages/fetch_multi"},{"title":"Fetch Session History","api":"GET https://app.gpt-trainer.com/api/v1/session/{uuid}/messages/plain-text","href":"/api-reference/messages/fetch-message-history"},{"title":"Delete Message","api":"POST https://app.gpt-trainer.com/api/v1/message/{uuid}/delete","href":"/api-reference/messages/delete"},{"title":"Delete Multiple Messages","api":"POST https://app.gpt-trainer.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.gpt-trainer.com/api/v1/chatbot/{uuid}/data-source/upload","href":"/api-reference/data-sources/create-file"},{"title":"Create QA Source","api":"POST https://app.gpt-trainer.com/api/v1/chatbot/{uuid}/data-source/qa","href":"/api-reference/data-sources/create-qa"},{"title":"Create URL Source","api":"POST https://app.gpt-trainer.com/api/v1/chatbot/{uuid}/data-source/url","href":"/api-reference/data-sources/create-url"},{"title":"Update Source","api":"POST https://app.gpt-trainer.com/api/v1/data-source/{uuid}/update","href":"/api-reference/data-sources/update"},{"title":"Fetch List of Sources","api":"GET https://app.gpt-trainer.com/api/v1/chatbot/{uuid}/data-sources","href":"/api-reference/data-sources/fetch_multi"},{"title":"Retrain Sources","api":"POST https://app.gpt-trainer.com/api/v1/data-sources/url/re-scrape","href":"/api-reference/data-sources/retrain"},{"title":"Delete Source","api":"POST https://app.gpt-trainer.com/api/v1/data-source/{uuid}/delete","href":"/api-reference/data-sources/delete"},{"title":"Delete Multiple Sources","api":"POST https://app.gpt-trainer.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.gpt-trainer.com/api/v1/chatbot/\u003cuuid>/source-tag/create","href":"/api-reference/source-tags/create"},{"title":"Fetch All Source Tags","api":"GET https://app.gpt-trainer.com/api/v1/chatbot/\u003cuuid>/source-tags","href":"/api-reference/source-tags/fetch-multi"},{"title":"Update Source Tag","api":"POST https://app.gpt-trainer.com/api/v1/source-tag/\u003cuuid>/update","href":"/api-reference/source-tags/update"},{"title":"Delete Source Tag","api":"DELETE https://app.gpt-trainer.com/api/v1/source-tag/{uuid}/delete","href":"/api-reference/source-tags/delete"}]}]},{"anchor":"Integrations","icon":"network-wired","groups":[{"group":"Integrations","pages":[{"title":"Slack","href":"/integrations/slack"}]}]},{"anchor":"Tools","icon":"gear","groups":[{"group":"Tool Guides","pages":[{"title":"Introduction","href":"/tools/tools-intro"}]},{"group":"Tools","pages":[{"title":"Weekday","api":"GET https://tools.gpt-trainer.com/weekday","href":"/tools/weekday"}]}]},{"anchor":"Whitelabel","icon":"browser","groups":[{"group":"Whitelabel Dashboard","pages":[{"title":"Introduction and first-time setup","href":"/whitelabel/whitelabel-intro"},{"title":"Creating plans and pricing considerations","href":"/whitelabel/whitelabel-plans"},{"title":"Managing your users","href":"/whitelabel/whitelabel-users"}]},{"group":"Integrations","pages":[{"title":"Publishing a Zapier app","href":"/whitelabel/whitelabel-zapier"},{"title":"Publishing a Make app","href":"/whitelabel/whitelabel-make"},{"title":"Meta Integration Process","href":"/whitelabel/whitelabel-meta"}]}]}]},"basePath":"","title":"Background Agents - GPT-trainer API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-Bpq2Z6jK.js","DynamicMarkdown-D5M2At0B.js","zoom-image-lightbox-DL4wrF0w.js","lightbox-handle-r17bVUz3.js"]}