JavaScript
import Morphik from 'morphik';
const client = new Morphik({
apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
});
const folderDetailsResponse = await client.folders.details();
console.log(folderDetailsResponse.folders);curl https://api.morphik.ai/folders/details \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $MORPHIK_API_KEY" \
-d '{}'{
"folders": [
{
"folder": {
"name": "<string>",
"id": "<string>",
"full_path": "<string>",
"parent_id": "<string>",
"depth": 123,
"description": "<string>",
"document_ids": [
"<string>"
],
"system_metadata": {},
"summary_storage_key": "<string>",
"summary_version": 123,
"summary_bucket": "<string>",
"summary_updated_at": "<string>",
"app_id": "<string>",
"end_user_id": "<string>",
"child_count": 123
},
"document_info": {
"documents": [
"<unknown>"
],
"document_count": 123,
"status_counts": {},
"skip": 0,
"limit": 0,
"returned_count": 0,
"has_more": false,
"next_skip": 123
}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Folders
Folder Details
Retrieve folder metadata with optional document statistics and projections.
POST
/
folders
/
details
JavaScript
import Morphik from 'morphik';
const client = new Morphik({
apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
});
const folderDetailsResponse = await client.folders.details();
console.log(folderDetailsResponse.folders);curl https://api.morphik.ai/folders/details \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $MORPHIK_API_KEY" \
-d '{}'{
"folders": [
{
"folder": {
"name": "<string>",
"id": "<string>",
"full_path": "<string>",
"parent_id": "<string>",
"depth": 123,
"description": "<string>",
"document_ids": [
"<string>"
],
"system_metadata": {},
"summary_storage_key": "<string>",
"summary_version": 123,
"summary_bucket": "<string>",
"summary_updated_at": "<string>",
"app_id": "<string>",
"end_user_id": "<string>",
"child_count": 123
},
"document_info": {
"documents": [
"<unknown>"
],
"document_count": 123,
"status_counts": {},
"skip": 0,
"limit": 0,
"returned_count": 0,
"has_more": false,
"next_skip": 123
}
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
application/json
Request model for retrieving folder details with document statistics.
Was this page helpful?

