{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Wiredesk","colors":{"primary":"#171717","light":"#ededed","dark":"#171717"},"logo":{"light":"https://mintcdn.com/wiredesk/euBDd50hUTOE-ots/logo/light.svg?fit=max\u0026auto=format\u0026n=euBDd50hUTOE-ots\u0026q=85\u0026s=63b021338caf414206d5334f0e61c038","dark":"https://mintcdn.com/wiredesk/euBDd50hUTOE-ots/logo/dark.svg?fit=max\u0026auto=format\u0026n=euBDd50hUTOE-ots\u0026q=85\u0026s=2ca01c30c77268a24a40f18a090284cc","href":"https://wiredesk.ai"},"favicon":"https://mintcdn.com/wiredesk/euBDd50hUTOE-ots/favicon.svg?fit=max\u0026auto=format\u0026n=euBDd50hUTOE-ots\u0026q=85\u0026s=469d6712e7781effa2ffb0b5b6a4f1c1","navbar":{"links":[{"href":"https://wiredesk.ai/help","label":"Help centre"}],"primary":{"type":"button","label":"Dashboard","href":"https://console.wiredesk.ai/dashboard"}},"footer":{"links":[{"header":"Wiredesk","items":[{"label":"Product","href":"https://wiredesk.ai/product"},{"label":"Pricing","href":"https://wiredesk.ai/pricing"},{"label":"Security","href":"https://wiredesk.ai/security"},{"label":"Contact","href":"https://wiredesk.ai/contact"}]}]},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wiredesk","hasAudioNarration":false,"actualSubdomain":"wiredesk","customDomains":["wiredesk.ai"],"gitSource":{"type":"github","owner":"mayur9210","repo":"wiredesk","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":"","_id":"6ada84c182d526f16508665b"},"chroma":{"latestBuiltDeploymentHistoryId":"6adc2db11885992e09c78004","collectionId":"026f7a6e-57a5-4ef1-80f1-1c6597f04289","liveDeploymentHistoryId":"6adc2db11885992e09c78004","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6adc2db11885992e09c78004","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Guides","count":84},{"language":"default","tag":"API reference","count":25},{"language":"default","tag":"Knowledge","count":15},{"language":"default","tag":"Developers","count":12},{"language":"default","tag":"Account and billing","count":11},{"language":"default","tag":"Actions","count":9},{"language":"default","tag":"Agents","count":8},{"language":"default","tag":"Your workspace","count":8},{"language":"default","tag":"Channels","count":7},{"language":"default","tag":"Chat widget","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","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":"api-reference/knowledge/add-a-knowledge-source","slug":"/api-reference/knowledge/add-a-knowledge-source","pageMetadata":{"title":"Add a knowledge source","description":"Type `text` is indexed before the response (201, `ready`). Type `url` starts a crawl and answers 202 `pending`; poll the list for its status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{agent_id}/knowledge","href":"/api-reference/knowledge/add-a-knowledge-source","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Type \", _jsx(_components.code, {\n children: \"text\"\n }), \" is indexed before the response (201, \", _jsx(_components.code, {\n children: \"ready\"\n }), \"). Type \", _jsx(_components.code, {\n children: \"url\"\n }), \" starts a crawl and answers 202 \", _jsx(_components.code, {\n children: \"pending\"\n }), \"; poll the list for its status.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add a knowledge source","description":"Type `text` is indexed before the response (201, `ready`). Type `url` starts a crawl and answers 202 `pending`; poll the list for its status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{agent_id}/knowledge","href":"/api-reference/knowledge/add-a-knowledge-source","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"add_knowledge_source","tags":["Knowledge"],"summary":"Add a knowledge source","description":"Type `text` is indexed before the response (201, `ready`). Type `url` starts a crawl and answers 202 `pending`; poll the list for its status.","parameters":["186b7718-b516-4bc0-a761-5376626ed4af"],"requestBody":"17c96361-3a84-4c29-b322-a61e6ae7e6c9","responses":{"201":"6ae43259-e850-4117-a0cc-d264d6f4883d","202":"2f1020bf-5fa5-4ee2-8359-c1d2456f2f1a","400":"782bb242-958b-4987-9ad4-6c2422246d53","401":"74fd1ed9-26f6-4439-819b-782e2b677f50","403":"650ea4a3-bcbc-4ec9-b91c-e7cec89168b3","404":"cca3b3b5-4a25-47eb-8f81-fb60d3b66bb3","429":"f0b8f02a-ff5b-4da2-9987-3c1df0551857","502":"c5a05964-7b5c-40ee-b997-ff215e0ae6a9"},"method":"post","type":"path","servers":["29a18b8b-b0f4-4fe3-bd0c-620d44985920"],"security":["524f7325-6266-4e2e-aafa-e15694c7a4a2"],"path":"/agents/{agent_id}/knowledge","baseUrlOptions":["https://wiredesk.ai/api/v1"],"title":"Add a knowledge source","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"186b7718-b516-4bc0-a761-5376626ed4af":{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The agent's id.","uniqueKey":"","typeLabel":"string"},"description":"The agent's id."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["text","url"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"content":{"type":"string","maxLength":200000,"description":"For `text`.","uniqueKey":"content","typeLabel":"string"},"label":{"type":"string","maxLength":200,"description":"For `text`. Defaults to \"Pasted text\".","uniqueKey":"label","typeLabel":"string"},"url":{"type":"string","description":"For `url`: the website to crawl.","uniqueKey":"url","typeLabel":"string"}},"required":["type"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"content":"\u003cstring>","label":"\u003cstring>","url":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6ae43259-e850-4117-a0cc-d264d6f4883d":{"description":"Text, indexed","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.id","typeLabel":"string"},"object":{"type":"string","const":"knowledge_source","uniqueKey":"data.object","typeLabel":"string"},"agent_id":{"type":"string","uniqueKey":"data.agent_id","typeLabel":"string"},"type":{"type":"string","enum":["url","text","file","qa","zendesk_guide","intercom_articles","notion","confluence"],"description":"`qa` is a Q\u0026A answer. `zendesk_guide`, `intercom_articles`, `notion` and `confluence` are synced from a connected app every 15 minutes; they are set up on the agent's Knowledge page.","uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"label":{"type":"string","uniqueKey":"data.label","typeLabel":"string"},"status":{"type":"string","enum":["pending","ready","error"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"error":{"oneOf":[{"type":"string","uniqueKey":"data.error.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.error","typeLabel":"string | null"},"chunk_count":{"type":"integer","uniqueKey":"data.chunk_count","typeLabel":"integer"},"page_count":{"type":"integer","uniqueKey":"data.page_count","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","object":"knowledge_source","agent_id":"\u003cstring>","type":"url","label":"\u003cstring>","status":"pending","error":"\u003cstring>","chunk_count":123,"page_count":123,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"2f1020bf-5fa5-4ee2-8359-c1d2456f2f1a":{"description":"A crawl, started","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.id","typeLabel":"string"},"object":{"type":"string","const":"knowledge_source","uniqueKey":"data.object","typeLabel":"string"},"agent_id":{"type":"string","uniqueKey":"data.agent_id","typeLabel":"string"},"type":{"type":"string","enum":["url","text","file","qa","zendesk_guide","intercom_articles","notion","confluence"],"description":"`qa` is a Q\u0026A answer. `zendesk_guide`, `intercom_articles`, `notion` and `confluence` are synced from a connected app every 15 minutes; they are set up on the agent's Knowledge page.","uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"label":{"type":"string","uniqueKey":"data.label","typeLabel":"string"},"status":{"type":"string","enum":["pending","ready","error"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"error":{"oneOf":[{"type":"string","uniqueKey":"data.error.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.error","typeLabel":"string | null"},"chunk_count":{"type":"integer","uniqueKey":"data.chunk_count","typeLabel":"integer"},"page_count":{"type":"integer","uniqueKey":"data.page_count","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","object":"knowledge_source","agent_id":"\u003cstring>","type":"url","label":"\u003cstring>","status":"pending","error":"\u003cstring>","chunk_count":123,"page_count":123,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"782bb242-958b-4987-9ad4-6c2422246d53":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"74fd1ed9-26f6-4439-819b-782e2b677f50":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"650ea4a3-bcbc-4ec9-b91c-e7cec89168b3":{"description":"Read-only key","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"cca3b3b5-4a25-47eb-8f81-fb60d3b66bb3":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"f0b8f02a-ff5b-4da2-9987-3c1df0551857":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"},"c5a05964-7b5c-40ee-b997-ff215e0ae6a9":{"description":"Upstream failure","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","spend_cap_reached","read_only_key","channel_disabled","knowledge_full","not_found","method_not_allowed","already_exists","conflict","rate_limited","internal_error","upstream_error","not_configured"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>"}}}},"exampleType":"generated"}},"headers":{"x-request-id":{"description":"A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support.","schema":{"type":"string","format":"uuid"}}},"exampleType":"generated"}},"security":{"524f7325-6266-4e2e-aafa-e15694c7a4a2":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key, `wd_...`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"29a18b8b-b0f4-4fe3-bd0c-620d44985920":{"url":"https://wiredesk.ai/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key, `wd_...`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key, `wd_...`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"wiredesk","siteName":"Wiredesk","title":"Add a knowledge source - Wiredesk","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T20:14:24.099Z","originalFileLocation":"api-reference/knowledge/add-a-knowledge-source.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=\"Type text is indexed before the response (201, ready). Type url starts a crawl and answers 202 pending; poll the list for its status.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wiredesk\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_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=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add a knowledge source - Wiredesk\">\u003cmeta data-mint-head property=\"og:description\" content=\"Type text is indexed before the response (201, ready). Type url starts a crawl and answers 202 pending; poll the list for its status.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wiredesk\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wiredesk.mintlify.app/_mintlify/api/og/v2?division=Knowledge\u0026amp;title=Add+a+knowledge+source\u0026amp;description=Type+%60text%60+is+indexed+before+the+response+%28201%2C+%60ready%60%29.+Type+%60url%60+starts+a+crawl+and+answers+202+%60pending%60%3B+poll+the+list+for+its+status.\u0026amp;theme=b556289cf0ea9284b957bed9\u0026amp;signature=26f8790bbcc795238efebcc4c4a7aa266cf4c809317b88e2ec7a77f4222c933b\">\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=\"Add a knowledge source - Wiredesk\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Type text is indexed before the response (201, ready). Type url starts a crawl and answers 202 pending; poll the list for its status.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wiredesk.mintlify.app/_mintlify/api/og/v2?division=Knowledge\u0026amp;title=Add+a+knowledge+source\u0026amp;description=Type+%60text%60+is+indexed+before+the+response+%28201%2C+%60ready%60%29.+Type+%60url%60+starts+a+crawl+and+answers+202+%60pending%60%3B+poll+the+list+for+its+status.\u0026amp;theme=b556289cf0ea9284b957bed9\u0026amp;signature=26f8790bbcc795238efebcc4c4a7aa266cf4c809317b88e2ec7a77f4222c933b\">\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=\"/docs/mintlify-assets/_mintlify/favicons/wiredesk/EOsjaLA3oEif4yEE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wiredesk\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/knowledge/add-a-knowledge-source.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://wiredesk.ai/#organization\",\"name\":\"Wiredesk\",\"url\":\"https://wiredesk.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wiredesk/euBDd50hUTOE-ots/logo/light.svg?fit=max\u0026auto=format\u0026n=euBDd50hUTOE-ots\u0026q=85\u0026s=63b021338caf414206d5334f0e61c038\"}},{\"@type\":\"WebSite\",\"@id\":\"https://wiredesk.ai/docs#website\",\"name\":\"Wiredesk\",\"url\":\"https://wiredesk.ai/docs\",\"publisher\":{\"@id\":\"https://wiredesk.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source#webpage\",\"url\":\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source\",\"name\":\"Add a knowledge source\",\"description\":\"Type text is indexed before the response (201, ready). Type url starts a crawl and answers 202 pending; poll the list for its status.\",\"dateModified\":\"2026-10-22T20:14:24.099Z\",\"isPartOf\":{\"@id\":\"https://wiredesk.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Knowledge\",\"item\":\"https://wiredesk.ai/docs/api-reference/knowledge/list-knowledge-sources\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add a knowledge source\",\"item\":\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source#apireference\",\"headline\":\"Add a knowledge source\",\"name\":\"Add a knowledge source\",\"description\":\"Type text is indexed before the response (201, ready). Type url starts a crawl and answers 202 pending; poll the list for its status.\",\"url\":\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source\",\"mainEntityOfPage\":{\"@id\":\"https://wiredesk.ai/docs/api-reference/knowledge/add-a-knowledge-source#webpage\"},\"dateModified\":\"2026-10-22T20:14:24.099Z\",\"publisher\":{\"@id\":\"https://wiredesk.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://wiredesk.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wiredesk\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Wiredesk","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers/overview"}]},{"tab":"API reference","groups":[{"group":"Get started","pages":[{"title":"Getting started","icon":"rocket","href":"/api-reference/introduction"},{"title":"Authentication","icon":"lock","href":"/api-reference/authentication"},{"title":"Conventions","icon":"book","href":"/api-reference/conventions"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/agents/list-agents"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{agent_id}","href":"/api-reference/agents/get-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{agent_id}","href":"/api-reference/agents/update-an-agent"}]},{"group":"Chat","pages":[{"title":"Send a message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{agent_id}/chat","href":"/api-reference/chat/send-a-message"}]},{"group":"Knowledge","pages":[{"title":"List knowledge sources","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{agent_id}/knowledge","href":"/api-reference/knowledge/list-knowledge-sources"},{"title":"Add a knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{agent_id}/knowledge","href":"/api-reference/knowledge/add-a-knowledge-source"},{"title":"Search knowledge","description":"The passages the agent's own knowledge search finds for `q`, best first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{agent_id}/knowledge/search","href":"/api-reference/knowledge/search-knowledge"},{"title":"Delete a knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{agent_id}/knowledge/{source_id}","href":"/api-reference/knowledge/delete-a-knowledge-source"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Search conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations/search","href":"/api-reference/conversations/search-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-messages"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts/{contact_id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"}]},{"group":"Leads","pages":[{"title":"List leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /leads","href":"/api-reference/leads/list-leads"}]},{"group":"Onboarding","pages":[{"title":"Start an onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding","href":"/api-reference/onboarding/start-an-onboarding"},{"title":"Get an onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /onboarding/{onboarding_id}","href":"/api-reference/onboarding/get-an-onboarding"},{"title":"Claim an onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/{onboarding_id}/claim","href":"/api-reference/onboarding/claim-an-onboarding"},{"title":"Delete an onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /onboarding/{onboarding_id}","href":"/api-reference/onboarding/delete-an-onboarding"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Add a knowledge source - Wiredesk","buildId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","deploymentId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_4Sesi0.js","utils-DRHeK26p.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6d-DUc2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dex7slho.js","snippetPresets-BcCEBp0Z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CufowNTX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-A4lJSCIe.js","shallow-DqoHP7zn.js","getApiPlaygroundDisplay-Cku8AmtL.js","CodeSnippet-CtHQbNqc.js","CodeSnippets-CGo5Cslf.js","Page-BoJxk0m8.js","getPastedJson-M-bKdue4.js","icon-DEqCU4st.js","MethodPill-DnfSSXiJ.js","DuplicateIcon-BHu2PE8M.js","createIcon-BPsE5X7c.js","DynamicMarkdown-Dnt6YhtR.js","SectionHeading-6CtFWqMQ.js","axios-vUo_bRtp.js","Markdown-BoKe_1fI.js","clsx-DM5-sUNJ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CkIdkovK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B3e6Nh_r.js"]}