{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pineyard API","colors":{"primary":"#2563EB","light":"#6593F6","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/pineyardai/KvvhrFeJze_4l1B1/images/logo-light.png?fit=max\u0026auto=format\u0026n=KvvhrFeJze_4l1B1\u0026q=85\u0026s=d5177d07729810408e04e439d659151b","dark":"https://mintcdn.com/pineyardai/KvvhrFeJze_4l1B1/images/logo-dark.png?fit=max\u0026auto=format\u0026n=KvvhrFeJze_4l1B1\u0026q=85\u0026s=d107a52b232121e74374a8f5c5042f51"},"favicon":"https://mintcdn.com/pineyardai/KvvhrFeJze_4l1B1/images/favicon.svg?fit=max\u0026auto=format\u0026n=KvvhrFeJze_4l1B1\u0026q=85\u0026s=44a3d03fa350bb55cdee8a7c9e8cbcef","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"]}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.pineyard.ai"}},"footer":{"socials":{"website":"https://pineyard.ai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pineyardai","hasAudioNarration":false,"actualSubdomain":"pineyardai","customDomains":["docs.pineyard.ai"],"gitSource":{"type":"github","owner":"pineyardai","repo":"pineyard-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae0138cb1622516ff52ff7f","collectionId":"f3d857f9-e866-470c-84ef-84c647a3f8c3","liveDeploymentHistoryId":"6ae0138cb1622516ff52ff7f","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae03c10ffedfbf24bd45fb4","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API reference","count":170},{"language":"default","tag":"Campaigns","count":95},{"language":"default","tag":"Agents","count":58},{"language":"default","tag":"Calls","count":23},{"language":"default","tag":"Public API (v1)","count":22},{"language":"default","tag":"Results \u0026 insights","count":21},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"Agent documents","count":10},{"language":"default","tag":"Re-run \u0026 re-engage","count":10},{"language":"default","tag":"Contacts","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/create-a-knowledge-base","slug":"/api-reference/create-a-knowledge-base","pageMetadata":{"title":"Create a knowledge base.","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge-bases","href":"/api-reference/create-a-knowledge-base","autogeneratedByOpenApi":true},"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`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Required scope:`}),` `,_jsx(_components.code,{children:`chatbots.edit`})]}),`\n`,_jsxs(Note,{children:[`Requires knowledge bases enabled on your account. Otherwise the request is refused; see `,_jsx(_components.a,{href:`/concepts/errors`,children:`Errors`}),`.`]})]})}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":"Create a knowledge base.","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge-bases","href":"/api-reference/create-a-knowledge-base","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a knowledge base.","requestBody":"1ed8381a-ff80-4ffe-b53a-91be73969436","responses":{"201":"76e8bd0d-8a5f-4087-bec5-4514dc56891d","400":"22a87fd1-d373-442a-9bea-227b8b3b31ea","401":"d76682d8-d66b-4287-b0a1-c1a70e98e490","403":"43c20b61-3f7d-420f-9f76-ea305dea77e4","413":"a3927e0f-058b-4300-94bc-e173c9f7fe53","429":"be4d2f12-7860-4b9d-b884-ae7e8672f9b7","500":"98536adc-831a-4317-8d7e-fdf0d920ed0c","502":"86d4bcc0-8eff-46cc-b357-04c91e867e85","503":"f3729a91-567c-4ade-88b7-1d7c7651025b"},"x-mint":{"content":"**Required scope:** `chatbots.edit`\n\n\u003cNote>Requires knowledge bases enabled on your account. Otherwise the request is refused; see [Errors](/concepts/errors).\u003c/Note>"},"method":"post","type":"path","servers":["2aead7cc-5e40-4b77-98f6-f15ca48526d5"],"security":["fde87ef0-c30d-495d-b91b-1c5c36dd3ef6"],"path":"/knowledge-bases","baseUrlOptions":["https://api.pineyard.ai"],"title":"Create a knowledge base.","description":"","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":1000,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":1000,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"}},"required":["name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","description":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"76e8bd0d-8a5f-4087-bec5-4514dc56891d":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"status":{"type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"documentCount":{"type":"number","isRequired":true,"uniqueKey":"documentCount","typeLabel":"number"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"}},"required":["id","name","description","status","documentCount","createdAt","updatedAt"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","status":"\u003cstring>","documentCount":123,"createdAt":"\u003cstring>","updatedAt":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"22a87fd1-d373-442a-9bea-227b8b3b31ea":{"description":"- `internal_error`: An unexpected error. A `400` with this code usually means the body is not valid JSON; a `413` means the body is larger than 1 MB.\n- `invalid_body`: The request body (or query) failed validation. Details are in `issues` (or `detail`). `422` on `POST /v1/campaigns/{campaignId}/leads`.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d76682d8-d66b-4287-b0a1-c1a70e98e490":{"description":"- `invalid_api_key`: The API key is unknown, revoked or expired, or its workspace was deleted.\n- `unauthorized`: No `Authorization: Bearer` header, or an empty token.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"43c20b61-3f7d-420f-9f76-ea305dea77e4":{"description":"- `api_key_not_scoped`: A key issued without scopes was used outside `/v1`.\n- `api_key_owner_inactive`: The member the key acts for was removed or suspended.\n- `forbidden`: The key lacks the permission named in `requiredPermission`, or the resource belongs to another workspace.\n- `workspace_pending_approval`: The workspace has not been approved yet.\n- `workspace_suspended`: The workspace is suspended.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"a3927e0f-058b-4300-94bc-e173c9f7fe53":{"description":"- `internal_error`: An unexpected error. A `400` with this code usually means the body is not valid JSON; a `413` means the body is larger than 1 MB.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"be4d2f12-7860-4b9d-b884-ae7e8672f9b7":{"description":"- `rate_limited`: Too many requests.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"98536adc-831a-4317-8d7e-fdf0d920ed0c":{"description":"- `internal_error`: An unexpected error. A `400` with this code usually means the body is not valid JSON; a `413` means the body is larger than 1 MB.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"86d4bcc0-8eff-46cc-b357-04c91e867e85":{"description":"- `provider_error`: The calling service rejected the request (`upstreamStatus` 4xx) or was unavailable (5xx).","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"f3729a91-567c-4ade-88b7-1d7c7651025b":{"description":"- `database_unavailable`: The service is temporarily unavailable.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"fde87ef0-c30d-495d-b91b-1c5c36dd3ef6":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"2aead7cc-5e40-4b77-98f6-f15ca48526d5":{"url":"https://api.pineyard.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"pineyardai","siteName":"Pineyard API","title":"Create a knowledge base. - Pineyard API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T05:52:24.884Z","originalFileLocation":"api-reference/create-a-knowledge-base.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=\"Pineyard 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/pineyardai/dZotgJ-4sE05K-4s/_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/pineyardai/dZotgJ-4sE05K-4s/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pineyardai/dZotgJ-4sE05K-4s/_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/pineyardai/dZotgJ-4sE05K-4s/_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/pineyardai/dZotgJ-4sE05K-4s/_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/pineyardai/dZotgJ-4sE05K-4s/_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/pineyardai/dZotgJ-4sE05K-4s/_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/pineyardai/dZotgJ-4sE05K-4s/_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/pineyardai/dZotgJ-4sE05K-4s/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a knowledge base. - Pineyard API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pineyard API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pineyardai.mintlify.app/_mintlify/api/og/v2?division=Knowledge+bases\u0026amp;title=Create+a+knowledge+base.\u0026amp;theme=7a7f6019480fa899bb8771a8\u0026amp;signature=77b5577cd8bacfb231a6e9e0f828892418035937766f7c6b1065511f87d2c758\">\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=\"Create a knowledge base. - Pineyard API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pineyardai.mintlify.app/_mintlify/api/og/v2?division=Knowledge+bases\u0026amp;title=Create+a+knowledge+base.\u0026amp;theme=7a7f6019480fa899bb8771a8\u0026amp;signature=77b5577cd8bacfb231a6e9e0f828892418035937766f7c6b1065511f87d2c758\">\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/pineyardai/dZotgJ-4sE05K-4s/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pineyard API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/create-a-knowledge-base.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pineyard.ai/#organization\",\"name\":\"Pineyard API\",\"url\":\"https://docs.pineyard.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pineyardai/KvvhrFeJze_4l1B1/images/logo-light.png?fit=max\u0026auto=format\u0026n=KvvhrFeJze_4l1B1\u0026q=85\u0026s=d5177d07729810408e04e439d659151b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pineyard.ai#website\",\"name\":\"Pineyard API\",\"url\":\"https://docs.pineyard.ai\",\"publisher\":{\"@id\":\"https://docs.pineyard.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base#webpage\",\"url\":\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base\",\"name\":\"Create a knowledge base.\",\"dateModified\":\"2026-10-27T05:52:24.884Z\",\"isPartOf\":{\"@id\":\"https://docs.pineyard.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pineyard API\",\"item\":\"https://docs.pineyard.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a knowledge base.\",\"item\":\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base#apireference\",\"headline\":\"Create a knowledge base.\",\"name\":\"Create a knowledge base.\",\"url\":\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pineyard.ai/api-reference/create-a-knowledge-base#webpage\"},\"dateModified\":\"2026-10-27T05:52:24.884Z\",\"publisher\":{\"@id\":\"https://docs.pineyard.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pineyard.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pineyard API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Pineyard API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Public API (v1)","pages":[{"group":"Leads \u0026 results","pages":[{"title":"Push a lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaignId}/leads","href":"/api-reference/push-a-lead"},{"title":"Poll the immutable result for one accepted API lead.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/leads/{leadId}/result","href":"/api-reference/poll-the-immutable-result-for-one-accepted-api-lead"},{"title":"Recover an immutable result by event id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/results/{resultId}","href":"/api-reference/recover-an-immutable-result-by-event-id"},{"title":"List immutable results for webhook recovery.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/results","href":"/api-reference/list-immutable-results-for-webhook-recovery"},{"title":"Push up to 100 leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaignId}/leads/batch","href":"/api-reference/push-up-to-100-leads"}]},{"group":"Campaigns","pages":[{"title":"List all campaigns in your workspace.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns","href":"/api-reference/list-all-campaigns-in-your-workspace"},{"title":"Get details for a single campaign.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{id}","href":"/api-reference/get-details-for-a-single-campaign"},{"title":"Create a campaign (v1)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns","href":"/api-reference/create-a-campaign-v1"},{"title":"Update a campaign. Allowed on DRAFT and PAUSED campaigns.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/campaigns/{id}","href":"/api-reference/update-a-campaign-allowed-on-draft-and-paused-campaigns"},{"title":"Delete a campaign. Only DRAFT campaigns can be deleted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/campaigns/{id}","href":"/api-reference/delete-a-campaign-only-draft-campaigns-can-be-deleted"},{"title":"Start a DRAFT or PAUSED campaign.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{id}/start","href":"/api-reference/start-a-draft-or-paused-campaign"},{"title":"Pause a RUNNING campaign.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{id}/pause","href":"/api-reference/pause-a-running-campaign"},{"title":"Resume a PAUSED campaign.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{id}/resume","href":"/api-reference/resume-a-paused-campaign"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents","href":"/api-reference/list-agents"},{"title":"Create an agent (v1)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents","href":"/api-reference/create-an-agent-v1"},{"title":"Get an agent (v1)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{id}","href":"/api-reference/get-an-agent-v1"},{"title":"Update an agent (v1)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/agents/{id}","href":"/api-reference/update-an-agent-v1"},{"title":"Archive an agent (v1)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agents/{id}","href":"/api-reference/archive-an-agent-v1"},{"title":"List voices (v1)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voices","href":"/api-reference/list-voices-v1"},{"title":"Play a voice preview (v1)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/voices/{id}/preview","href":"/api-reference/play-a-voice-preview-v1"}]},{"group":"Phone numbers","pages":[{"title":"List phone numbers assigned to your workspace.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/phone-numbers","href":"/api-reference/list-phone-numbers-assigned-to-your-workspace"},{"title":"Attach phone numbers to a campaign so it can place calls.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{id}/phone-numbers","href":"/api-reference/attach-phone-numbers-to-a-campaign-so-it-can-place-calls"}]}]},{"group":"Agents","pages":[{"group":"Agents","pages":[{"title":"List agents in the current workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/list-agents-in-the-current-workspace"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents","href":"/api-reference/create-a-new-agent"},{"title":"Duplicate an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/duplicate","href":"/api-reference/duplicate-an-agent"},{"title":"Get an agent by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}","href":"/api-reference/get-an-agent-by-id"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}","href":"/api-reference/update-an-agent"},{"title":"Archive an agent (soft-delete) or hard-delete with ?permanent=true","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}","href":"/api-reference/archive-an-agent-soft-delete-or-hard-delete-with-?permanent=true"},{"title":"Initiate a sandbox call from this agent to a phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/test-call","href":"/api-reference/initiate-a-sandbox-call-from-this-agent-to-a-phone-number"},{"title":"Start a WebRTC sandbox session against this agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/web-session","href":"/api-reference/start-a-webrtc-sandbox-session-against-this-agent"}]},{"group":"Agent studio","pages":[{"title":"Assemble a draft agent from wizard inputs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/studio/generate","href":"/api-reference/assemble-a-draft-agent-from-wizard-inputs"},{"title":"Draft a conversation flow with AI","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/studio/draft","href":"/api-reference/draft-a-conversation-flow-with-ai"},{"title":"Draft a conversation flow with AI (streaming)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/studio/draft/stream","href":"/api-reference/draft-a-conversation-flow-with-ai-streaming"},{"title":"Render a conversation flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/studio/flow/render","href":"/api-reference/render-a-conversation-flow"},{"title":"Extract text from a brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/studio/parse-brief","href":"/api-reference/extract-text-from-a-brief"},{"title":"List the manual-mode prompt module library (metadata only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/studio/modules","href":"/api-reference/list-the-manual-mode-prompt-module-library-metadata-only"},{"title":"Render prompt modules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/studio/modules/render","href":"/api-reference/render-prompt-modules"},{"title":"Suggest structured post-call extraction fields from a free-text brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/extraction/suggest-fields","href":"/api-reference/suggest-structured-post-call-extraction-fields-from-a-free-text-brief"}]},{"group":"Background audio","pages":[{"title":"List available background audio assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /background-audio","href":"/api-reference/list-available-background-audio-assets"},{"title":"Initialize a background audio upload (returns presigned URL)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /background-audio/upload","href":"/api-reference/initialize-a-background-audio-upload-returns-presigned-url"},{"title":"Finalize background audio upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /background-audio/{id}/finalize","href":"/api-reference/finalize-background-audio-upload"},{"title":"Delete background audio asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /background-audio/{id}","href":"/api-reference/delete-background-audio-asset"}]},{"group":"Dictionaries","pages":[{"title":"List dictionaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dictionaries","href":"/api-reference/list-dictionaries"},{"title":"Create a dictionary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /dictionaries","href":"/api-reference/create-a-dictionary"},{"title":"Get a dictionary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dictionaries/{id}","href":"/api-reference/get-a-dictionary"},{"title":"Update a dictionary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /dictionaries/{id}","href":"/api-reference/update-a-dictionary"},{"title":"Delete a dictionary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /dictionaries/{id}","href":"/api-reference/delete-a-dictionary"},{"title":"List an agent's dictionaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/dictionaries","href":"/api-reference/list-an-agents-dictionaries"},{"title":"Set an agent's dictionaries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agents/{id}/dictionaries","href":"/api-reference/set-an-agents-dictionaries"}]},{"group":"Agent documents","pages":[{"title":"List documents in the current workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /documents","href":"/api-reference/list-documents-in-the-current-workspace"},{"title":"Add a web-link document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/web-link","href":"/api-reference/add-a-web-link-document"},{"title":"Reserve a document and return a presigned upload URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/upload-init","href":"/api-reference/reserve-a-document-and-return-a-presigned-upload-url"},{"title":"Finalize a file upload after the client has PUT to upload_url","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/{id}/confirm","href":"/api-reference/finalize-a-file-upload-after-the-client-has-put-to-upload_url"},{"title":"Update a document's name and/or description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /documents/{id}","href":"/api-reference/update-a-documents-name-andor-description"},{"title":"Get a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /documents/{id}","href":"/api-reference/get-a-document"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /documents/{id}","href":"/api-reference/delete-a-document"},{"title":"List an agent's documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/documents","href":"/api-reference/list-an-agents-documents"},{"title":"Link documents to an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/documents","href":"/api-reference/link-documents-to-an-agent"},{"title":"Unlink a document from an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{agentId}/documents/{documentId}","href":"/api-reference/unlink-a-document-from-an-agent"}]},{"group":"Custom functions","pages":[{"title":"List custom functions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /functions","href":"/api-reference/list-custom-functions"},{"title":"Delete a custom function","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /functions/{id}","href":"/api-reference/delete-a-custom-function"},{"title":"List an agent's functions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/functions","href":"/api-reference/list-an-agents-functions"},{"title":"Unlink a function from an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{agentId}/functions/{functionId}","href":"/api-reference/unlink-a-function-from-an-agent"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voices","href":"/api-reference/list-voices"},{"title":"Stream a short audio preview of a voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voices/{id}/preview","href":"/api-reference/stream-a-short-audio-preview-of-a-voice"}]}]},{"group":"Campaigns","pages":[{"group":"Campaign types","pages":[{"title":"List campaign types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaign-types","href":"/api-reference/list-campaign-types"},{"title":"Create a workspace-owned campaign type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaign-types","href":"/api-reference/create-a-workspace-owned-campaign-type"},{"title":"Get one of the caller workspace's own campaign types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaign-types/{id}","href":"/api-reference/get-one-of-the-caller-workspaces-own-campaign-types"},{"title":"Update one of the caller workspace's own campaign types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaign-types/{id}","href":"/api-reference/update-one-of-the-caller-workspaces-own-campaign-types"}]},{"group":"Contacts","pages":[{"title":"Upload a CSV for campaign creation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/uploads","href":"/api-reference/upload-a-csv-for-campaign-creation"},{"title":"Preview the calling list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/contacts","href":"/api-reference/preview-the-calling-list"},{"title":"Download the calling list (CSV)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/contacts.csv","href":"/api-reference/download-the-calling-list-csv"},{"title":"Clear a draft campaign's calling list (remove all imported contacts)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /campaigns/{id}/contacts","href":"/api-reference/clear-a-draft-campaigns-calling-list-remove-all-imported-contacts"},{"title":"Add contacts to a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/contacts","href":"/api-reference/add-contacts-to-a-campaign"},{"title":"Retry a failed campaign contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/contacts/{contactId}/retry","href":"/api-reference/retry-a-failed-campaign-contact"},{"title":"Manually set a lead's disposition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /campaigns/{id}/contacts/{contactId}/disposition","href":"/api-reference/manually-set-a-leads-disposition"},{"title":"Retry all failed contacts in a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/contacts/retry-all","href":"/api-reference/retry-all-failed-contacts-in-a-campaign"}]},{"group":"AI assist","pages":[{"title":"Draft a campaign from a brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/draft-from-brief","href":"/api-reference/draft-a-campaign-from-a-brief"},{"title":"Suggest extraction fields for a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/suggest-extraction-keys","href":"/api-reference/suggest-extraction-fields-for-a-campaign"},{"title":"Suggest extraction fields for a new campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/suggest-extraction-keys","href":"/api-reference/suggest-extraction-fields-for-a-new-campaign"},{"title":"Suggest evaluation metrics for a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/suggest-evaluation-metrics","href":"/api-reference/suggest-evaluation-metrics-for-a-campaign"},{"title":"Suggest evaluation metrics for a new campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/suggest-evaluation-metrics","href":"/api-reference/suggest-evaluation-metrics-for-a-new-campaign"},{"title":"Suggest an evaluation-metric prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/suggest-metric-prompt","href":"/api-reference/suggest-an-evaluation-metric-prompt"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns","href":"/api-reference/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns","href":"/api-reference/create-a-campaign"},{"title":"Duplicate a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/duplicate","href":"/api-reference/duplicate-a-campaign"},{"title":"Workspace campaign reservation usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/concurrency-usage","href":"/api-reference/workspace-campaign-reservation-usage"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/{id}","href":"/api-reference/update-a-campaign"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}","href":"/api-reference/get-a-campaign"},{"title":"Update outreach rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /campaigns/{id}/outreach","href":"/api-reference/update-outreach-rules"},{"title":"Update evaluation metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /campaigns/{id}/evaluation-metrics","href":"/api-reference/update-evaluation-metrics"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /campaigns/{id}","href":"/api-reference/delete-a-campaign"},{"title":"Replace a DRAFT campaign's custom extraction keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/{id}/custom-keys","href":"/api-reference/replace-a-draft-campaigns-custom-extraction-keys"}]},{"group":"Retry queue","pages":[{"title":"Retry backlog for the workspace, broken down by campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/retry-queue","href":"/api-reference/retry-backlog-for-the-workspace-broken-down-by-campaign"},{"title":"Terminally close every queued and parked retry in the workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/retry-queue/cancel","href":"/api-reference/terminally-close-every-queued-and-parked-retry-in-the-workspace"},{"title":"Hold every queued retry out of the dispatch queue until resumed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/retry-queue/park","href":"/api-reference/hold-every-queued-retry-out-of-the-dispatch-queue-until-resumed"},{"title":"Return every parked retry to the dispatch queue","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/retry-queue/resume","href":"/api-reference/return-every-parked-retry-to-the-dispatch-queue"}]},{"group":"Lifecycle","pages":[{"title":"Live-edit a campaign’s pacing/schedule (allowed while RUNNING)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /campaigns/{id}/schedule","href":"/api-reference/live-edit-a-campaign’s-pacingschedule-allowed-while-running"},{"title":"Start a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/start","href":"/api-reference/start-a-campaign"},{"title":"Pause a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/pause","href":"/api-reference/pause-a-campaign"},{"title":"Resume a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/resume","href":"/api-reference/resume-a-campaign"},{"title":"Stop a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/stop","href":"/api-reference/stop-a-campaign"},{"title":"Restart a stopped campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/restart","href":"/api-reference/restart-a-stopped-campaign"}]},{"group":"Re-run \u0026 re-engage","pages":[{"title":"Count leads eligible for re-engage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/reengage/eligible","href":"/api-reference/count-leads-eligible-for-re-engage"},{"title":"Re-engage cold leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/reengage","href":"/api-reference/re-engage-cold-leads"},{"title":"Count interrupted calls eligible for a re-call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/finish-interrupted/eligible","href":"/api-reference/count-interrupted-calls-eligible-for-a-re-call"},{"title":"Re-dial interrupted calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/finish-interrupted","href":"/api-reference/re-dial-interrupted-calls"},{"title":"Count calls eligible for re-evaluation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/re-evaluate/eligible","href":"/api-reference/count-calls-eligible-for-re-evaluation"},{"title":"Re-judge past calls against the current evaluation criteria","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/re-evaluate","href":"/api-reference/re-judge-past-calls-against-the-current-evaluation-criteria"},{"title":"Count leads eligible for re-messaging","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/remessage/eligible","href":"/api-reference/count-leads-eligible-for-re-messaging"},{"title":"Re-message past leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/remessage","href":"/api-reference/re-message-past-leads"},{"title":"Re-run extraction for every completed call in the campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/reextract","href":"/api-reference/re-run-extraction-for-every-completed-call-in-the-campaign"},{"title":"Run campaign analysis","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/analyze","href":"/api-reference/run-campaign-analysis"}]},{"group":"Results \u0026 insights","pages":[{"title":"Get campaign progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/stats","href":"/api-reference/get-campaign-progress"},{"title":"Get campaign call metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/metrics","href":"/api-reference/get-campaign-call-metrics"},{"title":"Get extracted-field summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/business-intelligence","href":"/api-reference/get-extracted-field-summary"},{"title":"Get campaign KPIs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/kpis","href":"/api-reference/get-campaign-kpis"},{"title":"Get extraction field status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/extraction-summary","href":"/api-reference/get-extraction-field-status"},{"title":"List campaign leads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/leads","href":"/api-reference/list-campaign-leads"},{"title":"List leads by evaluation segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/segmented-leads","href":"/api-reference/list-leads-by-evaluation-segment"},{"title":"Count leads per segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/lead-segments","href":"/api-reference/count-leads-per-segment"},{"title":"Campaign spend, qualified leads and cost per qualified lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/insights","href":"/api-reference/campaign-spend-qualified-leads-and-cost-per-qualified-lead"},{"title":"Get campaign headline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/headline","href":"/api-reference/get-campaign-headline"},{"title":"A journey campaign's graph, per-step counts and enrolment totals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/journey","href":"/api-reference/a-journey-campaigns-graph-per-step-counts-and-enrolment-totals"},{"title":"One lead's path through the journey, on the graph it actually ran","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/journey/leads/{campaignContactId}","href":"/api-reference/one-leads-path-through-the-journey-on-the-graph-it-actually-ran"},{"title":"Leads of a journey campaign, with where each one is in the journey","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/journey/leads","href":"/api-reference/leads-of-a-journey-campaign-with-where-each-one-is-in-the-journey"},{"title":"Recent calls and upcoming contacts for a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/activity","href":"/api-reference/recent-calls-and-upcoming-contacts-for-a-campaign"},{"title":"Customer-readable API lead delivery history (30-day retention)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/api-logs","href":"/api-reference/customer-readable-api-lead-delivery-history-30-day-retention"},{"title":"Count API requests received","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/api-logs/summary","href":"/api-reference/count-api-requests-received"},{"title":"Ask about a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/chat","href":"/api-reference/ask-about-a-campaign"},{"title":"Ask about a campaign (streaming)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/chat/stream","href":"/api-reference/ask-about-a-campaign-streaming"},{"title":"List campaign conversation messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/chat/messages","href":"/api-reference/list-campaign-conversation-messages"},{"title":"Clear campaign conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /campaigns/{id}/chat/messages","href":"/api-reference/clear-campaign-conversation"},{"title":"Get latest campaign analysis","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/analysis","href":"/api-reference/get-latest-campaign-analysis"}]},{"group":"Exports","pages":[{"title":"Export campaign results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/exports","href":"/api-reference/export-campaign-results"},{"title":"Count export rows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/exports/counts","href":"/api-reference/count-export-rows"},{"title":"Poll an async intel export job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/exports/{jobId}","href":"/api-reference/poll-an-async-intel-export-job"},{"title":"Download a finished async intel export artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/exports/{jobId}/download","href":"/api-reference/download-a-finished-async-intel-export-artifact"},{"title":"Export campaign calls + extracted intel as CSV (legacy alias)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/export.csv","href":"/api-reference/export-campaign-calls-+-extracted-intel-as-csv-legacy-alias"}]},{"group":"Phone numbers","pages":[{"title":"Attach phone numbers to a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/phone-numbers","href":"/api-reference/attach-phone-numbers-to-a-campaign"},{"title":"List numbers attached to a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/phone-numbers","href":"/api-reference/list-numbers-attached-to-a-campaign"},{"title":"Detach a number from a campaign (not allowed when campaign is RUNNING)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /campaigns/{id}/phone-numbers/{phoneNumberId}","href":"/api-reference/detach-a-number-from-a-campaign-not-allowed-when-campaign-is-running"}]}]},{"group":"Calls","pages":[{"group":"Calls","pages":[{"title":"List recent calls in the current workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls","href":"/api-reference/list-recent-calls-in-the-current-workspace"},{"title":"Activity grouped by lead entry — one row per journey, not one per call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/leads","href":"/api-reference/activity-grouped-by-lead-entry-—-one-row-per-journey-not-one-per-call"},{"title":"Count calls by type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/counts","href":"/api-reference/count-calls-by-type"},{"title":"List lead filter tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/lead-filters","href":"/api-reference/list-lead-filter-tags"},{"title":"Export the filtered calls as a CSV or Excel file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/export","href":"/api-reference/export-the-filtered-calls-as-a-csv-or-excel-file"},{"title":"Get a call by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}","href":"/api-reference/get-a-call-by-id"},{"title":"Re-run extraction on this call using its campaign’s effective key set","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls/{id}/extraction-replay","href":"/api-reference/re-run-extraction-on-this-call-using-its-campaign’s-effective-key-set"},{"title":"Re-score a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls/{id}/re-evaluate","href":"/api-reference/re-score-a-call"},{"title":"Translate this call transcript to English (cached after first run)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls/{id}/transcript-translation","href":"/api-reference/translate-this-call-transcript-to-english-cached-after-first-run"},{"title":"Flag this call as an issue for the Pineyard team to investigate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls/{id}/issues","href":"/api-reference/flag-this-call-as-an-issue-for-the-pineyard-team-to-investigate"},{"title":"Add this call's number to the account Do Not Call list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls/{id}/do-not-call","href":"/api-reference/add-this-calls-number-to-the-account-do-not-call-list"}]},{"group":"Test calls","pages":[{"title":"Initiate a single ad-hoc test call from a chosen phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls/test","href":"/api-reference/initiate-a-single-ad-hoc-test-call-from-a-chosen-phone-number"}]}]},{"group":"Phone numbers","pages":[{"title":"List phone numbers assigned to the caller workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers","href":"/api-reference/list-phone-numbers-assigned-to-the-caller-workspace"},{"title":"Assign or clear the inbound agent for a workspace phone number","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /phone-numbers/{id}/inbound-agent","href":"/api-reference/assign-or-clear-the-inbound-agent-for-a-workspace-phone-number"}]},{"group":"Knowledge bases","pages":[{"title":"Create a knowledge base.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge-bases","href":"/api-reference/create-a-knowledge-base"},{"title":"List the workspace’s knowledge bases.","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge-bases","href":"/api-reference/list-the-workspace’s-knowledge-bases"},{"title":"Knowledge base detail, including its documents.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge-bases/{id}","href":"/api-reference/knowledge-base-detail-including-its-documents"},{"title":"Upload a knowledge-base document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge-bases/{id}/documents","href":"/api-reference/upload-a-knowledge-base-document"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /knowledge-bases/{id}","href":"/api-reference/delete-a-knowledge-base"},{"title":"Remove a document. Remote copies are cleaned up in the background.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /knowledge-bases/{id}/documents/{docId}","href":"/api-reference/remove-a-document-remote-copies-are-cleaned-up-in-the-background"}]},{"group":"Workspace","pages":[{"group":"API keys","pages":[{"title":"List API keys (no secrets).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api-keys","href":"/api-reference/list-api-keys-no-secrets"},{"title":"Scopes a key can be given, with whether the caller may grant each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api-keys/scopes","href":"/api-reference/scopes-a-key-can-be-given-with-whether-the-caller-may-grant-each-one"}]},{"group":"Credits","pages":[{"title":"Get the caller workspace credit balance and recent transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /credits","href":"/api-reference/get-the-caller-workspace-credit-balance-and-recent-transactions"}]},{"group":"Result webhooks","pages":[{"title":"List result webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /result-webhooks/endpoints","href":"/api-reference/list-result-webhook-endpoints"},{"title":"Delete an endpoint and its delivery history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /result-webhooks/endpoints/{id}","href":"/api-reference/delete-an-endpoint-and-its-delivery-history"},{"title":"List delivery cycles.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /result-webhooks/deliveries","href":"/api-reference/list-delivery-cycles"},{"title":"Inspect the immutable payload and every recorded HTTP attempt.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /result-webhooks/deliveries/{id}","href":"/api-reference/inspect-the-immutable-payload-and-every-recorded-http-attempt"}]}]}]}]},"title":"Create a knowledge base. - Pineyard API","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}