Dokumentenordner auflisten · DeutschlandGPT

Gibt alle aktiven Dokumentenordner für den Enterprise-Workspace zurück. Unterstützt optionale Textsuche. limit und offset gelten nur, wenn eine query angegeben wird; ohne query werden alle Ordner zurückgegeben. Die Ergebnisse werden durch die Ordnerberechtigungen des API-Keys gefiltert, wenn der Key benutzergebunden ist und Ordnerbeschränkungen aktiviert hat.

GEThttps://api.deutschlandgpt.de/v2/document-folders

Beispielaufruf

curl https://api.deutschlandgpt.de/v2/document-folders \
  -X GET \
  -H "Authorization: Bearer $DGPT_API_KEY"

curl https://api.deutschlandgpt.de/v2/document-folders \
  -X GET \
  -H "Authorization: Bearer $DGPT_API_KEY"

import os, requests

response = requests.get(
    "https://api.deutschlandgpt.de/v2/document-folders",
    headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
)

print(response.json())

import os, requests

response = requests.get(
    "https://api.deutschlandgpt.de/v2/document-folders",
    headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
)

print(response.json())

const response = await fetch('https://api.deutschlandgpt.de/v2/document-folders', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
  },
});

console.log(await response.json());

const response = await fetch('https://api.deutschlandgpt.de/v2/document-folders', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
  },
});

console.log(await response.json());

Parameter

querystringoptional

Optionale Textsuchanfrage zum Filtern von Ordnern nach Name

limitintegeroptional

Maximale Anzahl der zurückzugebenden Ergebnisse

offsetintegeroptional

Anzahl der zu überspringenden Ergebnisse

Antwort

200application/json

{
  "object": "list",
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "description": "string",
      "visibility": "string",
      "createdAt": "2025-01-01T00:00:00Z",
      "fileCount": 0
    }
  ]
}

{
  "object": "list",
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "description": "string",
      "visibility": "string",
      "createdAt": "2025-01-01T00:00:00Z",
      "fileCount": 0
    }
  ]
}

Liste der Dokumentenordner

objectstring

dataDocumentFolder[]

idstring<uuid>

namestring

descriptionstring

visibilitystring

createdAtstring<date-time>

fileCountinteger

Statuscodes

200

Liste der Dokumentenordner

object

401

Nicht autorisiert

402

Nicht genügend Guthaben oder Ausgabelimit überschritten

Error

403

Erfordert Enterprise-Workspace