Zum Hauptinhalt springen
GET
/
knowledge
/
{folderId}
/
list
Retrieve files from a knowledge folder
curl --request GET \
  --url https://api.langdock.com/knowledge/{folderId}/list \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.langdock.com/llms.txt

Use this file to discover all available pages before exploring further.

Du nutzt unsere API in einem Dedicated Deployment? Ersetze einfach api.langdock.com durch die Base URL deines Deployments: <deployment-url>/api/public
Listet alle Dateien (Attachments) in einem bestimmten Wissensordner auf. Verwende diesen Endpunkt, um zu sehen, welche Dateien verfügbar sind und ihren Verarbeitungsstatus zu prüfen.
Erfordert einen API-Schlüssel mit dem KNOWLEDGE_FOLDER_API Scope. Der Wissensordner muss mit dem API-Schlüssel geteilt sein. Siehe Wissensordner mit der API teilen für die Einrichtung.

​
Anforderungsformat

​
Pfadparameter

ParameterTypErforderlichBeschreibung
folderIdstringJaDie ID des Wissensordners

​
Beispiele

​
Dateien mit cURL auflisten

curl -X GET "https://api.langdock.com/knowledge/{folderId}/list" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Dateien mit JavaScript auflisten

const axios = require("axios");

async function listFiles(folderId) {
  const response = await axios.get(
    `https://api.langdock.com/knowledge/${folderId}/list`,
    {
      headers: {
        Authorization: "Bearer YOUR_API_KEY",
      },
    }
  );

  return response.data;
}

// Beispiel
const files = await listFiles("folder_abc123");
console.log(`${files.result.length} Dateien gefunden`);

files.result.forEach((file) => {
  console.log(`- ${file.name} (${file.syncStatus})`);
});

​
Verarbeitungsstatus prüfen

async function waitForProcessing(folderId, attachmentId, maxAttempts = 30) {
  for (let i = 0; i < maxAttempts; i++) {
    const files = await listFiles(folderId);
    const file = files.result.find((f) => f.id === attachmentId);

    if (!file) {
      throw new Error("Datei nicht gefunden");
    }

    if (file.syncStatus === "SYNCED") {
      console.log("Dateiverarbeitung abgeschlossen!");
      return file;
    }

    if (
      file.syncStatus === "ACTION_FAILED" ||
      file.syncStatus === "EXTRACTION_FAILED" ||
      file.syncStatus === "EMBEDDING_FAILED" ||
      file.syncStatus === "TIMEOUT"
    ) {
      throw new Error(`Verarbeitung fehlgeschlagen: ${file.syncStatus}`);
    }

    console.log(`Verarbeitung... (${file.syncStatus})`);
    await new Promise((resolve) => setTimeout(resolve, 2000));
  }

  throw new Error("Zeitlimit für Verarbeitung überschritten");
}

​
Antwortformat

​
Erfolgreiche Antwort (200 OK)

{
  status: "success";
  result: Array<{
    id: string;              // Eindeutige Attachment-ID
    name: string;            // Originaler Dateiname
    mimeType: string;        // MIME-Typ der Datei
    createdAt: string;       // ISO 8601 Zeitstempel
    updatedAt: string;       // ISO 8601 Zeitstempel
    url: string | null;      // Quell-URL, falls beim Upload angegeben
    path: string | null;     // Speicherpfad
    syncStatus: string;      // Verarbeitungsstatus (siehe unten)
    pageCount: number | null; // Seitenanzahl (bei PDFs)
    summary: string | null;  // Automatisch generierte Zusammenfassung
    externalId: string | null; // Externe Referenz-ID
    syncParams: object | null; // Synchronisierungskonfiguration aus der Quellintegration
  }>;
}

​
Verarbeitungsstatus-Werte

StatusBeschreibung
UPLOADINGDatei wird hochgeladen
UPLOADEDDatei hochgeladen und in der Warteschlange
EXTRACTINGText wird aus der Datei extrahiert
EMBEDDINGEmbeddings werden generiert
SYNCEDDatei ist bereit für die Suche
ACTION_FAILEDVerarbeitungsaktion fehlgeschlagen
EXTRACTION_FAILEDTextextraktion fehlgeschlagen
EMBEDDING_FAILEDEmbedding-Generierung fehlgeschlagen
TIMEOUTVerarbeitung hat das Zeitlimit überschritten

​
Beispielantwort

{
  "status": "success",
  "result": [
    {
      "id": "att_abc123def456",
      "name": "quartalsbericht.pdf",
      "mimeType": "application/pdf",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:35:00.000Z",
      "url": "https://example.com/reports/q4",
      "path": "/attachments/abc123/quartalsbericht.pdf",
      "syncStatus": "SYNCED",
      "pageCount": 15,
      "summary": "Dieser Quartalsbericht behandelt die Q4 2024 Finanzergebnisse...",
      "externalId": null,
      "syncParams": null
    },
    {
      "id": "att_new456abc",
      "name": "meeting-notizen.txt",
      "mimeType": "text/plain",
      "createdAt": "2025-01-16T14:00:00.000Z",
      "updatedAt": "2025-01-16T14:00:00.000Z",
      "url": null,
      "path": "/attachments/new456/meeting-notizen.txt",
      "syncStatus": "EXTRACTING",
      "pageCount": null,
      "summary": null,
      "externalId": null,
      "syncParams": null
    }
  ]
}

​
Einzelne Datei abrufen

Um Details für eine bestimmte Datei abzurufen, verwende den GET /knowledge/{folderId}/{attachmentId} Endpunkt: 
curl -X GET "https://api.langdock.com/knowledge/{folderId}/{attachmentId}" \
  -H "Authorization: Bearer YOUR_API_KEY"
Dieser gibt die gleichen Felder wie oben für ein einzelnes Attachment zurück, plus eine Fehlermeldung, falls die Verarbeitung fehlgeschlagen ist: 
{
  "status": "error",
  "message": "Dateiverarbeitung fehlgeschlagen. Bitte versuche es erneut oder kontaktiere den Support.",
  "result": {
    "id": "att_failed123",
    "name": "beschaedigte-datei.pdf",
    "syncStatus": "EXTRACTION_FAILED",
    "syncMessage": "Unable to extract text from PDF"
  }
}

​
Fehlerbehandlung

try {
  const response = await listFiles(folderId);
} catch (error) {
  if (error.response) {
    switch (error.response.status) {
      case 400:
        console.error("Ungültige Anfrage:", error.response.data.message);
        break;
      case 401:
        console.error("Ungültiger oder fehlender API-Schlüssel");
        break;
      case 403:
        console.error("API-Schlüssel hat keinen Zugriff auf diesen Wissensordner");
        break;
      case 404:
        console.error("Wissensordner nicht gefunden");
        break;
      case 429:
        console.error("Rate Limit überschritten");
        break;
      case 500:
        console.error("Server-Fehler");
        break;
    }
  }
}
Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu Best Practices für API-Schlüssel.

Autorisierungen

​
Authorization
string
header
erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Pfadparameter

​
folderId
string
erforderlich

The ID of the knowledge folder

Antwort

200

List of files retrieved successfully