Skip to content
Documentation/OPEN API

Asset search

Search assets and shared links with detailed filters and pagination.

Last updated

Search assets

Endpoint: /search-assets

Method: POST

Description: Search assets in an enterprise workspace.

Request parameters:

ParameterTypeRequiredDescription
-EnterpriseSearchReqVOYesAsset search parameters

EnterpriseSearchReqVO fields:

FieldTypeRequiredDescription
parentIdLongNoSearch within this folder, excluding the root directory; includes descendants
needChildrenBooleanNoInclude assets in child folders; default false
extensionsList<String>NoFile extensions
colorStringNoColor
areaThresholdIntegerNoColor coverage threshold; default 20
colorThresholdIntegerNoColor precision threshold; default 20
minLengthLongNoMinimum video/audio duration in ms
maxLengthLongNoMaximum video/audio duration in ms
minSizeLongNoMinimum file size in bytes
maxSizeLongNoMaximum file size in bytes
minHeightLongNoMinimum image height in px
maxHeightLongNoMaximum image height in px
minWidthLongNoMinimum image width in px
maxWidthLongNoMaximum image width in px
startTimeLongNoStart of the update-time range
endTimeLongNoEnd of the update-time range
keywordsList<String>NoSearch keywords
tagsList<Long>NoTag IDs
tagOrAndBooleanNoCombine tags with OR/AND; true means AND; default true
createUsersList<Long>NoCreator IDs
ratingsList<Integer>NoRatings (scores)
hasLinkBooleanNoWhether an associated link exists
linkStringNoLink to match
hasDescBooleanNoWhether a description exists
descStringNoDescription to match
sortSortConditionVONoSort criteria
startPointIntegerNoPagination start index; default 0
endPointIntegerNoPagination end index; default 10
regionList<Float>NoSearch region coordinates
customFieldTemplateIdsList<Long>NoCustom field template IDs
customFieldIdLongNoCustom field ID
currentUserIdLongNoRestrict results to assets accessible to this user
wIntegerNoTarget width in px, 1–6000; used to generate publicUrl; values exceeding the original image dimensions have no effect
hIntegerNoTarget height in px, 1–6000; used to generate publicUrl; values exceeding the original image dimensions have no effect
modeStringNopublicUrl resize mode: fit (proportional) or crop (center crop); default fit
qIntegerNoOutput quality, 1–100; used to generate publicUrl
fStringNoOutput format: jpg / png / webp; used to generate publicUrl
bgStringNoBackground color in HEX without #; used to generate publicUrl
keywordSearchTypeStringNoDEEP (deep search, default), DEFAULT (standard in-app search), PRECISE (exact search), or DEEP_AND_PRECISE (both)

SortConditionVO fields:

FieldTypeRequiredDescription
sortNameSortConditionFieldEnumYesSort field
sortTypeSortTypeEnumNoSort direction

SortConditionFieldEnum values:

ValueDescription
CREATE_TIMECreation time
UPDATE_TIMEUpdate time
NAMEName
DURATIONDuration
SIZESize
SCORERating

SortTypeEnum values:

ValueDescription
ASCAscending
DESCDescending

Response fields:

ParameterTypeDescription
assetsList<MiniDamAssetDTO>Assets
totalLongTotal count

MiniDamAssetDTO fields:

FieldTypeDescription
idLongAsset ID
parentIdsList<Long>Parent folder IDs
userIdStringUser ID
nameStringOriginal filename
downloadUrlStringDownload URL
sourceIntegerAsset source: 1 web, 2 upload, 3 copy
linkStringWebpage URL
extensionStringFile extension
durationLongVideo duration
sizeLongFile size in KB
widthIntegerFile width
heightIntegerFile height
descriptionStringDescription
scoreIntegerRating
createTimeDateCreation time
createUserStringCreator
updateTimeDateUpdate time
updateUserLongLast updated by
tagsList<TagDTO>Tags
thumbnailAccessUrlStringThumbnail URL
imageContentAnalysisImageContentAnalysisAI analysis
publicUrlStringProcessed public link using w/h/mode/q/f/bg; empty if no processing parameters or public link are available

TagDTO fields:

FieldTypeDescription
idLongTag ID
nameStringTag name

ImageContentAnalysis fields:

FieldTypeDescription
aiTagsStringAI-generated tags
aiTitleStringAI-generated title
aiDescriptionStringAI-generated description
aiDetailedDescriptionJSONArrayDetailed AI analysis

Request example:

bash
curl --location --request POST 'https://open.musedam.ai/api/muse/search-assets' \
--header 'Authorization: Bearer your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
"parentId": 100,
"needChildren": true,
"extensions": [
"jpg",
"png"
],
"minSize": 1024,
"maxSize": 10485760,
"keywords": [
"product",
"promotion"
],
"tags": [
1,
2
],
"sort": {
"sortName": "CREATE_TIME",
"sortType": "DESC"
},
"startPoint": 0,
"endPoint": 20
}'

Response example:

json
{
"code": "0",
"message": "OK",
"result": {
"assets": [
{
"id": 10001,
"parentIds": [
100
],
"userId": "user123",
"name": "product-promotion.jpg",
"downloadUrl": "https://example.com/download/10001",
"source": 2,
"extension": "jpg",
"size": 1024,
"width": 1920,
"height": 1080,
"description": "Product promotional image",
"score": 5,
"createTime": "2023-04-03T10:00:00",
"createUser": "Alex",
"tags": [
{
"id": 1,
"name": "product"
},
{
"id": 2,
"name": "promotion"
}
],
"thumbnailAccessUrl": "https://example.com/thumbnail/10001",
"imageContentAnalysis": {
"aiTags": "futuristic,streamlined,modern,yellow,city street,black,dusk,intelligent transport,sci-fi,advertising,autonomous driving,car,concept art",
"aiTitle": "Futuristic urban sports car",
"aiDescription": "A futuristic urban sports car with a streamlined body and orange accents illuminated at night. Triangular headlights and a distinctive rear spoiler reinforce its sporty, aerodynamic design.\n\nA busy city skyline, bright neon lights and passing cars create a dynamic science-fiction atmosphere.",
"aiDetailedDescription": [
{
"usage": "A futuristic concept car for science-fiction films or video games."
},
{
"mood": "Energetic and technological"
},
{
"culture_traits": "Innovation and technological progress in modern urban culture"
},
{
"industry_domain": "Automotive manufacturing and high technology"
},
{
"seasonality": ""
},
{
"holiday_theme": ""
},
{
"color_scheme": "Black, yellow and orange"
}
]
}
}
],
"total": 150
}}

Search shared assets

Endpoint: /search-share

Method: POST

Description: Search assets within a shared link.

Request parameters:

ParameterTypeRequiredDefaultDescription
linkTokenStringYes-Unique token identifying the shared link
passwordStringNo-Access code; required if the share is password-protected
folderIdLongNo-Folder to query; defaults to the root folder
needChildrenBooleanNofalseInclude assets in child folders
isRootBooleanNofalseWhether this is the root of the share
keywordStringNo-Filter assets whose filenames contain this keyword
startPointIntegerNo0Pagination start index
endPointIntegerNo40Pagination end index; default page size is 40

Response fields:

ParameterTypeDescription
assetsList<MiniDamAssetDTO>Assets
totalCountLongTotal asset count
foldersList<FolderDTO>Folders
folderCountLongTotal folder count

FolderDTO fields

ParameterTypeDescription
idLongFolder ID
nameStringFolder name

Request example:

bash
curl --location --request POST 'https://open.musedam.ai/api/muse/search-share' \
--header 'Authorization: Bearer your_api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
"linkToken":"12534a263031407481ccac298e3568f7",
"isRoot":false,
"folderId":23343,
"needChildren":true
}'

Response example:

json
{
"code": "0",
"message": "OK",
"result": {
"assets": [
{
"id": 6905957,
"parentIds": [
23046,
23345
],
"userId": "1673603133161799680",
"name": "Banana-flavored chewing gum",
"downloadUrl": "https://example.com/assets/sample.jpg",
"source": null,
"link": null,
"extension": "png",
"duration": null,
"size": 209769,
"width": 800,
"height": 800,
"description": null,
"score": null,
"createTime": 1741160880000,
"createUser": "1673603133161799680",
"updateTime": 1741160880000,
"updateUser": 1673603133161799680,
"tags": [],
"thumbnailAccessUrl": "https://example.com/assets/sample.jpg"
}
],
"folders": [
{
"id": 23345,
"name": "Guest folder 2-1"
}
],
"totalCount": 1,
"folderCount": 1
},
"traceId": "109456b3501142a4a015a0b53fe7bc7e"
}
MuseDAM Developer PlatformAPI · Integrations · MCP
    Asset search | MuseDAM Developers