{ "message": "Document created successfully. Processing will begin shortly.", "data": { "id": 2, "name": "Product Handbook", "description": "User manual for our product", "type": "pdf", "type_label": "PDF", "status": "processing", "status_label": "Processing", "created_at": "2025-01-08T10:35:00.000000Z" }}
{ "error": "Knowledgebase not found."}
{ "message": "A file is required for this document type.", "errors": { "file": [ "A file is required for this document type." ] }}
{ "error": "Failed to create document. Please try again."}
Famulor 1.0 API (legacy). This page applies only to Famulor 1.0 (app.famulor.de) and is retained for legacy compatibility. For the current platform, use the Famulor 2.0 API reference.
This endpoint creates a new document in a knowledge base. Documents are processed asynchronously - the endpoint returns immediately while processing continues in the background.
{ "message": "Document created successfully. Processing will begin shortly.", "data": { "id": 2, "name": "Product Handbook", "description": "User manual for our product", "type": "pdf", "type_label": "PDF", "status": "processing", "status_label": "Processing", "created_at": "2025-01-08T10:35:00.000000Z" }}
{ "error": "Knowledgebase not found."}
{ "message": "A file is required for this document type.", "errors": { "file": [ "A file is required for this document type." ] }}
{ "error": "Failed to create document. Please try again."}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Famulor","description":"Famulor documentation — build, deploy, and operate AI voice assistants.","colors":{"primary":"#1FD5FA","light":"#67E8FC","dark":"#0BA8C9"},"logo":{"light":"https://mintcdn.com/ouraicall/baoJp-MLrp4Nh8VX/logo/lockup-light.svg?fit=max\u0026auto=format\u0026n=baoJp-MLrp4Nh8VX\u0026q=85\u0026s=fd2b4cadd4821a549ba9fa5783ed619d","dark":"https://mintcdn.com/ouraicall/baoJp-MLrp4Nh8VX/logo/lockup-dark.svg?fit=max\u0026auto=format\u0026n=baoJp-MLrp4Nh8VX\u0026q=85\u0026s=8c5966ded7ffff8de6db3a09bd55f712"},"favicon":"https://mintcdn.com/ouraicall/2UgcT6Kzg4NlgPC2/favicon.svg?fit=max\u0026auto=format\u0026n=2UgcT6Kzg4NlgPC2\u0026q=85\u0026s=b7b1116d604f04ce5ebedef057e0580f","navbar":{"links":[{"href":"https://status.famulor.io","label":"Platform Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.famulor.io"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/Famulor"}},"seo":{"metatags":{"twitter:card":"summary_large_image"},"organization":{"name":"Famulor","logo":"https://docs.famulor.io/logo/lockup-light.svg"}},"integrations":{"clarity":{"projectId":"sop2kcwotx"},"ga4":{"measurementId":"G-WPTBT13HB0"}},"banner":{"content":"For AI agents: see the complete **[llms.txt](https://docs.famulor.io/llms.txt)** documentation index.","dismissible":true,"color":{"light":"#000000","dark":"#000000"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":""},{"language":"fr","href":"fr"},{"language":"es","href":"es"},{"language":"de","href":"de"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ouraicall","hasAudioNarration":false,"actualSubdomain":"ouraicall","customDomains":["docs.famulor.io"],"gitSource":{"type":"github","owner":"bekservice","repo":"famulor-multi-tenancy","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"837052af-37d0-49a0-b690-4af7a4b0dde2","liveDeploymentHistoryId":"6addaf84aa71df2f0249f4d9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6addaf84aa71df2f0249f4d9"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6addaf84aa71df2f0249f4d9","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":425},{"language":"en","tag":"Documentation","count":132},{"language":"de","tag":"Dokumentation","count":132},{"language":"es","tag":"Documentación","count":132},{"language":"fr","tag":"Documentation","count":132},{"language":"en","tag":"API 1.0 (Legacy)","count":102},{"language":"de","tag":"API 1.0 (Legacy)","count":102},{"language":"es","tag":"API 1.0 (Legacy)","count":102},{"language":"fr","tag":"API 1.0 (Legacy)","count":102},{"language":"default","tag":"Famulor Loop","count":37},{"language":"en","tag":"API Reference","count":35},{"language":"en","tag":"Assistants","count":35},{"language":"default","tag":"Messaging","count":35},{"language":"de","tag":"Assistenten","count":35},{"language":"es","tag":"Asistentes","count":35},{"language":"fr","tag":"Assistants","count":35},{"language":"en","tag":"Channels","count":32},{"language":"de","tag":"API-Referenz","count":32},{"language":"de","tag":"Kanäle","count":32},{"language":"es","tag":"Canales","count":32},{"language":"fr","tag":"Canaux","count":32},{"language":"default","tag":"Knowledge Bases","count":31},{"language":"default","tag":"Automations","count":28},{"language":"en","tag":"Automation","count":27},{"language":"default","tag":"Settings","count":27},{"language":"de","tag":"Automatisierung","count":27},{"language":"es","tag":"Automatización","count":27},{"language":"es","tag":"Referencia de la API","count":27},{"language":"fr","tag":"Automatisation","count":27},{"language":"fr","tag":"Référence API","count":27},{"language":"en","tag":"Telephony","count":25},{"language":"de","tag":"Telefonie","count":25},{"language":"es","tag":"Telefonía","count":25},{"language":"fr","tag":"Téléphonie","count":25},{"language":"en","tag":"AI Assistants","count":24},{"language":"de","tag":"KI-Assistants","count":24},{"language":"es","tag":"Asistentes de IA","count":24},{"language":"fr","tag":"Assistants IA","count":24},{"language":"default","tag":"Assistants","count":20},{"language":"default","tag":"White Label","count":20},{"language":"default","tag":"Tools","count":18},{"language":"en","tag":"Shopify","count":16},{"language":"default","tag":"Integrations","count":16},{"language":"de","tag":"Shopify","count":16},{"language":"es","tag":"Shopify","count":16},{"language":"fr","tag":"Shopify","count":16},{"language":"en","tag":"Getting started","count":11},{"language":"de","tag":"Erste Schritte","count":11},{"language":"es","tag":"Primeros pasos","count":11},{"language":"fr","tag":"Bien démarrer","count":11}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-v1/knowledgebases/create-document","slug":"/api-v1/knowledgebases/create-document","pageMetadata":{"title":"Create Document","api":"POST https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents","description":"Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.","href":"/api-v1/knowledgebases/create-document"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Expandable,Heading,Note,ParamField,ResponseField,Table,Warning}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Famulor 1.0 API (legacy).`}),` This page applies only to Famulor 1.0 (`,_jsx(_components.code,{children:`app.famulor.de`}),`) and is retained for legacy compatibility. For the current platform, use the `,_jsx(_components.a,{href:`/api-reference/introduction`,children:`Famulor 2.0 API reference`}),`.`]})}),`\n`,_jsx(_components.p,{children:`This endpoint creates a new document in a knowledge base. Documents are processed asynchronously - the endpoint returns immediately while processing continues in the background.`}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`knowledgebaseId`,type:`integer`,required:true,id:`param-knowledgebase-id`,children:_jsx(_components.p,{children:`The unique identifier of the knowledge base`})}),`\n`,_jsx(Heading,{level:`3`,id:`request-body`,children:`Request Body`}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsx(_components.p,{children:`The name of the document (max. 255 characters)`})}),`\n`,_jsx(ParamField,{body:`description`,type:`string`,id:`param-description`,children:_jsx(_components.p,{children:`Optional description of the document (max. 255 characters)`})}),`\n`,_jsx(ParamField,{body:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`Document type: `,_jsx(_components.code,{children:`website`}),`, `,_jsx(_components.code,{children:`pdf`}),`, `,_jsx(_components.code,{children:`txt`}),` or `,_jsx(_components.code,{children:`docx`})]})}),`\n`,_jsx(Heading,{level:`4`,id:`website-documents`,children:`Website Documents`}),`\n`,_jsx(ParamField,{body:`url`,type:`string`,id:`param-url`,children:_jsxs(_components.p,{children:[`The main URL to scrape. Required if `,_jsx(_components.code,{children:`links`}),` is not provided.`]})}),`\n`,_jsxs(ParamField,{body:`links`,type:`array`,id:`param-links`,children:[_jsxs(_components.p,{children:[`Array of specific URLs to scrape. Required if `,_jsx(_components.code,{children:`url`}),` is not provided.`]}),_jsx(Expandable,{title:`Links Properties`,children:_jsx(ParamField,{body:`link`,type:`string`,required:true,id:`param-link`,children:_jsx(_components.p,{children:`A valid URL to include in the document`})})})]}),`\n`,_jsx(ParamField,{body:`relative_links_limit`,type:`integer`,default:`10`,id:`param-relative-links-limit`,children:_jsx(_components.p,{children:`Maximum number of relative links to follow when scraping (1-50)`})}),`\n`,_jsx(Heading,{level:`4`,id:`file-documents-pdf-txt-docx`,children:`File Documents (PDF, TXT, DOCX)`}),`\n`,_jsx(ParamField,{body:`file`,type:`file`,required:true,id:`param-file`,children:_jsxs(_components.p,{children:[`The file to upload (max. 20MB). Use `,_jsx(_components.code,{children:`multipart/form-data`}),` encoding.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:`Success message`})}),`\n`,_jsxs(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:[_jsx(_components.p,{children:`The created document object`}),_jsxs(Expandable,{title:`Data Properties`,children:[_jsx(ResponseField,{name:`id`,type:`integer`,id:`param-id`,children:_jsx(_components.p,{children:`The unique identifier of the document`})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-1`,children:_jsx(_components.p,{children:`The name of the document`})}),_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description-1`,children:_jsx(_components.p,{children:`Description of the document`})}),_jsx(ResponseField,{name:`type`,type:`string`,id:`param-type-1`,children:_jsx(_components.p,{children:`Document type`})}),_jsx(ResponseField,{name:`type_label`,type:`string`,id:`param-type-label`,children:_jsx(_components.p,{children:`Human-readable type label`})}),_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`Processing status (will initially be `,_jsx(_components.code,{children:`processing`}),`)`]})}),_jsx(ResponseField,{name:`status_label`,type:`string`,id:`param-status-label`,children:_jsx(_components.p,{children:`Human-readable status label`})}),_jsx(ResponseField,{name:`created_at`,type:`string`,id:`param-created-at`,children:_jsx(_components.p,{children:`ISO 8601 timestamp of creation`})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`document-types`,children:`Document Types`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`}),_jsx(_components.th,{children:`Input`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`website`})}),_jsx(_components.td,{children:`Scrapes websites and extracts text content`}),_jsx(_components.td,{children:`URL or list of URLs`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pdf`})}),_jsx(_components.td,{children:`Extracts text from PDF files`}),_jsx(_components.td,{children:`PDF file upload`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`txt`})}),_jsx(_components.td,{children:`Plain text content`}),_jsx(_components.td,{children:`TXT file upload`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`docx`})}),_jsx(_components.td,{children:`Extracts text from Word documents`}),_jsx(_components.td,{children:`DOCX file upload`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Document processing is asynchronous. Call the `,_jsx(_components.a,{href:`/api-v1/knowledgebases/get-document`,children:`Get Document`}),` endpoint to check when processing is complete.`]})})]})}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 Document","api":"POST https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents","description":"Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.","href":"/api-v1/knowledgebases/create-document"}}},"mdxSourceWithNoJs":{"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`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,Note,ParamField,ResponseExample,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Famulor 1.0 API (legacy).`}),` This page applies only to Famulor 1.0 (`,_jsx(_components.code,{children:`app.famulor.de`}),`) and is retained for legacy compatibility. For the current platform, use the `,_jsx(_components.a,{href:`/api-reference/introduction`,children:`Famulor 2.0 API reference`}),`.`]})}),`\n`,_jsx(_components.p,{children:`This endpoint creates a new document in a knowledge base. Documents are processed asynchronously - the endpoint returns immediately while processing continues in the background.`}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`knowledgebaseId`,type:`integer`,required:true,id:`param-knowledgebase-id`,children:_jsx(_components.p,{children:`The unique identifier of the knowledge base`})}),`\n`,_jsx(Heading,{level:`3`,id:`request-body`,children:`Request Body`}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsx(_components.p,{children:`The name of the document (max. 255 characters)`})}),`\n`,_jsx(ParamField,{body:`description`,type:`string`,id:`param-description`,children:_jsx(_components.p,{children:`Optional description of the document (max. 255 characters)`})}),`\n`,_jsx(ParamField,{body:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`Document type: `,_jsx(_components.code,{children:`website`}),`, `,_jsx(_components.code,{children:`pdf`}),`, `,_jsx(_components.code,{children:`txt`}),` or `,_jsx(_components.code,{children:`docx`})]})}),`\n`,_jsx(Heading,{level:`4`,id:`website-documents`,children:`Website Documents`}),`\n`,_jsx(ParamField,{body:`url`,type:`string`,id:`param-url`,children:_jsxs(_components.p,{children:[`The main URL to scrape. Required if `,_jsx(_components.code,{children:`links`}),` is not provided.`]})}),`\n`,_jsxs(ParamField,{body:`links`,type:`array`,id:`param-links`,children:[_jsxs(_components.p,{children:[`Array of specific URLs to scrape. Required if `,_jsx(_components.code,{children:`url`}),` is not provided.`]}),_jsx(Expandable,{title:`Links Properties`,children:_jsx(ParamField,{body:`link`,type:`string`,required:true,id:`param-link`,children:_jsx(_components.p,{children:`A valid URL to include in the document`})})})]}),`\n`,_jsx(ParamField,{body:`relative_links_limit`,type:`integer`,default:`10`,id:`param-relative-links-limit`,children:_jsx(_components.p,{children:`Maximum number of relative links to follow when scraping (1-50)`})}),`\n`,_jsx(Heading,{level:`4`,id:`file-documents-pdf-txt-docx`,children:`File Documents (PDF, TXT, DOCX)`}),`\n`,_jsx(ParamField,{body:`file`,type:`file`,required:true,id:`param-file`,children:_jsxs(_components.p,{children:[`The file to upload (max. 20MB). Use `,_jsx(_components.code,{children:`multipart/form-data`}),` encoding.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsx(_components.p,{children:`Success message`})}),`\n`,_jsxs(ResponseField,{name:`data`,type:`object`,id:`param-data`,children:[_jsx(_components.p,{children:`The created document object`}),_jsxs(Expandable,{title:`Data Properties`,children:[_jsx(ResponseField,{name:`id`,type:`integer`,id:`param-id`,children:_jsx(_components.p,{children:`The unique identifier of the document`})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-1`,children:_jsx(_components.p,{children:`The name of the document`})}),_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description-1`,children:_jsx(_components.p,{children:`Description of the document`})}),_jsx(ResponseField,{name:`type`,type:`string`,id:`param-type-1`,children:_jsx(_components.p,{children:`Document type`})}),_jsx(ResponseField,{name:`type_label`,type:`string`,id:`param-type-label`,children:_jsx(_components.p,{children:`Human-readable type label`})}),_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`Processing status (will initially be `,_jsx(_components.code,{children:`processing`}),`)`]})}),_jsx(ResponseField,{name:`status_label`,type:`string`,id:`param-status-label`,children:_jsx(_components.p,{children:`Human-readable status label`})}),_jsx(ResponseField,{name:`created_at`,type:`string`,id:`param-created-at`,children:_jsx(_components.p,{children:`ISO 8601 timestamp of creation`})})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`document-types`,children:`Document Types`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`}),_jsx(_components.th,{children:`Input`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`website`})}),_jsx(_components.td,{children:`Scrapes websites and extracts text content`}),_jsx(_components.td,{children:`URL or list of URLs`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pdf`})}),_jsx(_components.td,{children:`Extracts text from PDF files`}),_jsx(_components.td,{children:`PDF file upload`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`txt`})}),_jsx(_components.td,{children:`Plain text content`}),_jsx(_components.td,{children:`TXT file upload`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`docx`})}),_jsx(_components.td,{children:`Extracts text from Word documents`}),_jsx(_components.td,{children:`DOCX file upload`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Document processing is asynchronous. Call the `,_jsx(_components.a,{href:`/api-v1/knowledgebases/get-document`,children:`Get Document`}),` endpoint to check when processing is complete.`]})}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`201 Website Document Created`,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Document created successfully. Processing will begin shortly.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Company Website\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Main website content\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"website\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type_label\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Website\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"processing\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status_label\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Processing\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-08T10:30:00.000000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`201 PDF Document Created`,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Document created successfully. Processing will begin shortly.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Product Handbook\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"User manual for our product\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pdf\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type_label\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"PDF\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"processing\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status_label\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Processing\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-08T10:35:00.000000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`404 Knowledgebase Not Found`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Knowledgebase not found.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`422 Validation Error`,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"A file is required for this document type.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errors\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"file\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"A file is required for this document type.\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`500 Processing Error`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Failed to create document. Please try again.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]})}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 Document","api":"POST https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents","description":"Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.","href":"/api-v1/knowledgebases/create-document"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Path Parameters","slug":"path-parameters","depth":3,"children":[]},{"title":"Request Body","slug":"request-body","depth":3,"children":[]},{"title":"Website Documents","slug":"website-documents","depth":4,"children":[]},{"title":"File Documents (PDF, TXT, DOCX)","slug":"file-documents-pdf-txt-docx","depth":4,"children":[]},{"title":"Response Fields","slug":"response-fields","depth":3,"children":[]},{"title":"Document Types","slug":"document-types","depth":3,"children":[]}],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"201 Website Document Created","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"13\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Document created successfully. Processing will begin shortly.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Company Website\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"description\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Main website content\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"website\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type_label\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Website\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"processing\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status_label\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Processing\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2025-01-08T10:30:00.000000Z\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"201 PDF Document Created","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"13\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Document created successfully. Processing will begin shortly.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Product Handbook\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"description\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"User manual for our product\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"pdf\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type_label\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"PDF\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"processing\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status_label\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Processing\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2025-01-08T10:35:00.000000Z\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"404 Knowledgebase Not Found","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Knowledgebase not found.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"422 Validation Error","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"8\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"A file is required for this document type.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"errors\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"file\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"A file is required for this document type.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"500 Processing Error","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Failed to create document. Please try again.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create Document","path":"/api/user/knowledgebases/{knowledgebaseId}/documents","servers":[{"url":"https://app.famulor.de"}],"method":"post","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{"knowledgebaseId":{"schema":[{"type":"integer","description":"The unique identifier of the knowledge base","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"name":[{"type":"string","description":"The name of the document (max. 255 characters)","required":true}],"description":[{"type":"string","description":"Optional description of the document (max. 255 characters)"}],"type":[{"type":"string","description":"Document type: `website` , `pdf` , `txt` or `docx`","required":true}],"url":[{"type":"string","description":"The main URL to scrape. Required if `links` is not provided."}],"links":[{"type":"array","items":[{"type":"object","properties":{"link":[{"type":"string","description":"A valid URL to include in the document","required":true}]}}],"description":"Array of specific URLs to scrape. Required if `url` is not provided."}],"relative_links_limit":[{"type":"integer","description":"Maximum number of relative links to follow when scraping (1-50)"}],"file":[{"type":"file","description":"The file to upload (max. 20MB). Use `multipart/form-data` encoding.","required":true}]}}],"examples":{"example":{"value":{"name":"\u003cstring>","description":"\u003cstring>","type":"\u003cstring>","url":"\u003cstring>","links":[{"link":"\u003cstring>"}],"relative_links_limit":123}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"message":[{"type":"string","description":"Success message"}],"data":[{"type":"object","properties":{"id":[{"type":"integer","description":"The unique identifier of the document"}],"name":[{"type":"string","description":"The name of the document"}],"description":[{"type":"string","description":"Description of the document"}],"type":[{"type":"string","description":"Document type"}],"type_label":[{"type":"string","description":"Human-readable type label"}],"status":[{"type":"string","description":"Processing status (will initially be `processing` )"}],"status_label":[{"type":"string","description":"Human-readable status label"}],"created_at":[{"type":"string","description":"ISO 8601 timestamp of creation"}]},"description":"The created document object"}]}}],"examples":{"example":{"value":{"message":"\u003cstring>","data":{"id":123,"name":"\u003cstring>","description":"\u003cstring>","type":"\u003cstring>","type_label":"\u003cstring>","status":"\u003cstring>","status_label":"\u003cstring>","created_at":"\u003cstring>"}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"ouraicall","siteName":"Famulor","title":"Create Document - Famulor","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-v1/knowledgebases/create-document","matchLevel":0},"fr":{"href":"/fr/api-v1/knowledgebases/create-document","matchLevel":1},"es":{"href":"/es/api-v1/knowledgebases/create-document","matchLevel":1},"de":{"href":"/de/api-v1/knowledgebases/create-document","matchLevel":1}}},"lastModified":"2026-08-26T22:30:42.898Z","originalFileLocation":"api-v1/knowledgebases/create-document.mdx","locale":"en"},"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=\"Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Famulor\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_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/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ouraicall/rrdiFjUhl62ZvRGI/_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/ouraicall/rrdiFjUhl62ZvRGI/_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/ouraicall/rrdiFjUhl62ZvRGI/_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/ouraicall/rrdiFjUhl62ZvRGI/_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/ouraicall/rrdiFjUhl62ZvRGI/_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/ouraicall/rrdiFjUhl62ZvRGI/_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/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Document - Famulor\">\u003cmeta data-mint-head property=\"og:description\" content=\"Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Famulor\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.famulor.io/api-v1/knowledgebases/create-document\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ouraicall.mintlify.app/_mintlify/api/og/v2?division=Knowledgebases\u0026amp;title=Create+Document\u0026amp;description=Upload+a+new+document+to+a+Famulor+knowledge+base+via+API.+Add+PDFs%2C+text%2C+FAQs+or+product+data+that+AI+voice+assistants+can+reference+during+calls.\u0026amp;theme=cc4516d305bac9e7bd8e915a\u0026amp;signature=373386c15fb15f4912e5e22dee8ec8f27c00ee64196af4ee9b72fc7778cb3fd8\">\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 Document - Famulor\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ouraicall.mintlify.app/_mintlify/api/og/v2?division=Knowledgebases\u0026amp;title=Create+Document\u0026amp;description=Upload+a+new+document+to+a+Famulor+knowledge+base+via+API.+Add+PDFs%2C+text%2C+FAQs+or+product+data+that+AI+voice+assistants+can+reference+during+calls.\u0026amp;theme=cc4516d305bac9e7bd8e915a\u0026amp;signature=373386c15fb15f4912e5e22dee8ec8f27c00ee64196af4ee9b72fc7778cb3fd8\">\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/ouraicall/rrdiFjUhl62ZvRGI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Famulor\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1FD5FA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.famulor.io/api-v1/knowledgebases/create-document\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-v1/knowledgebases/create-document.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.famulor.io/api-v1/knowledgebases/create-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.famulor.io/fr/api-v1/knowledgebases/create-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.famulor.io/es/api-v1/knowledgebases/create-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.famulor.io/de/api-v1/knowledgebases/create-document\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.famulor.io/api-v1/knowledgebases/create-document\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.famulor.io/#organization\",\"name\":\"Famulor\",\"url\":\"https://docs.famulor.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.famulor.io/logo/lockup-light.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.famulor.io#website\",\"name\":\"Famulor\",\"url\":\"https://docs.famulor.io\",\"publisher\":{\"@id\":\"https://docs.famulor.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.famulor.io/api-v1/knowledgebases/create-document#webpage\",\"url\":\"https://docs.famulor.io/api-v1/knowledgebases/create-document\",\"name\":\"Create Document\",\"description\":\"Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.\",\"dateModified\":\"2026-08-26T22:30:42.898Z\",\"isPartOf\":{\"@id\":\"https://docs.famulor.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.famulor.io/api-v1/knowledgebases/create-document#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.famulor.io/api-v1/knowledgebases/create-document#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Knowledgebases\",\"item\":\"https://docs.famulor.io/api-v1/knowledgebases/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Document\",\"item\":\"https://docs.famulor.io/api-v1/knowledgebases/create-document\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.famulor.io/api-v1/knowledgebases/create-document#apireference\",\"headline\":\"Create Document\",\"name\":\"Create Document\",\"description\":\"Upload a new document to a Famulor knowledge base via API. Add PDFs, text, FAQs or product data that AI voice assistants can reference during calls.\",\"url\":\"https://docs.famulor.io/api-v1/knowledgebases/create-document\",\"mainEntityOfPage\":{\"@id\":\"https://docs.famulor.io/api-v1/knowledgebases/create-document#webpage\"},\"dateModified\":\"2026-08-26T22:30:42.898Z\",\"publisher\":{\"@id\":\"https://docs.famulor.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.famulor.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Famulor\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Famulor","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Automation","pages":[{"title":"Automation","href":"/automations/overview"}]},{"tab":"White Label","pages":[{"title":"White Label","href":"/admin/tenants-and-whitelabel"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/overview"}]},{"tab":"API 1.0 (Legacy)","groups":[{"group":"API Reference","pages":[{"title":"Introduction","icon":"book-open","href":"/api-v1/introduction"},{"title":"Authentication","icon":"key","href":"/api-v1/authentication"},{"title":"Get User Information","api":"GET https://app.famulor.de/api/user/me","href":"/api-v1/user/me"}]},{"group":"AI Assistants","pages":[{"title":"Create Assistants","api":"POST https://app.famulor.de/api/user/assistant","href":"/api-v1/assistants/create"},{"title":"Delete Assistant","api":"DELETE https://app.famulor.de/api/user/assistant/{id}","href":"/api-v1/assistants/delete"},{"title":"Enable assistant inbound webhook","api":"POST /user/assistants/enable-inbound-webhook","href":"/api-v1/assistants/enable-inbound-webhook"},{"title":"Disable assistant inbound webhook","api":"POST /user/assistants/disable-inbound-webhook","href":"/api-v1/assistants/disable-inbound-webhook"},{"title":"Enable Conversation Ended Webhook","api":"POST https://app.famulor.de/api/user/assistants/enable-conversation-ended-webhook","href":"/api-v1/assistants/enable-conversation-ended-webhook"},{"title":"Disable conversation ended webhook","api":"POST https://app.famulor.de/api/user/assistants/disable-conversation-ended-webhook","href":"/api-v1/assistants/disable-conversation-ended-webhook"},{"title":"Disable assistant webhook","api":"POST /user/assistants/disable-webhook","href":"/api-v1/assistants/disable-webhook"},{"title":"Retrieve Available Languages","api":"GET https://app.famulor.de/api/user/assistants/languages","href":"/api-v1/assistants/languages"},{"title":"List Assistants","api":"GET https://app.famulor.de/api/user/assistants/get","href":"/api-v1/assistants/list"},{"title":"Assistant pictures","openapi":"GET /assistants/avatar-gallery","href":"/api-v1/assistants/avatar-gallery"},{"title":"Custom AI avatars — capability","openapi":"GET /avatars/capability","href":"/api-v1/avatars/capability"},{"title":"Custom AI avatars — uploads","openapi":"POST /avatars/uploads","href":"/api-v1/avatars/uploads"},{"title":"Custom AI avatars — submit","openapi":"POST /avatars","href":"/api-v1/avatars/submit"},{"title":"Custom AI avatars — list","openapi":"GET /avatars","href":"/api-v1/avatars/list"},{"title":"Custom AI avatars — get","openapi":"GET /avatars/{id}","href":"/api-v1/avatars/get"},{"title":"Custom AI avatars — delete","openapi":"DELETE /avatars/{id}","href":"/api-v1/avatars/delete"},{"title":"Custom AI avatars — catalog","openapi":"GET /avatars/catalog","href":"/api-v1/avatars/catalog"},{"title":"Retrieve Available Models","api":"GET https://app.famulor.de/api/user/assistants/models","href":"/api-v1/assistants/models"},{"title":"Get outbound assistants","api":"GET https://app.famulor.de/api/user/assistants/outbound","href":"/api-v1/assistants/outbound"},{"title":"Retrieve Available Phone Numbers","api":"GET https://app.famulor.de/api/user/assistants/phone-numbers","href":"/api-v1/assistants/phone-numbers"},{"title":"List synthesizer providers","api":"GET https://app.famulor.de/api/user/assistants/synthesizer-providers","href":"/api-v1/assistants/synthesizer-providers"},{"title":"List transcriber providers","api":"GET https://app.famulor.de/api/user/assistants/transcriber-providers","href":"/api-v1/assistants/transcriber-providers"},{"title":"Update Assistant","api":"PUT https://app.famulor.de/api/user/assistant/{id}","href":"/api-v1/assistants/update"},{"title":"Retrieve Available Voices","api":"GET https://app.famulor.de/api/user/assistants/voices","href":"/api-v1/assistants/voices"}]},{"group":"Folders","pages":[{"title":"List Folders","api":"GET https://app.famulor.de/api/user/folders","href":"/api-v1/folders/list"},{"title":"Create Folder","api":"POST https://app.famulor.de/api/user/folder","href":"/api-v1/folders/create"},{"title":"Update Folder","api":"PUT https://app.famulor.de/api/user/folder/{id}","href":"/api-v1/folders/update"},{"title":"Delete Folder","api":"DELETE https://app.famulor.de/api/user/folder/{id}","href":"/api-v1/folders/delete"}]},{"group":"Labels","pages":[{"title":"List Labels","api":"GET https://app.famulor.de/api/user/labels","href":"/api-v1/labels/list"},{"title":"Create Label","api":"POST https://app.famulor.de/api/user/label","href":"/api-v1/labels/create"},{"title":"Update Label","api":"PUT https://app.famulor.de/api/user/label/{id}","href":"/api-v1/labels/update"},{"title":"Delete Label","api":"DELETE https://app.famulor.de/api/user/label/{id}","href":"/api-v1/labels/delete"}]},{"group":"Leads","pages":[{"title":"List Leads","api":"GET https://app.famulor.de/api/user/leads","href":"/api-v1/leads/list"},{"title":"Create lead","api":"POST /user/lead","href":"/api-v1/leads/create"},{"title":"Update Lead","api":"PUT https://app.famulor.de/api/user/leads/{id}","href":"/api-v1/leads/update"},{"title":"Delete lead","api":"DELETE /user/leads/{id}","href":"/api-v1/leads/delete"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","api":"GET https://app.famulor.de/api/user/campaigns","href":"/api-v1/campaigns/list"},{"title":"Get campaign","api":"GET https://app.famulor.de/api/user/campaign/{id}","href":"/api-v1/campaigns/get"},{"title":"Create campaign","api":"POST https://app.famulor.de/api/user/campaign","href":"/api-v1/campaigns/create"},{"title":"External phone audiences (Beta)","openapi":"GET /campaigns/external-audience/connections","href":"/api-v1/campaigns/audience-connections"},{"title":"External phone audiences (Beta)","openapi":"GET /campaigns/external-audience/segments","href":"/api-v1/campaigns/audience-segments"},{"title":"External phone audiences (Beta)","openapi":"GET /campaigns/external-audience/products","href":"/api-v1/campaigns/audience-products"},{"title":"Update campaign status","api":"POST https://app.famulor.de/api/user/campaigns/update-status","href":"/api-v1/campaigns/update-status"},{"title":"Delete campaign","api":"DELETE /user/campaign/{id}","href":"/api-v1/campaigns/delete"}]},{"group":"Automations","pages":[{"title":"List automations","api":"GET https://app.famulor.de/api/user/automate/flows","href":"/api-v1/automations/list"},{"title":"Get automation","api":"GET https://app.famulor.de/api/user/automate/flows/{id}","href":"/api-v1/automations/get"},{"title":"Create automation","api":"POST https://app.famulor.de/api/user/automate/flows","href":"/api-v1/automations/create"},{"title":"Update automation","api":"PUT https://app.famulor.de/api/user/automate/flows/{id}","href":"/api-v1/automations/update"},{"title":"Restore previous version","api":"POST https://app.famulor.de/api/user/automate/flows/{id}/restore","href":"/api-v1/automations/restore"},{"title":"Delete automation","api":"DELETE https://app.famulor.de/api/user/automate/flows/{id}","href":"/api-v1/automations/delete"},{"title":"List automation runs","api":"GET https://app.famulor.de/api/user/automate/flows/{id}/runs","href":"/api-v1/automations/list-runs"},{"title":"Retry automation run","api":"POST https://app.famulor.de/api/user/automate/flows/{id}/runs/{run_id}/retry","href":"/api-v1/automations/retry-run"},{"title":"List automation templates","api":"GET https://app.famulor.de/api/user/automate/templates","href":"/api-v1/automations/list-templates"},{"title":"Apply automation template","api":"POST https://app.famulor.de/api/user/automate/templates/{key}","href":"/api-v1/automations/apply-template"}]},{"group":"Mid Call Actions","pages":[{"title":"List Mid-call Actions","api":"GET https://app.famulor.de/api/user/tools","href":"/api-v1/mid-call-tools/get-tools"},{"title":"Get Mid-call Action","api":"GET https://app.famulor.de/api/user/tools/{id}","href":"/api-v1/mid-call-tools/get-tool"},{"title":"Create Mid-call Action","api":"POST https://app.famulor.de/api/user/tools","href":"/api-v1/mid-call-tools/create-tool"},{"title":"Update Mid-call Action","api":"PUT https://app.famulor.de/api/user/tools/{id}","href":"/api-v1/mid-call-tools/update-tool"},{"title":"Delete Mid-call Action","api":"DELETE https://app.famulor.de/api/user/tools/{id}","href":"/api-v1/mid-call-tools/delete-tool"}]},{"group":"AI Chatbot","pages":[{"title":"List Conversations","api":"GET https://app.famulor.de/api/user/conversations","href":"/api-v1/conversations/list"},{"title":"Disable AI","api":"POST https://app.famulor.de/api/automate/conversations/{uuid}/disable-ai","href":"/api-v1/conversations/disable-ai"},{"title":"Enable AI","api":"POST https://app.famulor.de/api/automate/conversations/{uuid}/enable-ai","href":"/api-v1/conversations/enable-ai"},{"title":"Create conversation","api":"POST /conversations","href":"/api-v1/ai-chatbot/create-conversation"},{"title":"Get conversation","api":"GET /conversations/{uuid}","href":"/api-v1/ai-chatbot/get-conversation"},{"title":"Send message","api":"POST /conversations/{uuid}/messages","href":"/api-v1/ai-chatbot/send-conversation"}]},{"group":"AI Replies","pages":[{"title":"Generate AI Reply","api":"POST https://app.famulor.de/api/user/ai/generate-reply","href":"/api-v1/ai-replies/generate-reply"}]},{"group":"Knowledgebases","pages":[{"title":"List Knowledge Bases","api":"GET https://app.famulor.de/api/user/knowledgebases","href":"/api-v1/knowledgebases/list"},{"title":"Get Knowledge Base","api":"GET https://app.famulor.de/api/user/knowledgebases/{id}","href":"/api-v1/knowledgebases/get"},{"title":"Create Knowledge Base","api":"POST https://app.famulor.de/api/user/knowledgebases","href":"/api-v1/knowledgebases/create"},{"title":"Update Knowledge Base","api":"PUT https://app.famulor.de/api/user/knowledgebases/{id}","href":"/api-v1/knowledgebases/update"},{"title":"Delete Knowledge Base","api":"DELETE https://app.famulor.de/api/user/knowledgebases/{id}","href":"/api-v1/knowledgebases/delete"},{"title":"List Documents","api":"GET https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents","href":"/api-v1/knowledgebases/list-documents"},{"title":"Get Document","api":"GET https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents/{documentId}","description":"Retrieve details of a specific document inside a Famulor knowledge base by ID via API. Get content, metadata and processing status for AI voice agents.","href":"/api-v1/knowledgebases/get-document"},{"title":"Create Document","api":"POST https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents","href":"/api-v1/knowledgebases/create-document"},{"title":"Update Document","api":"PUT https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents/{documentId}","description":"Update the name or description of a document in a Famulor knowledge base via API. Keep your AI voice agent's source materials organized and labelled.","href":"/api-v1/knowledgebases/update-document"},{"title":"Delete Document","api":"DELETE https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents/{documentId}","href":"/api-v1/knowledgebases/delete-document"}]},{"group":"SMS","pages":[{"title":"Send SMS","api":"POST https://app.famulor.de/api/user/sms","href":"/api-v1/sms/send"}]},{"group":"WhatsApp","pages":[{"title":"Get WhatsApp Senders","api":"GET /user/whatsapp/senders","href":"/api-v1/whatsapp/get-senders"},{"title":"Get WhatsApp Templates","api":"GET /user/whatsapp/senders/{senderId}/templates","href":"/api-v1/whatsapp/get-templates"},{"title":"Send WhatsApp Template Message","api":"POST /user/whatsapp/send","href":"/api-v1/whatsapp/send-template"},{"title":"Send WhatsApp Freeform Message","api":"POST /user/whatsapp/send-freeform","href":"/api-v1/whatsapp/send-freeform"},{"title":"Get WhatsApp Session Status","api":"GET /user/whatsapp/session-status","href":"/api-v1/whatsapp/session-status"}]},{"group":"Phone Numbers","pages":[{"title":"List Phone Numbers","api":"GET https://app.famulor.de/api/user/phone-numbers/all","href":"/api-v1/phone-numbers/list"},{"title":"Update Phone Number","api":"PUT https://app.famulor.de/api/user/phone-numbers/{id}","href":"/api-v1/phone-numbers/update"},{"title":"Search Available Phone Numbers","api":"GET https://app.famulor.de/api/user/phone-numbers/search","href":"/api-v1/phone-numbers/search"},{"title":"Purchase Phone Number","api":"POST https://app.famulor.de/api/user/phone-numbers/purchase","href":"/api-v1/phone-numbers/purchase"},{"title":"Release Phone Number","api":"DELETE https://app.famulor.de/api/user/phone-numbers/{id}","href":"/api-v1/phone-numbers/release"}]},{"group":"SIP Trunks","pages":[{"title":"List SIP Trunks","api":"GET https://app.famulor.de/api/user/phone-numbers/sip-trunks","href":"/api-v1/sip-trunks/list"},{"title":"Get SIP Trunk","api":"GET https://app.famulor.de/api/user/phone-numbers/sip-trunks/{id}","href":"/api-v1/sip-trunks/get"},{"title":"Create SIP Trunk","api":"POST https://app.famulor.de/api/user/phone-numbers/sip-trunks","href":"/api-v1/sip-trunks/create"},{"title":"Update SIP Trunk","api":"PUT https://app.famulor.de/api/user/phone-numbers/sip-trunks/{id}","href":"/api-v1/sip-trunks/update"},{"title":"Delete SIP Trunk","api":"DELETE https://app.famulor.de/api/user/phone-numbers/{id}","href":"/api-v1/sip-trunks/delete"}]},{"group":"Calls","pages":[{"title":"List Calls","api":"GET https://app.famulor.de/api/user/calls","href":"/api-v1/calls/list"},{"title":"Get Call","api":"GET https://app.famulor.de/api/user/calls/{id}","href":"/api-v1/user/calls/get"},{"title":"Make a Call","api":"POST https://app.famulor.de/api/user/make_call","href":"/api-v1/calls/make"},{"title":"Delete Call","api":"DELETE https://app.famulor.de/api/user/calls/{call}","href":"/api-v1/calls/delete"}]},{"group":"Webhooks","pages":[{"title":"Post-Call Webhook","icon":"link","href":"/api-v1/webhooks/post-call"},{"title":"Conversation Ended Webhook","icon":"link","href":"/api-v1/webhooks/conversation-ended"},{"title":"Read Receipts Webhook","icon":"link","href":"/api-v1/webhooks/read-receipts"}]}]},{"tab":"What's New","pages":[{"title":"What's New","href":"/changelog"}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-v1/knowledgebases/create-document"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-v1/knowledgebases/create-document"}]},{"language":"de","pages":[{"title":"de","href":"/de/api-v1/knowledgebases/create-document"}]}]},"title":"Create Document - Famulor","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["BannerMarkdown-Og7hgu7u.js","dist-BaREnp3o.js","lib--scc4DXi.js","lib-B8HbPgcC.js","clsx-CefdjKz2.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js"]}