Skip to main content
POST
https://app.famulor.de
/
api
/
user
/
knowledgebases
/
{knowledgebaseId}
/
documents
Dokument erstellen
curl --request POST \
  --url https://app.famulor.de/api/user/knowledgebases/{knowledgebaseId}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "<string>",
  "url": "<string>",
  "links": [
    {
      "link": "<string>"
    }
  ],
  "relative_links_limit": 123
}
'
{
  "message": "Document created successfully. Processing will begin shortly.",
  "data": {
    "id": 1,
    "name": "Unternehmenswebsite",
    "description": "Hauptinhalte der Website",
    "type": "website",
    "type_label": "Website",
    "status": "processing",
    "status_label": "Wird verarbeitet",
    "created_at": "2025-01-08T10:30:00.000000Z"
  }
}
Dieser Endpunkt erstellt ein neues Dokument in einer Wissensdatenbank. Dokumente werden asynchron verarbeitet - der Endpunkt gibt sofort zurück, während die Verarbeitung im Hintergrund fortgesetzt wird.

​
Pfad-Parameter

​
knowledgebaseId
integer
required
Die eindeutige Kennung der Wissensdatenbank

​
Request Body

​
name
string
required
Der Name des Dokuments (max. 255 Zeichen)
​
description
string
Optionale Beschreibung des Dokuments (max. 255 Zeichen)
​
type
string
required
Dokumenttyp: website, pdf, txt oder docx

​
Website-Dokumente

​
url
string
Die Haupt-URL zum Scrapen. Erforderlich, wenn links nicht bereitgestellt wird.
​
links
array
Array von spezifischen URLs zum Scrapen. Erforderlich, wenn url nicht bereitgestellt wird.
​
relative_links_limit
integer
default:"10"
Maximale Anzahl von relativen Links, denen beim Scrapen gefolgt werden soll (1-50)

​
Datei-Dokumente (PDF, TXT, DOCX)

​
file
file
required
Die hochzuladende Datei (max. 20MB). Verwenden Sie multipart/form-data Kodierung.

​
Antwort-Felder

​
message
string
Erfolgsmeldung
​
data
object
Das erstellte Dokument-Objekt

​
Dokumenttypen

TypBeschreibungEingabe
websiteScraped Webseiten und extrahiert TextinhalteURL oder Liste von URLs
pdfExtrahiert Text aus PDF-DateienPDF-Datei-Upload
txtKlartext-InhaltTXT-Datei-Upload
docxExtrahiert Text aus Word-DokumentenDOCX-Datei-Upload
Die Dokumentverarbeitung erfolgt asynchron. Rufen Sie den Dokument abrufen Endpunkt ab, um zu prüfen, wann die Verarbeitung abgeschlossen ist.
curl -X POST "https://app.famulor.de/api/user/knowledgebases/1/documents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Unternehmenswebsite",
    "description": "Hauptinhalte der Website",
    "type": "website",
    "url": "https://example.com",
    "relative_links_limit": 20
  }'

{
  "message": "Document created successfully. Processing will begin shortly.",
  "data": {
    "id": 1,
    "name": "Unternehmenswebsite",
    "description": "Hauptinhalte der Website",
    "type": "website",
    "type_label": "Website",
    "status": "processing",
    "status_label": "Wird verarbeitet",
    "created_at": "2025-01-08T10:30:00.000000Z"
  }
}