DAM API (1.0)

Download OpenAPI specification:

Digital assets, folders, and renditions.

Assets

Notify asset upload completion

Notify the service that an asset has been successfully uploaded to S3; creates the asset record

Authorizations:

BearerAuth

Request Body schema: application/json
required

Upload notification payload

folder_id	string
key	string

Responses

Request samples

Payload

Content type

application/json

{"folder_id": "string",
"key": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"data": {"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "A sample PDF document",
"file_path": "assets/documents/document.pdf",
"file_size": 102400,
"file_type": "application/pdf",
"id": "550e8400-e29b-41d4-a716-446655440000",
"is_deleted": false,
"modified_at": "2026-03-17T12:00:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "document.pdf",
"status": "uploaded",
"tenant_id": "550e8400-e29b-41d4-a716-446655440001",
"version": {"created_at": "2026-03-17T10:00:00Z",
"file_path": "assets/documents/document.pdf",
"id": "550e8400-e29b-41d4-a716-446655440000",
"rendition_paths": "string",
"version_label": "v1.0",
"version_notes": "Initial version",
"version_number": 1
}
},
"message": "string",
"success": true,
"trace_id": "string"
}

Get presigned upload URL

Generate a presigned S3 URL for uploading an asset directly to object storage

Authorizations:

BearerAuth

query Parameters

file_name required	string File name
content_type required	string MIME content type (e.g. application/pdf)
size required	integer File size in bytes
folder_id required	string Destination folder ID

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"content_type": "application/pdf",
"expires_in": 3600,
"folder_id": "550e8400-e29b-41d4-a716-446655440000",
"key": "assets/documents/document.pdf",
"upload_url": "https://s3.amazonaws.com/bucket/key?signature=..."
},
"message": "string",
"success": true,
"trace_id": "string"
}

Delete an asset

Soft delete an asset

Authorizations:

BearerAuth

path Parameters

id

required

string

Asset ID

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string",
"success": true
}

Update an asset

Update an asset's name

Authorizations:

BearerAuth

path Parameters

id

required

string

Asset ID

Request Body schema: application/json
required

Asset update payload

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
400
401
500

Content type

application/json

{"data": {"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"description": "A sample PDF document",
"file_path": "assets/documents/document.pdf",
"file_size": 102400,
"file_type": "application/pdf",
"id": "550e8400-e29b-41d4-a716-446655440000",
"is_deleted": false,
"modified_at": "2026-03-17T12:00:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "document.pdf",
"status": "uploaded",
"tenant_id": "550e8400-e29b-41d4-a716-446655440001",
"version": {"created_at": "2026-03-17T10:00:00Z",
"file_path": "assets/documents/document.pdf",
"id": "550e8400-e29b-41d4-a716-446655440000",
"rendition_paths": "string",
"version_label": "v1.0",
"version_notes": "Initial version",
"version_number": 1
}
},
"message": "string",
"success": true,
"trace_id": "string"
}

Folders

Get list of folders

Retrieve a paginated list of folders, optionally filtered by parent

Authorizations:

BearerAuth

query Parameters

parent_id	string Parent folder ID
page	integer Default: 1 Page number
page_size	integer Default: 10 Page size

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"items": [{"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Assets",
"parent_id": "550e8400-e29b-41d4-a716-446655440001"
}
],
"pagination": {"has_next": true,
"page": 1,
"page_size": 10,
"total_pages": 5,
"total_records": 50
}
},
"message": "string",
"success": true,
"trace_id": "string"
}

Create a new folder

Create a new folder under an optional parent folder, or seed from a category

Authorizations:

BearerAuth

Request Body schema: application/json
required

Folder creation payload

category_id	string
name	string
parent_id	string

Responses

Request samples

Payload

Content type

application/json

{"category_id": "string",
"name": "string",
"parent_id": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"data": {"assets": [{"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"file_size": 102400,
"file_type": "application/pdf",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "document.pdf",
"presigned_url": "string",
"status": "uploaded"
}
],
"child_asset_count": 5,
"child_folder_count": 3,
"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "550e8400-e29b-41d4-a716-446655440000",
"level": 0,
"modified_at": "2026-03-17T12:00:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Assets",
"parent_id": "550e8400-e29b-41d4-a716-446655440001",
"path_ids": ["string"
],
"sub_folders": [{"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Assets",
"parent_id": "550e8400-e29b-41d4-a716-446655440001"
}
]
},
"message": "string",
"success": true,
"trace_id": "string"
}

Initialize folders from category tree

Create a root folder and folder structure based on a category tree for the tenant

Authorizations:

BearerAuth

Request Body schema: application/json

Optional category ID to seed folder structure from

category_id

string

Responses

Request samples

Payload

Content type

application/json

{"category_id": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"data": {"assets": [{"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"file_size": 102400,
"file_type": "application/pdf",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "document.pdf",
"presigned_url": "string",
"status": "uploaded"
}
],
"child_asset_count": 5,
"child_folder_count": 3,
"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "550e8400-e29b-41d4-a716-446655440000",
"level": 0,
"modified_at": "2026-03-17T12:00:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Assets",
"parent_id": "550e8400-e29b-41d4-a716-446655440001",
"path_ids": ["string"
],
"sub_folders": [{"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Assets",
"parent_id": "550e8400-e29b-41d4-a716-446655440001"
}
]
},
"message": "string",
"success": true,
"trace_id": "string"
}

Get folder details

Retrieve detailed information about a specific folder including child folders and assets

Authorizations:

BearerAuth

path Parameters

id

required

string

Folder ID

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"assets": [{"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"file_size": 102400,
"file_type": "application/pdf",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "document.pdf",
"presigned_url": "string",
"status": "uploaded"
}
],
"child_asset_count": 5,
"child_folder_count": 3,
"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "550e8400-e29b-41d4-a716-446655440000",
"level": 0,
"modified_at": "2026-03-17T12:00:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Assets",
"parent_id": "550e8400-e29b-41d4-a716-446655440001",
"path_ids": ["string"
],
"sub_folders": [{"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Assets",
"parent_id": "550e8400-e29b-41d4-a716-446655440001"
}
]
},
"message": "string",
"success": true,
"trace_id": "string"
}

Delete a folder

Soft delete a folder and its contents

Authorizations:

BearerAuth

path Parameters

id

required

string

Folder ID

query Parameters

force

boolean

Force delete even if folder has children

Responses

Response samples

200
400
401
500

Content type

application/json

{"message": "string",
"success": true
}

Update a folder

Update an existing folder's name

Authorizations:

BearerAuth

path Parameters

id

required

string

Folder ID

Request Body schema: application/json
required

Folder update payload

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
400
401
500

Content type

application/json

{"data": {"assets": [{"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"file_size": 102400,
"file_type": "application/pdf",
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "document.pdf",
"presigned_url": "string",
"status": "uploaded"
}
],
"child_asset_count": 5,
"child_folder_count": 3,
"created_at": "2026-03-17T10:00:00Z",
"created_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"id": "550e8400-e29b-41d4-a716-446655440000",
"level": 0,
"modified_at": "2026-03-17T12:00:00Z",
"modified_by": {"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "John Doe",
"type": "user"
},
"name": "Assets",
"parent_id": "550e8400-e29b-41d4-a716-446655440001",
"path_ids": ["string"
],
"sub_folders": [{"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Assets",
"parent_id": "550e8400-e29b-41d4-a716-446655440001"
}
]
},
"message": "string",
"success": true,
"trace_id": "string"
}

Get folder breadcrumb

Retrieve the breadcrumb trail (ancestor path) for a specific folder

Authorizations:

BearerAuth

path Parameters

id

required

string

Folder ID

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": {"breadcrumb": [{"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Assets"
}
]
},
"message": "string",
"success": true,
"trace_id": "string"
}

Health

Health check

Check if the service is healthy

Responses

Response samples

200

Content type

application/json

{"message": "string",
"success": true
}

DAM API (1.0)

Assets

Notify asset upload completion

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get presigned upload URL

Authorizations:

query Parameters

Responses

Response samples

Delete an asset

Authorizations:

path Parameters

Responses

Response samples

Update an asset

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Folders

Get list of folders

Authorizations:

query Parameters

Responses

Response samples

Create a new folder

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Initialize folders from category tree

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Get folder details

Authorizations:

path Parameters

Responses

Response samples

Delete a folder

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update a folder

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get folder breadcrumb

Authorizations:

path Parameters

Responses

Response samples

Health

Health check

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required