Update document folder
Updates a document folder's name and/or description.
PUT
https://api.deutschlandgpt.de/v2/document-folders/{id}Example request
curl https://api.deutschlandgpt.de/v2/document-folders/{id} \
-X PUT \
-H "Authorization: Bearer $DGPT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"description": "string"
}'curl https://api.deutschlandgpt.de/v2/document-folders/{id} \
-X PUT \
-H "Authorization: Bearer $DGPT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"description": "string"
}'import os, requests
response = requests.put(
"https://api.deutschlandgpt.de/v2/document-folders/{id}",
headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
json={
"name": "string",
"description": "string"
},
)
print(response.json())import os, requests
response = requests.put(
"https://api.deutschlandgpt.de/v2/document-folders/{id}",
headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
json={
"name": "string",
"description": "string"
},
)
print(response.json())const response = await fetch('https://api.deutschlandgpt.de/v2/document-folders/{id}', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"description": "string"
}),
});
console.log(await response.json());const response = await fetch('https://api.deutschlandgpt.de/v2/document-folders/{id}', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"description": "string"
}),
});
console.log(await response.json());Parameters
idstring<uuid>requiredDocument folder ID
Request body
namestringoptionaldescriptionstringoptionalResponse
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"
}
]
}Updated folder
idstring<uuid>namestringdescriptionstringvisibilitystringcreatedAtstring<date-time>filesobject[]idstringnamestringtypestringcreatedAtstring<date-time>Response codes
200
Updated folder
DocumentFolderDetail401
Unauthorized
402
Insufficient credits or spending limit exceeded
Error403
Requires enterprise workspace
404
Folder not found or access denied
Was this page helpful?