Get document folder · DeutschlandGPT

Returns a document folder with its files. Subject to API key folder permissions.

GEThttps://api.deutschlandgpt.de/v2/document-folders/{id}

Example request

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

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

import os, requests

response = requests.get(
    "https://api.deutschlandgpt.de/v2/document-folders/{id}",
    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/{id}",
    headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
)

print(response.json())

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

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

Parameters

idstring<uuid>required

Document folder ID

Response

200application/json

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "description": "string",
  "visibility": "string",
  "createdAt": "2025-01-01T00:00:00Z",
  "files": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "createdAt": "2025-01-01T00:00:00Z"
    }
  ]
}

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "description": "string",
  "visibility": "string",
  "createdAt": "2025-01-01T00:00:00Z",
  "files": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "createdAt": "2025-01-01T00:00:00Z"
    }
  ]
}

Document folder with files

idstring<uuid>

namestring

descriptionstring

visibilitystring

createdAtstring<date-time>

filesobject[]

idstring

namestring

typestring

createdAtstring<date-time>

Response codes

200

Document folder with files

DocumentFolderDetail

401

Unauthorized

402

Insufficient credits or spending limit exceeded

Error

403

Requires enterprise workspace

404

Folder not found or access denied