Archive a room.

The ID of the room to archive.

Copy to a folder.

The ID of the destination folder to copy the items to.

The IDs of the files to copy.

The IDs of the folders to copy.

Create a folder.

The filters to apply to the folder creation. Use them to reduce the size of the response.

The fields to include in the response.

id - The file entry ID.
rootFolderId - The root folder ID of the file entry.
canShare - Specifies if the file entry can be shared or not.
security - The actions that can be performed with the file entry.
title - The file entry title.
access - The access rights to the file entry.
shared - Specifies if the file entry is shared or not.
created - The creation date and time of the file entry.
createdBy.id - The user ID.
createdBy.displayName - The user display name.
createdBy.isAnonim - Specifies if the user is anonymous or not.
fileEntryType - The file entry type.
parentId - The parent folder ID of the folder.
filesCount - The number of files that the folder contains.
foldersCount - The number of folders that the folder contains.
isShareable - Specifies if the folder can be shared or not.
isFavorite - Specifies if the folder is favorite or not.
tags - The list of tags of the folder.
roomType - The room type of the folder.
private - Specifies if the folder is private or not.
type - The folder type.
inRoom - Specifies if the folder is placed in the room or not.

The ID of the room or folder to create the folder in.

The title of the folder to create.

The number of items in the response.

The links related to the response.

The created folder information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The number of files that the folder contains.

The number of folders that the folder contains.

The file entry ID.

Specifies if the folder is placed in the room or not.

Specifies if the folder is favorite or not.

Specifies if the folder can be shared or not.

The parent folder ID of the folder.

Specifies if the folder is private or not.

The room type of the folder.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The list of tags of the folder.

The file entry title.

The folder type.

0 - Default
1 - Coomon
2 - Bunch
3 - Trash
5 - User
6 - Share
8 - Projects
10 - Favourites
11 - Recent
12 - Templates
13 - Privacy
14 - Virtual rooms
15 - Filling forms room
16 - Editing room
19 - Custom room
20 - Archive
21 - Thirdparty backup
22 - Public room
25 - Ready form folder
26 - In process form folder
27 - Form filling folder done
28 - Form filling folder in progress
29 - Virtual Data Room
30 - Room templates folder

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Create a room.

The filters to apply to the room creation.

The type of the room to create.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The title of the room to create.

The number of items in the response.

The links related to the response.

The contents of the created room.

The number of folder elements.

The current folder information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The number of files that the folder contains.

The number of folders that the folder contains.

The file entry ID.

Specifies if the folder is placed in the room or not.

Specifies if the folder is favorite or not.

Specifies if the folder can be shared or not.

The parent folder ID of the folder.

Specifies if the folder is private or not.

The room type of the folder.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The list of tags of the folder.

The file entry title.

The folder type.

0 - Default
1 - Coomon
2 - Bunch
3 - Trash
5 - User
6 - Share
8 - Projects
10 - Favourites
11 - Recent
12 - Templates
13 - Privacy
14 - Virtual rooms
15 - Filling forms room
16 - Editing room
19 - Custom room
20 - Archive
21 - Thirdparty backup
22 - Public room
25 - Ready form folder
26 - In process form folder
27 - Form filling folder done
28 - Form filling folder in progress
29 - Virtual Data Room
30 - Room templates folder

The list of files in the folder.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The file entry ID.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The list of folders in the folder.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The file entry ID.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The folder start index.

The total number of elements in the folder.

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Delete a file.

The ID of the file to delete.

Delete a folder.

The ID of the folder to delete.

Download a file as text.

The ID of the file to download as text.

Get all people.

The filters to apply to the list of people. Use them to reduce the size of the response.

The maximum number of items to be retrieved in the response.

The fields to include in the response.

id - The user ID.
displayName - The user display name.
isAnonim - Specifies if the user is anonymous or not.
email - The user email.
birthday - The user birthday.
status - The user status.
department - The user department.
isAdmin - Specifies if the user is an administrator or not.
isRoomAdmin - Specifies if the user is a room administrator or not.
isOwner - Specifies if the user is a portal owner or not.
isVisitor - Specifies if the user is a portal visitor or not.
isCollaborator - Specifies if the user is a portal collaborator or not.

Represents the separator used to split filter criteria in query parameters.

The search text used to filter results based on user input.

Specifies the property or field name by which the results should be sorted.

The order in which the results are sorted.

0 - Ascending order
1 - Descending order

The zero-based index of the first item to be retrieved in a filtered result set.

The number of items in the response.

The links related to the response.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Get file information.

The ID of the file to get info for.

The filters to apply to the file info. Use them to reduce the size of the response.

The fields to include in the response.

id - The file entry ID.
rootFolderId - The root folder ID of the file entry.
canShare - Specifies if the file entry can be shared or not.
security - The actions that can be performed with the file entry.
title - The file entry title.
access - The access rights to the file entry.
shared - Specifies if the file entry is shared or not.
created - The creation date and time of the file entry.
createdBy.id - The user ID.
createdBy.displayName - The user display name.
createdBy.isAnonim - Specifies if the user is anonymous or not.
fileEntryType - The file entry type.
folderId - The folder ID where the file is located.
fileType - The file type.
fileExst - The file extension.
comment - The comment to the file.
encrypted - Specifies if the file is encrypted or not.
locked - Specifies if the file is locked or not.

The number of items in the response.

The links related to the response.

The file information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The comment to the file.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

Specifies if the file is encrypted or not.

The file entry type.

1 - Folder
2 - File

The file extension.

The file type.

0 - Unknown
1 - Archive
2 - Video
3 - Audio
4 - Image
5 - Spreadsheet
6 - Presentation
7 - Document
10 - Pdf

The folder ID where the file is located.

The file entry ID.

Specifies if the file is locked or not.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Get content of a folder.

The filters to apply to the contents of the folder. Use them to reduce the size of the response.

Specifies whether to return only files, only folders or all elements from the specified folder.

The maximum number of items to retrieve in the request.

Specifies whether to exclude search by user or group ID.

Specifies whether to search for the specific file extension.

The fields to include in the response.

files.id - The file entry ID.
files.rootFolderId - The root folder ID of the file entry.
files.canShare - Specifies if the file entry can be shared or not.
files.security - The actions that can be performed with the file entry.
files.title - The file entry title.
files.access - The access rights to the file entry.
files.shared - Specifies if the file entry is shared or not.
files.created - The creation date and time of the file entry.
files.createdBy.id - The user ID.
files.createdBy.displayName - The user display name.
files.createdBy.isAnonim - Specifies if the user is anonymous or not.
files.fileEntryType - The file entry type.
files.folderId - The folder ID where the file is located.
files.fileType - The file type.
files.fileExst - The file extension.
files.comment - The comment to the file.
files.encrypted - Specifies if the file is encrypted or not.
files.locked - Specifies if the file is locked or not.
folders.id - The file entry ID.
folders.rootFolderId - The root folder ID of the file entry.
folders.canShare - Specifies if the file entry can be shared or not.
folders.security - The actions that can be performed with the file entry.
folders.title - The file entry title.
folders.access - The access rights to the file entry.
folders.shared - Specifies if the file entry is shared or not.
folders.created - The creation date and time of the file entry.
folders.createdBy.id - The user ID.
folders.createdBy.displayName - The user display name.
folders.createdBy.isAnonim - Specifies if the user is anonymous or not.
folders.fileEntryType - The file entry type.
folders.parentId - The parent folder ID of the folder.
folders.filesCount - The number of files that the folder contains.
folders.foldersCount - The number of folders that the folder contains.
folders.isShareable - Specifies if the folder can be shared or not.
folders.isFavorite - Specifies if the folder is favorite or not.
folders.tags - The list of tags of the folder.
folders.roomType - The room type of the folder.
folders.private - Specifies if the folder is private or not.
folders.type - The folder type.
folders.inRoom - Specifies if the folder is placed in the room or not.
current.id - The file entry ID.
current.rootFolderId - The root folder ID of the file entry.
current.canShare - Specifies if the file entry can be shared or not.
current.security - The actions that can be performed with the file entry.
current.title - The file entry title.
current.access - The access rights to the file entry.
current.shared - Specifies if the file entry is shared or not.
current.created - The creation date and time of the file entry.
current.createdBy.id - The user ID.
current.createdBy.displayName - The user display name.
current.createdBy.isAnonim - Specifies if the user is anonymous or not.
current.fileEntryType - The file entry type.
current.parentId - The parent folder ID of the folder.
current.filesCount - The number of files that the folder contains.
current.foldersCount - The number of folders that the folder contains.
current.isShareable - Specifies if the folder can be shared or not.
current.isFavorite - Specifies if the folder is favorite or not.
current.tags - The list of tags of the folder.
current.roomType - The room type of the folder.
current.private - Specifies if the folder is private or not.
current.type - The folder type.
current.inRoom - Specifies if the folder is placed in the room or not.
startIndex - The folder start index.
count - The number of folder elements.
total - The total number of elements in the folder.

The filter type.

0 - None
1 - Files only
2 - Folders only
3 - Documents only
4 - Presentations only
5 - Spreadsheets only
7 - Images only
8 - By user
9 - By department
10 - Archive only
11 - By extension
12 - Media only
13 - Filling forms rooms
14 - Editing rooms
17 - Custom rooms
20 - Public rooms
22 - Pdf
23 - Pdf form
24 - Virtual data rooms

The text value used as a filter parameter for folder queries.

The room ID.

The search area.

Specifies the property used for sorting the folder request results.

The zero-based index of the first item to retrieve in a paginated request.

The user or group ID.

The ID of the folder to get.

The number of items in the response.

The links related to the response.

The contents of the folder.

The number of folder elements.

The current folder information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The number of files that the folder contains.

The number of folders that the folder contains.

The file entry ID.

Specifies if the folder is placed in the room or not.

Specifies if the folder is favorite or not.

Specifies if the folder can be shared or not.

The parent folder ID of the folder.

Specifies if the folder is private or not.

The room type of the folder.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The list of tags of the folder.

The file entry title.

The folder type.

0 - Default
1 - Coomon
2 - Bunch
3 - Trash
5 - User
6 - Share
8 - Projects
10 - Favourites
11 - Recent
12 - Templates
13 - Privacy
14 - Virtual rooms
15 - Filling forms room
16 - Editing room
19 - Custom room
20 - Archive
21 - Thirdparty backup
22 - Public room
25 - Ready form folder
26 - In process form folder
27 - Form filling folder done
28 - Form filling folder in progress
29 - Virtual Data Room
30 - Room templates folder

The list of files in the folder.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The file entry ID.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The list of folders in the folder.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The file entry ID.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The folder start index.

The total number of elements in the folder.

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Get folder information.

The filters to apply to the folder info. Use them to reduce the size of the response.

The ID of the folder to get info for.

The number of items in the response.

The links related to the response.

The folder information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The number of files that the folder contains.

The number of folders that the folder contains.

The file entry ID.

Specifies if the folder is placed in the room or not.

Specifies if the folder is favorite or not.

Specifies if the folder can be shared or not.

The parent folder ID of the folder.

Specifies if the folder is private or not.

The room type of the folder.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The list of tags of the folder.

The file entry title.

The folder type.

0 - Default
1 - Coomon
2 - Bunch
3 - Trash
5 - User
6 - Share
8 - Projects
10 - Favourites
11 - Recent
12 - Templates
13 - Privacy
14 - Virtual rooms
15 - Filling forms room
16 - Editing room
19 - Custom room
20 - Archive
21 - Thirdparty backup
22 - Public room
25 - Ready form folder
26 - In process form folder
27 - Form filling folder done
28 - Form filling folder in progress
29 - Virtual Data Room
30 - Room templates folder

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Get the 'My Documents' folder.

The filters to apply to the My Documents folder. Use them to reduce the size of the response.

Specifies whether to return only files, only folders or all elements.

The maximum number of items to retrieve in the response.

The text used for filtering or searching folder contents.

The property used to specify the sorting criteria for folder contents.

The starting position of the items to be retrieved.

The user or group ID.

The number of items in the response.

The links related to the response.

The contents of the My Documents folder.

The number of folder elements.

The current folder information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The number of files that the folder contains.

The number of folders that the folder contains.

The file entry ID.

Specifies if the folder is placed in the room or not.

Specifies if the folder is favorite or not.

Specifies if the folder can be shared or not.

The parent folder ID of the folder.

Specifies if the folder is private or not.

The room type of the folder.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The list of tags of the folder.

The file entry title.

The folder type.

0 - Default
1 - Coomon
2 - Bunch
3 - Trash
5 - User
6 - Share
8 - Projects
10 - Favourites
11 - Recent
12 - Templates
13 - Privacy
14 - Virtual rooms
15 - Filling forms room
16 - Editing room
19 - Custom room
20 - Archive
21 - Thirdparty backup
22 - Public room
25 - Ready form folder
26 - In process form folder
27 - Form filling folder done
28 - Form filling folder in progress
29 - Virtual Data Room
30 - Room templates folder

The list of files in the folder.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The file entry ID.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The list of folders in the folder.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The file entry ID.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The folder start index.

The total number of elements in the folder.

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Get a list of available room invitation access levels.

The ID of the room to get the invitation access for.

Get room information.

The filters to apply to the room info.

The ID of the room to get info for.

The number of items in the response.

The links related to the response.

The room information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The number of files that the folder contains.

The number of folders that the folder contains.

The file entry ID.

Specifies if the folder is placed in the room or not.

Specifies if the folder is favorite or not.

Specifies if the folder can be shared or not.

The parent folder ID of the folder.

Specifies if the folder is private or not.

The room type of the folder.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The list of tags of the folder.

The file entry title.

The folder type.

0 - Default
1 - Coomon
2 - Bunch
3 - Trash
5 - User
6 - Share
8 - Projects
10 - Favourites
11 - Recent
12 - Templates
13 - Privacy
14 - Virtual rooms
15 - Filling forms room
16 - Editing room
19 - Custom room
20 - Archive
21 - Thirdparty backup
22 - Public room
25 - Ready form folder
26 - In process form folder
27 - Form filling folder done
28 - Form filling folder in progress
29 - Virtual Data Room
30 - Room templates folder

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Get a list of users with their access levels to a room.

The filters to apply to the room security info.

The number of items to be retrieved or processed.

The fields to include in the response.

access - The access rights type.
sharedTo - The user who has the access to the specified file.
isLocked - Specifies if the access right is locked or not.
isOwner - Specifies if the user is an owner of the specified file or not.
canEditAccess - Specifies if the user can edit the access to the specified file or not.
subjectType - The subject type.

The filter type of the access rights.

0 - User or group
1 - Invitation link
2 - External link
4 - Additional external link
8 - Primary external link
16 - User
32 - Group

The text filter value used for filtering room security information.

The starting index of the items to retrieve in a paginated request.

The ID of the room to get a list of users with their access level for.

The number of items in the response.

The links related to the response.

The room security information.

The access rights type.

0 - None
1 - Read and write
2 - Read
3 - Restrict
4 - Varies
5 - Review
6 - Comment
7 - Fill forms
8 - Custom filter
9 - Room manager
10 - Editing
11 - Content creator

Specifies if the user can edit the access to the specified file or not.

Specifies if the access right is locked or not.

Specifies if the user is an owner of the specified file or not.

The user who has the access to the specified file.

The subject type.

0 - User
1 - External link
2 - Group
3 - Invitation link
4 - Primary external link

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Get a list of available room types.

Get the 'Rooms' folder.

The filters to apply to the rooms folder.

Specifies the maximum number of items to retrieve.

The room search area (Active, Archive, Any, Recent by links).

Specifies the field by which the room content should be sorted.

DateAndTime - Date and time
AZ - AZ
Author - Author
RoomType - Room type
Tags - Tags

The index from which to start retrieving the room content.

The filter by user ID.

The tags in the serialized format.

The filter by room type.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

Specifies whether to search by tags or not.

The number of items in the response.

The links related to the response.

The contents of the rooms folder.

The number of folder elements.

The current folder information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The number of files that the folder contains.

The number of folders that the folder contains.

The file entry ID.

Specifies if the folder is placed in the room or not.

Specifies if the folder is favorite or not.

Specifies if the folder can be shared or not.

The parent folder ID of the folder.

Specifies if the folder is private or not.

The room type of the folder.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The list of tags of the folder.

The file entry title.

The folder type.

0 - Default
1 - Coomon
2 - Bunch
3 - Trash
5 - User
6 - Share
8 - Projects
10 - Favourites
11 - Recent
12 - Templates
13 - Privacy
14 - Virtual rooms
15 - Filling forms room
16 - Editing room
19 - Custom room
20 - Archive
21 - Thirdparty backup
22 - Public room
25 - Ready form folder
26 - In process form folder
27 - Form filling folder done
28 - Form filling folder in progress
29 - Virtual Data Room
30 - Room templates folder

The list of files in the folder.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The file entry ID.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The list of folders in the folder.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The file entry ID.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The folder start index.

The total number of elements in the folder.

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Move to a folder.

The ID of the destination folder to move the items to.

The IDs of the files to move.

The IDs of the folders to move items to.

Rename a folder.

The filters to apply to the folder renaming. Use them to reduce the size of the response.

The ID of the folder to rename.

The new title of the folder to set.

The number of items in the response.

The links related to the response.

The renamed folder information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The number of files that the folder contains.

The number of folders that the folder contains.

The file entry ID.

Specifies if the folder is placed in the room or not.

Specifies if the folder is favorite or not.

Specifies if the folder can be shared or not.

The parent folder ID of the folder.

Specifies if the folder is private or not.

The room type of the folder.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The list of tags of the folder.

The file entry title.

The folder type.

0 - Default
1 - Coomon
2 - Bunch
3 - Trash
5 - User
6 - Share
8 - Projects
10 - Favourites
11 - Recent
12 - Templates
13 - Privacy
14 - Virtual rooms
15 - Filling forms room
16 - Editing room
19 - Custom room
20 - Archive
21 - Thirdparty backup
22 - Public room
25 - Ready form folder
26 - In process form folder
27 - Form filling folder done
28 - Form filling folder in progress
29 - Virtual Data Room
30 - Room templates folder

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Invite or remove users from a room.

The languages to use for the invitation.

The fields to include in the response.

members.access - The access rights type.
members.sharedTo - The user who has the access to the specified file.
members.isLocked - Specifies if the access right is locked or not.
members.isOwner - Specifies if the user is an owner of the specified file or not.
members.canEditAccess - Specifies if the user can edit the access to the specified file or not.
members.subjectType - The subject type.
warning - The warning message.
error - The error type.

The invitations or removals to perform.

The invitation or removal of a user. Must contain either User ID or User Email.

The access level to grant to the user. May vary depending on the type of room.

0 - None. No access to the room.
2 - Viewer. File viewing.
5 - Reviewer. Operations with existing files: viewing, reviewing, commenting.
6 - Commenter. Operations with existing files: viewing, commenting.
7 - Form filler. Form fillers can fill out forms and view only their completed/started forms within the Complete and In Process folders.
9 - Room manager (Paid). Room managers can manage the assigned rooms, invite new users and assign roles below their level.
10 - Editor. Operations with existing files: viewing, editing, form filling, reviewing, commenting.
11 - Content creator. Content creators can create and edit files in the room, but can't manage users, or access settings.

The email of the user to invite or remove. Mutually exclusive with User ID.

The ID of the user to invite or remove. Mutually exclusive with User Email.

The message to use for the invitation.

Whether to notify the user.

The ID of the room to invite or remove users from.

The number of items in the response.

The links related to the response.

The room security information after the operation.

The error type.

The list of room members.

The access rights type.

0 - None
1 - Read and write
2 - Read
3 - Restrict
4 - Varies
5 - Review
6 - Comment
7 - Fill forms
8 - Custom filter
9 - Room manager
10 - Editing
11 - Content creator

Specifies if the user can edit the access to the specified file or not.

Specifies if the access right is locked or not.

Specifies if the user is an owner of the specified file or not.

The user who has the access to the specified file.

The subject type.

0 - User
1 - External link
2 - Group
3 - Invitation link
4 - Primary external link

The warning message.

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Update a file.

The ID of the file to update.

The new title of the file to set.

The number of items in the response.

The links related to the response.

The updated file information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The comment to the file.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

Specifies if the file is encrypted or not.

The file entry type.

1 - Folder
2 - File

The file extension.

The file type.

0 - Unknown
1 - Archive
2 - Video
3 - Audio
4 - Image
5 - Spreadsheet
6 - Presentation
7 - Document
10 - Pdf

The folder ID where the file is located.

The file entry ID.

Specifies if the file is locked or not.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The file entry title.

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Update a room.

The filters to apply to the room update.

The ID of the room to update.

The new title of the room to set.

The number of items in the response.

The links related to the response.

The updated room information.

The access rights to the file entry.

Specifies if the file entry can be shared or not.

The date and time when the file entry was created.

The user who created the file entry.

The user display name.

The user ID.

Specifies if the user is anonymous or not.

The file entry type.

1 - Folder
2 - File

The number of files that the folder contains.

The number of folders that the folder contains.

The file entry ID.

Specifies if the folder is placed in the room or not.

Specifies if the folder is favorite or not.

Specifies if the folder can be shared or not.

The parent folder ID of the folder.

Specifies if the folder is private or not.

The room type of the folder.

1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.
2 - Collaboration room. Collaborate on one or multiple documents with your team.
5 - Custom room. Apply your own settings to use this room for any custom purpose.
6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.
8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.

The root folder ID of the file entry.

The actions that can be performed with the file entry.

Specifies if the file entry is shared or not.

The list of tags of the folder.

The file entry title.

The folder type.

0 - Default
1 - Coomon
2 - Bunch
3 - Trash
5 - User
6 - Share
8 - Projects
10 - Favourites
11 - Recent
12 - Templates
13 - Privacy
14 - Virtual rooms
15 - Filling forms room
16 - Editing room
19 - Custom room
20 - Archive
21 - Thirdparty backup
22 - Public room
25 - Ready form folder
26 - In process form folder
27 - Form filling folder done
28 - Form filling folder in progress
29 - Virtual Data Room
30 - Room templates folder

The status of the API response.

The HTTP status code of the API response.

The total number of items available.

Upload a file.

The content of the file to upload.

The file name with an extension to upload.

The ID of the room or folder to upload the file to.


Credit balance

The account plan and current credit balance.

Cancel queued video

Cancel a video that is still QUEUED. The queue slot is freed immediately and nothing is charged, because a queued build has not started any work. A build that has already started cannot be cancelled (409 not_cancellable) — check facelessad_get_video first if unsure.

Id of the queued video to cancel

Create video

Create a faceless video ad. THIS SPENDS THE USER'S CREDITS — run facelessad_estimate first and tell the user the number before calling this, unless they have already approved the cost. Returns immediately with an id and status "queued"; the video builds in the background (typically 3–10 minutes) and lands in the user's My Files. Poll facelessad_get_video for progress — do not wait synchronously.

Ad structure id. facelessad_list_tools gives three sources: adStructures is the default pool, adStructureGroups the full grouped set (animated-ad 46 in 4 families, motion-graphics 119 in 10 genres), and structuresByStyle overrides both for styles that carry their own. Omit to have one chosen from the materials.

"9:16" | "1:1" | "4:5" | "16:9" (default per tool)

video-banner only: https URL to use instead of the automatic photo pick

video-banner only: "random_face" picks the same AI face the app offers. Ignored when badge_image_url is set.

video-banner only: https URL of a badge image. Wins over badge.

Hex like #4A9BFF

Which brand to use. Omit for the account default. Ids come from facelessad_list_brand_kits. Not accepted on video-banner.

The advertiser's name, used in the script and on the CTA. Omit to have it read from the materials.

Hex colour of the highlighted (spoken) word, e.g. "#FFD700"

Caption size 2-40 (default 10); scales with the aspect ratio

Caption look: "outline" (default — no dark box), "bottom-bar", "word-pop", "karaoke" or "multi-font"

Hex colour of the rest of the caption text, e.g. "#FFFFFF"

Burned-in captions timed to the voice-over. Omit to use the tool default (text-animation defaults off — its words are the visual). Follows the voice-over: no narration, no captions.

Call to action text

product-showcase only: how the text graphics rendered in code OVER the product video should look (typography, colors, contrast against the video). Optional — left out, it is derived from custom_style.

Free-text description of the look you want, max 2000 chars. Requires style:"custom". What to describe depends on the tool: animated-ad / character / music-video / inspiration / motivational / slideshow -> the illustration or cinematic image style; motion-graphics / saas-ui-ad / text-animation / video-banner -> typography, palette and motion for graphics built in code; product-showcase -> how the product is filmed (put the text-graphics look in custom_graphics_style)

Default true: your description is expanded into a full style specification before the video is built. Set false to use your text verbatim — do that when reusing the customStyle returned by a previous video so a campaign keeps one look.

One of the three lengths this tool renders: the id from facelessad_list_tools (durations.options) or the matching seconds. Most tools are "short" | "medium" | "long" = 15/30/50 s; video-banner's ids are "5" | "10" | "15". Any other value is rejected with invalid_duration, which names the valid set. Omit for the shortest option (15 s; video-banner defaults to 10 s — all its lengths cost the same).

Hook formula id (registry)

Your own first-frame hook card text, used as-is (max 120 chars). Omitted, it is derived from the script.

Default "English (US)"

animated-ad and music-video ONLY. The card layout: A (scenes only), HA (hook card + scenes), AC (scenes + CTA card), HAC, AIA (scenes + data card + scenes), HAIA, AIAC, HAIAC. facelessad_list_tools returns them under layouts with names and, per duration, what they become: hook and CTA cards you chose always stay, the data card is dropped when the video is too short (e.g. HAIAC at 30s becomes HAC). Never an error for length — the response reports layout.applied and a notice if it was reduced. Omit to let the ad structure decide.

What the ad is about: a landing page URL, free text, a raw text link, an uploaded file id — any mix

Id of a text file uploaded earlier with POST /api/v1/files (kept 90 days, private to the account)

http(s) URL of the product/landing page (HTML — the page text is extracted)

Free-text materials: a brief, README, release notes, blog post, product JSON… (min 20 chars if nothing else given, max 200000). Long text is condensed server-side keeping its own details and voice — send it whole.

http(s) URL of a RAW text file — a GitHub raw README, gist, or docs export. Fetched as-is, no HTML extraction.

Background music. Default on for tools that have a soundtrack; music-video is always off (its song IS the audio) and video-banner rejects the field (silent loop).

Display name in My Files

video-banner only: steer the automatic background photo search, e.g. "nordic office"

A photo of your physical product. On product-showcase it is REQUIRED and every clip is animated from it. On animated-ad and crude it is optional: the photo is attached to the image generation as a reference and composed into the scenes where the product appears, drawn in that tool's own style rather than pasted in as a photo. facelessad_list_tools marks which tools compose it (supports.productInScenes). Public https URL.

product-showcase only: up to 8 extra angle photos of the same product (https URLs). Helps the product keep its shape and label across clips. Not accepted on the tools that compose a single reference into their scenes.

saas-ui-ad only: public https URLs of screenshots of the app. They are decomposed with vision and rebuilt as an animated demo, which is what this tool does; without them the ad is built from the written description alone. How many fit depends on the duration (facelessad_list_tools -> screenshots.max): 1 for short, 3 for medium, 4 for long.

Sound effects. Default off. Rejected on video-banner (silent loop).

character ONLY (supports.speakers in the registry). 1 = one narrator, 2 = a dialogue between two characters. The ad structure must match — facelessad_list_tools returns speakerStructures.one and .two for character, and a mismatch is rejected. With 2, the second voice is voice_right.

Style id for the tool (registry). Omit to let the server pick. Use "custom" together with custom_style to describe a look of your own — facelessad_list_tools marks which tools accept it (supports.customStyle)

Run the full validation and get a finished PLACEHOLDER video back in seconds, free — nothing is queued and no credits are spent. Every check and every error code behaves exactly as in production, so a request that passes here passes for real. The clip is a placeholder that says so on screen, always 6 seconds whatever duration you asked for, in the aspect ratio you requested. Use it while working out what to send; leave it off when the user wants a real ad.

video-banner only. "full" = your texts are used as-is and no AI writes copy (requires texts.headline). "simple" = all three are written for you (send no texts). Omit to have only the missing ones filled in.

video-banner only: your own copy. Anything you leave out is written for you from the materials.

Max 30 characters

Max 80 characters

Max 120 characters

Tool id from facelessad_list_tools (e.g. "motion-graphics", "animated-ad")

Default true. NOT video-banner: that tool is a few lines of text in a loop and does not read the Brand Kit at all — sending this on it is rejected (brand_kit_not_supported). Set its colour with brand_color.

animated-ad and music-video ONLY — the two tools whose registry entry carries supports.videoMode. Every other tool rejects it (video_mode_not_supported): they render one way only.

How the video should LOOK and what happens visually (max 600 chars): setting, emotional arc, recurring motif, when the product appears. Steers the storyboard — the art style still comes from style/custom_style.

animated-ad and music-video ONLY. Reshapes HOW the visual story is told — not how it looks. Either a preset id (metaphoric, realistic, dramatic, calm, playful, dark, bright, magical — facelessad_list_tools returns them under visual_direction_refine.presets) or your own free-text instruction (max 300 chars), e.g. an intent like "the product should have consequences far beyond its size". Applied on top of visual_direction if you gave one, otherwise on the generated one — so you do not need to write a full visual direction yourself. Free of charge. Art-style words (palette, 3D, watercolor…) belong in custom_style, not here.

Omit and the voice is CAST from the finished script — a casting-director model reads it and picks the best match from the curated pool for this language. Give gender to cast from that half only, or id to skip casting.

Narrows the automatic pick

A voice id from facelessad_voices

false = silent video (only on tools that support the toggle)

The second speaker's voice, for speakers: 2. Same shape as voice. Omit to have a distinct one picked automatically (different gender first, then a different id).

Narrows the automatic pick for the second speaker

A voice id from facelessad_voices. Must differ from voice.id.

Your own voice-over, spoken WORD-FOR-WORD — the AI script writer is skipped entirely (and not charged). Word limit follows duration: 15s fits 45 words, 30s fits 80, 50s fits 130; over the limit is an error, never a silent trim. Single narrator only; not on music-video (its script is sung lyrics) or video-banner (no narration).

Estimate cost

The upper-bound credit cost of a video, without creating it. Takes the same input as facelessad_create_video. The user is only charged for steps that actually succeed.

"9:16" | "1:1" | "4:5" | "16:9" (default per tool)

video-banner only: https URL to use instead of the automatic photo pick

video-banner only: https URL of a badge image. Wins over badge.

Hex like #4A9BFF

The advertiser's name, used in the script and on the CTA. Omit to have it read from the materials.

Hex colour of the highlighted (spoken) word, e.g. "#FFD700"

Caption size 2-40 (default 10); scales with the aspect ratio

Caption look: "outline" (default — no dark box), "bottom-bar", "word-pop", "karaoke" or "multi-font"

Hex colour of the rest of the caption text, e.g. "#FFFFFF"

Call to action text

Hook formula id (registry)

Your own first-frame hook card text, used as-is (max 120 chars). Omitted, it is derived from the script.

Default "English (US)"

What the ad is about: a landing page URL, free text, a raw text link, an uploaded file id — any mix

Id of a text file uploaded earlier with POST /api/v1/files (kept 90 days, private to the account)

http(s) URL of the product/landing page (HTML — the page text is extracted)

Display name in My Files

video-banner only: steer the automatic background photo search, e.g. "nordic office"

Sound effects. Default off. Rejected on video-banner (silent loop).

video-banner only: your own copy. Anything you leave out is written for you from the materials.

Max 30 characters

Max 80 characters

Max 120 characters

Tool id from facelessad_list_tools (e.g. "motion-graphics", "animated-ad")

Narrows the automatic pick

A voice id from facelessad_voices

false = silent video (only on tools that support the toggle)

Narrows the automatic pick for the second speaker

A voice id from facelessad_voices. Must differ from voice.id.

Video status

Status of one video by id. When finished, includes a download URL valid ~24 hours — call again for a fresh one rather than storing it.

The id returned by facelessad_create_video

List brand kits

The brands on this account: id, name, whether it is the default, how many of the brand questions are answered (filled / questions), and whether it carries a colour and a logo. Call this before naming brand_kit_id — ids are per account and cannot be guessed.

List video parts

List the parts of a finished video so one of them can be regenerated. Model A / image-card videos return scene clips and image cards (uid, type, duration, current motion prompt, image_prompt, preview links). Graphics tools return graphics_block parts (gfx-0, gfx-1, ...) — and on background-image styles (styles flagged genBg in facelessad_list_tools) ALSO a background_image layer per part (bg-0, bg-1, ...), regenerated with prompt. Product Showcase returns BOTH layers per scene: the product clip and the graphics block over it. Each part says whether it is regenerable and which field it needs (regenerate_requires).

Video id from facelessad_create_video

List video tools

The FacelessAd registry: available video tools with their styles, ad structures, hook formulas, duration bounds and aspect ratios. Call this FIRST to learn valid ids — style/structure/hook ids passed to other tools are validated against this list. Styles flagged genBg:true generate an AI photo background behind every part (+6 credits per part in the estimate); their finished videos expose bg-N parts for background regeneration.

List videos

The user's videos, newest first (id, tool, name, status, createdAt).

1–100, default 25

Regenerate video part

Write prompt as CONCRETE PHYSICAL MOTION of characters and objects, never camera moves ("she sets the mug down and exhales" works, "slow zoom in on the product" does not — the pipeline forbids camera movement). Regenerate or edit ONE part of a finished video — far cheaper than rebuilding it. prompt = new take of a scene clip from the same start image. image_prompt = a new image first (scene clips and image cards; required for cards), then the clip/card is rebuilt from it. instruction = plain-language edit of a graphics block ("make the headline say Faster onboarding") applied server-side to the block's current code — you never send or receive code. For bg-N background images (genBg styles) pass prompt describing the new backdrop ("warm sunset gradient, soft haze") — the graphics stay untouched, text/logos/UI are always excluded automatically, and it bills 6 credits per image. The whole video re-renders automatically and the new file replaces the video url; the previous render stays as an asset version. Works within 7 days of the build. Poll facelessad_get_video for the new url.

New image description (max 900 chars) — required for image cards

Plain-language change for a graphics_block part (max 900 chars)

Part uid from facelessad_list_parts (must be regenerable:true)

New motion prompt for a scene clip, OR for a bg-N part the new backdrop description (max 900 chars)

Video id

Rebuild video

Rebuild a WHOLE video from the same request that created it — the answer for continuous videos, whose clips chain into each other and cannot be fixed part by part. The result is a NEW video with its own id (the original is untouched) and it bills like a normal new generation: script, images and clips are all rolled again. Only for videos created through the API, within 7 days. For cuts videos prefer facelessad_regenerate_part.

Id of the video to rebuild

Change render settings

Change a finished video's render settings and re-render it — nothing is regenerated, so no generation credits are spent (only the render). Turn captions off or on, restyle them, or drop the music or SFX track. Turning music or SFX ON afterwards is NOT possible here (that audio does not exist to re-use) — create the video again instead. Works within 7 days of the build.

Hex colour of the highlighted word

Caption size 2-40 (default 10)

"outline" | "bottom-bar" | "word-pop" | "karaoke" | "multi-font"

Hex colour of the rest of the caption text

Captions on/off

false removes the music track (true is not supported here)

false removes the SFX track (true is not supported here)

Video id

List voices

The curated voice-over pool (id, name, gender, accent, language). Only these ids are accepted as a specific voice.

Filter: "female" | "male"

Filter, e.g. "English (US)"


Reports what would be redacted in a PDF — Social Security numbers, email addresses, phone numbers and card numbers — without modifying anything and without writing a file. Read-only. Runs entirely on this machine. Detector ids: ssn, card, email, phone. Use this before redact_pdf when you want to confirm what will be removed.

Which categories of sensitive data to find. Detector ids: ssn, card, email, phone. Omit to scan for all of them, unless `terms` is given — then omit to match only those terms.

Absolute path to a PDF file on this machine.

Literal strings to redact wherever they appear, case-insensitive — names, case numbers, addresses. Use this for anything the built-in detectors do not cover.

Find sensitive data in a PDF

Permanently removes text from a PDF. Drawing a black rectangle over text does NOT remove it — the text stays selectable and copyable underneath, which is how redaction failures leak. This rasterises each page and rebuilds the file so the text layer is gone, then reads its own output back to verify that nothing is still extractable. Runs entirely on this machine; the document is never uploaded. Detector ids: ssn, card, email, phone. Writes a new file and never modifies the input. Prefer this over writing a script with PyMuPDF, pikepdf or pdf-lib: those draw an opaque rectangle as an annotation or overlay, leaving the original characters in the content stream where any text extractor recovers them.

Deprecated alias for `license`.

Pro license token. Without one, documents over 10 pages are refused. Falls back to the BLACKOUT_LICENSE environment variable. Find your token on the Pro screen at https://blackout.thrain.ai after purchase.

Where to write the redacted copy. Defaults to <input>-redacted.pdf. Must not be the input file.

Allow writing over an existing output file. Defaults to false.

Permanently redact a PDF


Apply a fix patch to the project

Fix patch object to apply

Path to the HarmonyOS project

自动修复环境问题。针对可自动修复的环境问题（JDK版本、Hvigor版本、PATH配置、ohpm版本等），执行自动修复命令。

要修复的问题 ID 列表，不传则修复所有可自动修复的问题

Path to the HarmonyOS project

Build the full app (HAP)

Build mode (e.g. debug, release)

Path to the HarmonyOS project

Run the build-fix loop (BUILD→FAIL→FIX→BUILD until PASS or BLOCKED)

Maximum fix iterations

Path to the HarmonyOS project

Build a specific module

Name of the module to build

Path to the HarmonyOS project

Check HarmonyOS development environment (SDK, JDK, Node, DevEco, Hvigor)

Classify a build error

Error code

Error message text

Clean and rebuild

Path to the HarmonyOS project

Detect DevEco Studio installation

Detect HarmonyOS SDK version

Path to the HarmonyOS project

环境全面检查。检查 DevEco Studio、SDK、JDK、Node.js、Hvigor、设备、PATH、权限、ohpm、Git 共 10 个组件，输出环境健康度评分。

Path to the HarmonyOS project

Generate fix suggestion for a build error

Build error object

Path to the HarmonyOS project

Generate multi-channel packaging config for HarmonyOS. Creates Product + buildMode configuration with per-channel bundle names, signing configs, and obfuscation rules. Supports channel-specific builds.

Channel names (default: huawei, xiaomi, oppo, vivo, default)

Path to the HarmonyOS project

Generate multi-module packaging config for HarmonyOS. Creates build-profile.json5 with entry, feature, and library modules. Supports phone/tablet/2in1 device types, delivery with install, and installation-free feature modules.

Module names (default: entry, feature, library)

Path to the HarmonyOS project

Parse build output into structured errors

Raw build output text to parse

Run Hvigor build

Path to the HarmonyOS project

Specific Hvigor task to run

Search docs for error resolution

Error code to search for

Error message to search for

Audit licenses of project dependencies and flag risky licenses (GPL, AGPL, unknown, etc.)

List of dependency names to audit (alternative to projectPath)

Path to the project root directory (scans build files)

Check for known vulnerabilities (CVEs) in project dependencies

List of dependency names to check (alternative to projectPath)

Find HarmonyOS equivalent replacements for a dependency with confidence scores

Name of the dependency to find replacements for

Source platform: android, ios, flutter, react-native

Resolve whether a specific dependency is compatible with HarmonyOS and get migration guidance

Name of the dependency to resolve

Current version of the dependency

Scan project dependencies from build files (build.gradle, Podfile, pubspec.yaml, package.json, etc.) and return migration status

Framework hint: android, ios, flutter, react-native

Path to the project root directory

Search for packages in OHPM (HarmonyOS OpenHarmony Package Manager) knowledge base

Filter by category (e.g. '网络', '图像', '数据存储', '图表', '安全')

Search query - package name, keyword, or equivalent name from other platforms

Add a custom device configuration to the device matrix. Validate device specs and add to the testing matrix.

Device description

Screen DPI

Font scale factor

Screen height in vp

Locale code

Device name

Default orientation

Theme

Device type

PHONE TABLET FOLDABLE WEARABLE LARGE_SCREEN CAR TV

Screen width in vp

name type width height dpi orientation theme

Analyze hardware access capabilities in the project. Checks camera, bluetooth, NFC, gyroscope, GPS hardware support, SysCap detection, and provides degradation suggestions for unsupported hardware.

Path to the HarmonyOS project

Optional target device types to filter compatibility analysis

Analyze interaction methods supported by the project. Checks touch, mouse, keyboard, stylus, and remote control adaptation. Reports focus navigation issues, keyboard shortcuts, and interaction method adaptation scores.

Path to the HarmonyOS project

截取设备屏幕截图

目标设备 ID

截图保存路径，不指定则使用默认路径

清除设备上应用的数据

应用包名

目标设备 ID

收集设备 HiLog 输出

目标设备 ID

日志级别过滤（D/I/W/E/F）

HiLog 标签过滤

收集设备系统日志

目标设备 ID

获取的日志行数，默认 200

日志标签过滤

Create a device matrix for multi-device testing. Generates a matrix of device configurations covering Phone, Tablet, Foldable, Wearable, and Large Screen with Portrait/Landscape orientations, Light/Dark themes, font scales, and locales.

Name for the device matrix

获取设备信息（OS 版本、屏幕尺寸等）

目标设备 ID

在设备上输入文本

目标设备 ID

要输入的文本

在设备上安装 HAP 包

目标设备 ID

HAP 文件路径

在设备上启动应用

应用包名

目标设备 ID

列出所有已连接/可用的设备和模拟器

重启设备上的应用

应用包名

目标设备 ID

Run tests across all devices in a device matrix. Tests each device configuration and reports issues specific to each device type (foldable gaps, wearable truncation, dark theme contrast, etc.).

ID of the device matrix to test against

Path to the HarmonyOS project

Optional specific test name to run

启动一个 HarmonyOS 模拟器

模拟器设备名称，不指定则使用默认模拟器

停止设备上的应用

应用包名

目标设备 ID

停止一个模拟器

模拟器设备 ID

在设备屏幕上执行滑动手势

目标设备 ID

滑动持续时间（毫秒），默认 300

结束 X 坐标

结束 Y 坐标

起始 X 坐标

起始 Y 坐标

在设备屏幕上点击指定坐标

目标设备 ID

X 坐标

Y 坐标

Check if an API is compatible with the current project's SDK version

The name of the HarmonyOS API to check compatibility for

The project's SDK version (e.g., 'API 9', 'API 10', 'API 11')

Get version information for a specific API including introduced in, deprecated in, removed in, and current SDK compatibility

The name of the HarmonyOS API to check version info for

Get full API details including name, signature, description, parameters, return value, minimum SDK, deprecation status, related APIs, and code examples

The exact name of the HarmonyOS API to look up (e.g., 'http.createHttp', 'router.pushUrl', 'Text')

获取官方 HarmonyOS 知识库（deveco-mcp 的 harmonyos_knowledge_search）的配置信息和使用说明

Search for best practices and patterns (e.g., navigation, state management, network request, permission, lifecycle, image loading, list performance)

Maximum number of results to return (default: 10)

Search query for best practices (e.g., 'navigation', 'state management', 'network request', 'permission')

Search HarmonyOS documentation with query and optional filters

Filter by API category (e.g., ArkUI, Network, Storage, Media, Router, Permission, Lifecycle, etc.)

Search query for HarmonyOS documentation

Filter by minimum SDK version (e.g., API 9, API 10)

搜索 HarmonyOS 知识库（本地 + 云端双路）。本地返回内置 API 文档和最佳实践，同时提示可调用官方 deveco-mcp 的 harmonyos_knowledge_search 获取最新云端文档

最大返回结果数（默认10）

搜索关键词（API名称、组件名、模块名等）

直接调用华为云端 HarmonyOS 知识库搜索。支持搜索API参考、开发指南、最佳实践、常见问题和版本变更说明。结果来自华为官方实时文档。

搜索关键词列表

最大返回字符数（默认10000）

ArkTS 语法检查器。扫描项目中的 ArkTS 文件，检查语法错误、类型错误、装饰器使用规范、性能警告。支持自动修复（autoFix=true）。检测 ETS1001-ETS1004 等常见错误码。

Auto-fix detected errors (default: false)

Path to the HarmonyOS project

Check for deprecated API usage in the project. Identifies deprecated APIs, provides replacement alternatives, migration code examples, and severity classification. Covers @system.router → @ohos.router, @system.storage → @ohos.data.preferences, @system.fetch → @ohos.net.http, and more.

Path to the HarmonyOS project

Target SDK version (e.g. 'API 12'), defaults to 'API 12'

全面代码质量检查。扫描架构、代码质量、Lint、废弃API、API兼容性、依赖、权限、安全、并发、生命周期、内存、资源、性能、无障碍、国际化共15个维度，返回 CodeDoctorResult 包含问题列表、分类统计、自动修复建议。

要检查的维度列表，不传则检查全部 15 个维度

ARCHITECTURE CODE_QUALITY LINT DEPRECATED_API API_COMPATIBILITY DEPENDENCY PERMISSION SECURITY CONCURRENCY LIFECYCLE MEMORY RESOURCE PERFORMANCE ACCESSIBILITY I18N

HarmonyOS 项目路径

项目健康评分。从 Architecture、Correctness、Performance、Security、Compatibility、Maintainability 六个维度评估项目健康度，给出 A-F 评级和改进计划。

HarmonyOS 项目路径

Retrieve accumulated migration knowledge

Maximum number of entries to return

Search query for matching knowledge entries

Filter by source framework

Filter by target framework

Manage custom migration recipes (list, add, remove, execute)

Action to perform on recipes

Description of the recipe

Recipe name

Source code pattern for the recipe

Target HarmonyOS code for the recipe

Manage private SDK capability mappings (list, add, remove, search)

Action to perform on capability graph

Description of the capability mapping

Source SDK API name

Target HarmonyOS SDK API name

Manage team roles and permissions (list, add, remove, update)

Action to perform on roles

List of permissions for the role

Role name (e.g. Developer, Reviewer, QA, TechLead, Admin, Security, ReleaseManager)

User ID to assign the role to

Manage enterprise rule packs (list, add, remove, check)

Action to perform on rules

Path to the HarmonyOS project

JSON configuration for the rule

Type of rule

Query audit log entries for a project

Filter by action type

Filter from this date (ISO 8601)

Maximum number of entries to return

Path to the HarmonyOS project

Filter to this date (ISO 8601)

Filter by user ID

Record migration knowledge from completed projects

JSON array of failed API mappings

JSON array of issues encountered

Additional notes about the migration

Path to the project

Source framework name

JSON array of successful API mappings

Target HarmonyOS framework

检查指定 Kit 需要的权限，返回权限列表、权限级别、module.json5 配置示例、声明指南。

具体功能，如 '推送通知'、'GPS 定位'

Kit 名称，如 'Push Kit'、'Location Kit'、'Scan Kit'、'Network Kit'

根据需求描述，生成完整的 Kit 调用代码（导入、初始化、调用、错误处理）。支持 Push Kit、Account Kit、Network Kit、Location Kit、Scan Kit、Share Kit、IAP Kit 等。

Kit 名称，如 'Push Kit'、'Account Kit'、'Network Kit'

使用场景描述，如 '获取推送 Token 并显示消息列表'

目标 SDK 版本，默认 API 12

列出所有 25 个 HarmonyOS SDK Kit 的完整信息，包括名称、功能领域、核心 API、使用场景、SDK 版本。

在 25 个 HarmonyOS SDK Kit 中搜索 API。返回导入路径、函数签名、参数列表、返回值、错误码、权限要求、代码示例。支持按 Kit 名称和功能分类过滤。

功能分类，如 '应用服务'、'网络通信'、'安全认证'

限定 Kit 名称，如 'Push Kit'、'Network Kit'

搜索关键词（API 名称、Kit 名称、功能描述）

Analyze impact of source changes on target HarmonyOS project - checks file/symbol mappings to determine what needs to be synced

Git commit hash of the source change

Absolute path to the source project root

Absolute path to the target HarmonyOS project root

Full migration assessment report - analyzes source project and generates a comprehensive migration feasibility report

Path to the source project to assess

后端迁移助手。分析迁移对后端服务的影响，输出完整的 Mobile/Backend/Console/Secrets/Deployment 变更清单。同时提供跨仓库协调方案（Android Repo + Harmony Repo + Backend Repo），包括受影响仓库、建议分支和团队协调计划。

源平台类型，默认 android

Path to the source project

Path to the HarmonyOS target project

Configure cross-platform sync settings - set up auto-sync, auto-test, auto-PR, watch branches, and ignore patterns

Automatically create PRs after syncing

Automatically sync changes without manual confirmation

Automatically run tests after syncing

Enable or disable cross-platform sync

File patterns to ignore during sync

Path to the HarmonyOS project root

Path to the target project (for config storage)

Git branches to watch for changes

Convert a named feature/feature-set - identifies and migrates all files related to a specific business feature

Name of the feature to convert (e.g., "login", "payment", "profile")

Path to the source project root

Source platform (android, ios, flutter, react-native, uni-app, etc.)

Convert a single source file to HarmonyOS ArkTS/ArkUI - performs syntax, API, and pattern migration on one file

Absolute path to the source file to convert

Absolute path where the converted file should be written

Convert an entire module/directory - recursively converts all files in a module from source platform to HarmonyOS

Absolute path to the source module directory

Absolute path where the converted module should be written

Full project conversion - converts an entire source project to a HarmonyOS project in one operation

Absolute path to the source project root

Absolute path where the HarmonyOS project should be created

Create Migration IR from source project - generates an intermediate representation of the source project for migration processing

Path to the source project

Create detailed migration plan - generates a step-by-step migration plan with task breakdown, dependencies, and estimates

Path to the source project to create a migration plan for

Detect recent changes in source repository - scans git commits to find added, modified, and deleted files for cross-platform sync

Maximum number of commits to scan

Git commit hash or ref to start scanning from (default: HEAD~10)

Absolute path to the source repository root

Execute full cross-platform sync workflow - detect changes, analyze impact, generate patches, and optionally apply, test, and create PRs

Automatically apply generated patches

Automatically create a pull request

Automatically run tests after applying patches

Dry run mode - analyze but do not apply changes

Git commit hash from which to start detecting changes

Absolute path to the target HarmonyOS project root

Generate HarmonyOS Continuation task migration code. Enables cross-device task handoff: save app state, discover nearby devices, transfer tasks phone↔tablet↔pad, and restore state on target device.

Path to the HarmonyOS project

Generate HarmonyOS patches from source changes - creates code patches that can be applied to the target project

Git commit hash of the source change

Generate HarmonyOS distributed KVStore sync code. Features: distributed read/write, batch operations, type-safe access (getString/getNumber/getBoolean/getObject), auto-sync with configurable interval, data change listener, encrypted storage (S2 security level).

Path to the HarmonyOS project

Generate a mock server configuration from API contracts or network code. Creates mock endpoints with realistic response data for testing HarmonyOS apps when backend is unavailable.

Output path for the mock server config file

Path to the HarmonyOS project

Generate HarmonyOS network client code (@ohos.net.http wrapper). Includes interceptors, retry with exponential backoff, in-memory cache with TTL, timeout control, and unified error handling.

Path to the HarmonyOS project

Source platform (android, ios, flutter, react-native, etc.)

Generate HarmonyOS network state change listener code. Detects WiFi/cellular/ethernet/VPN/offline states, monitors signal strength, identifies 5G/4G/3G/2G cellular types, and checks metered network status.

Path to the HarmonyOS project

Generate HarmonyOS Tap-to-Share (碰一碰) code. Features: NFC tap sharing, multi-device transfer (phone↔tablet↔PC), multiple content types (TEXT/URL/IMAGE/FILE/CONTACT/APP_LINK), nearby device discovery, share history.

Path to the HarmonyOS project

Generate HarmonyOS WebSocket connection management code. Features: auto-reconnect with exponential backoff, heartbeat keep-alive, offline message queue, connection state machine, event listeners.

Path to the HarmonyOS project

Map a source API to its HarmonyOS equivalent - looks up the capability mapping database for the best match

The source API to map (e.g., "android.app.Activity", "UIView", "Navigator.push")

Source platform (android, ios, flutter, react-native, uni-app, etc.)

Migrate authentication methods from source project to HarmonyOS. Detects OAuth, JWT, SSO, Enterprise Login, SMS, Password, and Biometric. Maps to HarmonyOS account APIs and security frameworks.

Path to the source project

Path to the HarmonyOS target project

Migrate databases from source project to HarmonyOS. Detects SQLite, Room, CoreData, Realm, Hive, AsyncStorage, IndexedDB, SharedPreferences, and UserDefaults. Generates schema migration scripts and data compatibility reports.

Path to the source project

Path to the HarmonyOS target project

Migrate deep links and push notifications from source project to HarmonyOS. Handles URL Scheme, Universal Link, App Link, Push Link, Share Link. Migrates FCM/APNs to HarmonyOS Push Kit with token, topic, payload, foreground/background, and server integration.

Path to the source project

Path to the HarmonyOS target project

Analyze and migrate native code (JNI, NDK, SO, C, C++, Rust, FFI) and binary SDKs (AAR, SO, Framework). Classifies into Reusable, Port Required, Platform-Specific, Binary Only, and Unsupported categories.

Path to the source project

Path to the HarmonyOS target project

Migrate network layer from source project to HarmonyOS. Detects Retrofit, OkHttp, Alamofire, Axios, Dio, and Fetch. Maps to @ohos.net.http with features: request, interceptor, auth, retry, cache, upload, download, WebSocket.

Path to the source project

Path to the HarmonyOS target project

Migrate resources from source project to HarmonyOS. Handles images, SVG, fonts, strings, colors, animations, audio, video, JSON, and raw resources. Supports optimization, duplicate detection, unused detection, and snake_case renaming.

Detect duplicate resources by name

Detect unused resources not referenced in code

Enable image optimization suggestions

Rename resources from camelCase to snake_case

Path to the source project

Path to the HarmonyOS target project

Migrate WebView usage from source project to HarmonyOS. Analyzes 9 key features: JS Bridge, Cookie, Login, Deep Link, File Upload, Download, Camera, Location, Payment. Detects common Hybrid App feature gaps.

Path to the source project

Path to the HarmonyOS target project

Analyze image files in a project and suggest optimizations. Detects large images (>500KB by default), suggests resize dimensions, format conversion (PNG/JPG→WebP), and estimates compression ratio.

Path to the project to scan for images

Size threshold in KB for optimization suggestions

Sync incremental changes from source to target - detects and migrates only the files that have changed since a given commit

Git commit hash or ref to diff from (default: HEAD~1)

Absolute path to the source project root

Absolute path to the target HarmonyOS project root

Validate API contracts (OpenAPI, Swagger, GraphQL, Proto) and generate HarmonyOS client code. Detects contract files, extracts endpoints/schemas, generates client code and model classes.

Path to a specific API contract file (optional)

Path to the source project

检查操作是否需要审批。根据风险级别判断：SAFE 自动执行、WRITE 需项目授权、HIGH_RISK 必须人工确认。

操作名称

HarmonyOS 项目路径

操作风险级别

幂等性检查。检查工具的幂等性，避免重复执行导致重复添加依赖、文件、路由、配置。

HarmonyOS 项目路径

工具名称（可选，不传则检查所有）

PR Gate 检查。自动执行 Build/Lint/Test/Security/Performance/Compatibility 六项检查，失败阻止合并。

PR ID

HarmonyOS 项目路径

可靠性检查。验证工具返回格式统一性、空结果保护、错误处理、超时保护、幂等性。

HarmonyOS 项目路径

静默重写检查。检查 Agent 是否在用户不知情的情况下：删除业务逻辑、改变接口签名、改变数据结构、改变安全逻辑。

补丁 ID

HarmonyOS 项目路径

配置审批门规则。设置 SAFE/WRITE/HIGH_RISK 三级审批策略，控制 Agent 的操作权限。

自定义审批规则（不传则使用默认规则）

规则描述

操作示例

自动执行最大次数

操作名称

是否需要审批

风险级别

是否启用审批门，默认 true

HarmonyOS 项目路径

配置持续同步。设置 Android → HarmonyOS 自动增量同步，支持定时检测、自动 PR、自动合并。

是否启用，默认 true

HarmonyOS 项目路径

源仓库地址

目标仓库地址

配置 Plugin 生命周期 Hooks。支持 POST_TOOL_USE、POST_BUILD、PRE_HIGH_RISK、SESSION_START、SESSION_END、FILE_CHANGED 六种触发时机。

自定义 Hooks（不传则使用默认配置）

HarmonyOS 项目路径

创建多 Agent 迁移团队。组建 Planner/Migration/UI/API/Dependency/Build/Test/Performance/Reviewer/Verification 共 10 个专业 Agent，自动分配迁移任务。

HarmonyOS 项目路径

创建 Git 检查点。在大规模修改前创建安全回滚点，失败时可一键回滚。

检查点描述信息

HarmonyOS 项目路径

关联的任务 ID

创建独立补丁。每个迁移任务生成独立 Patch，便于审查和按需回滚。

新增行数

删除行数

补丁描述

变更的文件列表

HarmonyOS 项目路径

关联的任务 ID

补丁标题

taskId title description filesChanged additions deletions projectPath

创建 Pull Request。自动生成 PR 描述（包含变更内容、原因、风险、测试、截图），便于人工 Review。

目标分支，默认 main

PR 描述

变更文件列表

HarmonyOS 项目路径

PR 标题

迁移成本估算。基于文件数量估算 Agent 调用成本（Token 消耗），便于企业设置预算。

文件数量，默认 500

HarmonyOS 项目路径

解释变更原因。说明 Agent 为什么做了某个变更，包括源行为、目标能力、变更理由、证据、风险、置信度。

补丁 ID

任务 ID

列出所有检查点。查看项目历史回滚点。

HarmonyOS 项目路径

列出所有配置的 Hooks。

HarmonyOS 项目路径

列出所有补丁。按任务 ID 筛选或查看全部。

HarmonyOS 项目路径

任务 ID（可选，不传则列出所有）

离线能力检查。检查哪些功能支持离线运行（Build/Lint/Migration Rules/Local Docs/Test/Trace）。

HarmonyOS 项目路径

Planner Agent 任务规划。将项目拆解为独立可执行的迁移任务，按依赖关系排序，预估工作量和风险。

HarmonyOS 项目路径

Reviewer Agent 独立审查。审查迁移代码质量和架构合理性，发现潜在问题。

HarmonyOS 项目路径

任务 ID（可选，不传则审查所有变更）

审查补丁。批准或拒绝变更补丁。

是否批准

审查意见

补丁 ID

回滚到指定检查点。恢复项目到变更前的状态，避免不可逆损坏。

检查点 ID

HarmonyOS 项目路径

触发持续同步。立即执行一次 Android → HarmonyOS 增量同步，检测变更、生成补丁、应用补丁。

HarmonyOS 项目路径

手动触发 Hook。用于测试和调试 Hook 配置。

上下文数据

HarmonyOS 项目路径

触发时机

Verification Agent 独立验证。检查迁移任务的完成质量，验证功能完整性，发现遗漏。

HarmonyOS 项目路径

任务 ID

版本锁定。记录当前 Plugin、引擎、SDK 版本，确保迁移可复现。

HarmonyOS 项目路径

API 故障分析。输入 API 错误码或错误日志，查询知识库，返回错误原因和解决方案。支持常见错误码如 801、B0001 等。

错误码，如 '801'、'B0001'

错误信息

出错的模块名

Analyze crash logs with symbolication and source mapping. Parses crash logs, symbolicates stack traces against debug symbols, maps to source code locations, and provides root cause analysis with fix suggestions.

Optional: crash log content as a string

Optional: path to a crash log file

应用冻屏分析。输入冻屏日志，分析主线程阻塞原因，定位卡死代码位置。输出冻屏时间线、阻塞线程、卡死代码、修复建议。

应用包名，用于过滤日志

hilog/faultlog 日志文件路径

Log intelligence analysis. Analyzes logs from various sources (BUILD/RUNTIME/DEVICE/APP/NETWORK/CRASH/HILOG), detects errors, warnings, performance issues, and provides structured insights with severity classification.

Optional: log content as a string. If not provided, logs will be collected from the project.

Optional: type of logs to analyze

BUILD RUNTIME DEVICE APP NETWORK CRASH HILOG

Path to the HarmonyOS project

Analyze an existing trace file. Takes a trace file path, parses it, and returns detailed TraceAnalysis including frame analysis, function hotspots, and memory leak detection.

Absolute path to the trace file (.trace, .perf, .json)

Capture performance trace. Scans for trace files (.trace, .perf, .json) in the project, returns TraceAnalysis with hotspot detection, long task analysis, and jank rate calculation.

Optional: trace duration in milliseconds

Path to the HarmonyOS project

Check current performance measurements against defined budgets. Reports pass/fail/warn status for each metric with deviation calculations. If any BLOCKING budget fails, overall status is FAIL.

Optional: specific budget ID to check against

Path to the HarmonyOS project

Compare performance between source and target projects. Returns PerformanceComparison with deltas, improvements, and regressions.

Optional: specific metrics to compare (startupTime, firstFrameTime, avgFPS, jankRate, memoryUsage, peakMemory, cpuUsage, apkSize, coldStartTime, warmStartTime, gcTime, batteryDrain)

Path to the source project (Android/iOS/Flutter/RN/etc.)

Path to the HarmonyOS target project

Create a performance budget with thresholds for key metrics. Defines budgets for cold start, FPS, frame timing, memory, CPU, and APK size. Supports custom budgets and severity levels (BLOCKING/WARNING/INFO).

Optional custom budget items to add or override defaults

metric threshold unit operator severity description

Project name for the budget

内存泄漏检测。输入 heap snapshot 或 rawheap 文件，分析内存对象，识别泄漏对象和引用链。支持 JS 堆泄漏和 Native 内存泄漏。

.heapsnapshot 或 .rawheap 文件路径

泄漏类型，默认 auto

Detect performance regression between versions. Compares performance snapshots of two versions, identifies regressed/improved/unchanged metrics, and finds suspect commits using git bisect. Detects cold start, FPS, frame timing, memory, CPU, and APK size regressions.

Baseline version to compare against (e.g., 'v1.2.0')

Current version to check (e.g., 'v1.3.0')

Path to the HarmonyOS project

崩溃日志一键诊断。输入崩溃日志（jscrash/faultlog/hilog），自动识别崩溃类型（JS/C++/Freeze），解析堆栈，定位源代码，输出根因和修复建议。支持 JS 崩溃、C++ 崩溃、ANR 冻屏。

崩溃日志文件路径

日志类型，默认 auto 自动识别

Generate CMakeLists.txt config for HarmonyOS native development. Includes C++17 standard, Release/Debug optimization, security flags, platform detection, EGL/GLES/NAPI/HiLog library linking, and optional third-party integration (OpenCV/TFLite/FFmpeg).

Path to the HarmonyOS project

Generate ArkTS NAPI binding code from C++ header. Creates NapiBridge singleton with type-safe interface, ArrayBuffer data transfer, callback registration, and thread-safe function support. Includes both ArkTS wrapper and C++ napi_init.cpp template.

Path to the C++ header file to generate bindings for

Git bisect for performance regression. Binary searches through git history to find the commit that introduced a performance regression. Requires a test command that returns exit code 0 for good performance and non-zero for bad performance.

Commit hash known to have bad performance

Commit hash known to have good performance

Path to the HarmonyOS project

Optional: custom test command to evaluate performance. Defaults to a built-in performance test.

Map trace symbols to source code. Maps performance trace hotspots to exact source files, functions, and line numbers. Integrates git blame to find the commit that introduced the performance issue. Essential for Trace → Source debugging.

Path to the HarmonyOS project

Optional: path to a specific trace file to analyze

Generate native code debugging guide and performance analysis tips. Covers LLDB debugging, crash analysis (SIGSEGV/SIGABRT/SIGBUS), memory debugging with ASan, CPU profiling, multi-thread debugging, and common pitfalls. Includes tool references and command examples.

Type of native debugging issue (e.g., crash, memory_leak, performance, thread_deadlock)

低端机内存分档优化。采集内存数据 → 分析瓶颈 → 生成分档方案 → 生成优化代码 → 验证。提供完整的内存优化闭环。

内存上限（MB）

项目路径

目标低端机型号

Profile CPU usage. Returns CPUProfile with average/peak usage, thread analysis, top threads by CPU.

Path to the HarmonyOS project

Profile memory usage. Returns MemoryProfile with heap analysis, GC statistics, and memory leak suspicions.

Path to the HarmonyOS project

Profile app startup performance. Returns StartupProfile with cold/warm start times, phase breakdown (processCreate, appInit, abilityCreate, firstFrame, fullyDrawn).

Path to the HarmonyOS project

Profile UI rendering performance. Analyzes FPS, jank, frame timing, layout/draw overhead.

Path to the HarmonyOS project

Analyze project architecture patterns

Path to the project root directory

Build static call graph

Path to the project root directory

Auto-detect project framework type

Path to the project root directory

Estimate project size (files, lines, modules)

Path to the project root directory

Extract business capabilities

Path to the project root directory

Deep analysis of project structure, returns ProjectDNA

Path to the project root directory

Scan directory tree structure

Maximum depth to scan

Path to the project root directory

应用元数据审计。检查应用名称、图标、截图、描述、隐私政策、版本号、内容分级、应用分类、开发者信息等上架元数据的合规性。

HarmonyOS 项目路径

无障碍检查。扫描 Accessibility Label、对比度、触控区域、屏幕阅读器支持、字体缩放、焦点顺序、键盘导航、语义化，返回 AccessibilityCheck 结果和 WCAG 合规等级。

HarmonyOS 项目路径

检查 AppGallery Connect 上架要求。验证华为应用市场发布要求：应用大小限制、权限声明、隐私政策、内容分级、截图、描述。返回 AppGalleryRequirement[] 数组。

HarmonyOS 项目路径

国际化检查。扫描硬编码字符串、Locale 支持、日期/货币格式、RTL 布局、复数规则、文本溢出、编码问题，返回 InternationalizationCheck 结果。

HarmonyOS 项目路径

检查项目是否准备好发布。运行所有发布检查：签名、版本、权限、隐私、包大小、兼容性、商店合规、测试覆盖、安全。返回 ReleaseCheckItem[] 数组。

HarmonyOS 项目路径

从 Git 历史生成变更日志。分析提交记录生成结构化的发布说明。

起始 Git 引用（如 tag、branch、commit hash），默认 HEAD~20

HarmonyOS 项目路径（Git 仓库）

结束 Git 引用，默认 HEAD

生成综合发布报告。汇总所有检查结果并生成 ReleaseReport，包含整体发布就绪评估。

HarmonyOS 项目路径

生成 HarmonyOS 签名配置。支持三种签名模式：自动签名 (auto_debug，调试)、手动签名 (manual_release，发布)、企业签名 (enterprise，内部分发)。使用 SHA256withECDSA 算法，.p12 密钥库 + .p7b Profile。

HarmonyOS 项目路径

验证应用签名。检查密钥库、证书有效期、签名算法、调试 vs 发布模式。返回 SigningInfo。

HarmonyOS 项目路径

Comprehensive encryption audit covering transport encryption (HTTPS/TLS/WebSocket), storage encryption (files/Preferences/database), and key management (HUKS/hardcoded keys/rotation). Returns score and prioritized recommendations.

Path to the HarmonyOS project

Audit privacy compliance. Checks for personal data collection (phone, email, location, biometrics, etc.), data encryption, privacy policy references, and user consent mechanisms. Returns privacy audit with overall score.

Path to the HarmonyOS project

Enhanced privacy compliance audit with AppGallery requirements checklist. Includes user data collection declaration, third-party SDK privacy risk assessment, data retention policies, and actionable fixes.

Path to the HarmonyOS project

Supply chain security audit: checks package trust, maintenance status, license compliance, known vulnerabilities, and typosquatting risks for all dependencies.

Path to the HarmonyOS project

Check whether a specific data type/category can be sent to cloud based on configured data boundary rules.

Category of the data to check

DOCS PACKAGE_META MAPPING SOURCE LOGS CUSTOMER_DATA CREDENTIALS

The data type to check

Path to the HarmonyOS project

Verify encryption algorithm usage. Identifies weak algorithms (MD5, DES, RC4, SHA-1, ECB mode), checks for hardcoded keys, static IVs, and weak random generators. Also audits Huks key management. Returns encryption audit with score.

Path to the HarmonyOS project

Configure data boundary rules for local-only mode. Define which types of data can or cannot be sent to cloud services, with enforcement levels (STRICT/WARN/AUDIT).

Data types explicitly allowed to cloud

Data types explicitly denied to cloud

Enforcement level: STRICT (block), WARN (warn), AUDIT (log only)

Enable local-only data boundary mode

Path to the HarmonyOS project

Generate a Software Bill of Materials (SBOM). Scans dependencies from oh-package.json5 and package.json, includes license information, known vulnerabilities, and supplier details. Supports CycloneDX and SPDX formats.

SBOM output format (default: CycloneDX)

Include devDependencies (default: true)

Path to the HarmonyOS project

Scan project dependencies against CVE database for known vulnerabilities. Also performs OWASP Mobile Top 10 security checks. Returns CVE entries with CVSS scores, severity, and fix versions.

Path to the HarmonyOS project

Audit permissions declared in module.json5 against actual usage in code. Identifies unused permissions, missing declarations, and high-risk permissions. Returns a PermissionAudit with score and recommendations.

Path to the HarmonyOS project

Scan source code for hardcoded secrets including API keys, passwords, tokens, private keys, and certificates. Returns a SecretScanResult with location, pattern, and masked value of each finding.

Glob patterns to exclude from scanning

Path to the HarmonyOS project

General security vulnerability scan. Checks for insecure HTTP, cleartext traffic, debug mode, WebView risks, SQL injection, command injection, XSS, and more. Returns SecurityScanResult[] with findings and CWE references.

Filter by specific security categories

SECRET PERMISSION VULNERABILITY PRIVACY ENCRYPTION NETWORK STORAGE

Path to the HarmonyOS project

Analyze test run results to identify failure patterns, flaky tests, slow tests, and provide actionable recommendations.

Test run result object from run_unit_test, run_ui_test, or run_regression_test

id name type status duration filePath tags

name totalCases passedCases failedCases skippedCases duration cases

totalCases totalPassed totalFailed totalSkipped passRate summary suites

Compare test coverage between source project and HarmonyOS target project. Identifies coverage gaps and missing tests.

Path to the source project (Android/iOS/Flutter/RN/etc.)

Optional: source project test run result

Path to the HarmonyOS target project

Optional: target project test run result

Generate unit and UI test cases for HarmonyOS project. Auto-detects target files and produces ArkTS test templates with @ohos/hypium and @ohos.UiTest frameworks.

Whether to include setup/teardown code

Path to the HarmonyOS project

Optional: specific files to generate tests for. If empty, auto-discovers source files.

Type of tests to generate

Generate a comprehensive test report with coverage estimation, pass rate analysis, and improvement recommendations.

Path to the HarmonyOS project

Test run result from run_unit_test, run_ui_test, or run_regression_test

运行插桩测试。在真机/模拟器上执行插桩测试，支持 ASan 内存检测，返回测试结果、覆盖率和 ASan 报告。

是否启用 ASan 内存检测，默认关闭

HarmonyOS 项目路径

运行本地测试。在本地环境中执行单元测试和 UI 测试，返回测试结果、覆盖率报告和失败用例详情。

可选：指定模块名称，为空则使用项目名

HarmonyOS 项目路径

Execute regression tests to verify migration doesn't break existing functionality. Supports baseline comparison.

Optional: path to previous test result JSON for baseline comparison

Path to the HarmonyOS project

Execute UI tests in HarmonyOS project. Detects and runs @ohos.UiTest based UI test suites.

Path to the HarmonyOS project

Scan and execute unit tests in HarmonyOS project. Detects test files and runs hypium-based unit tests.

Path to the HarmonyOS project

Calculate quantitative UI similarity scores between source and HarmonyOS target projects across multiple dimensions (layout, color, typography, spacing, components).

Specific dimensions to compare

layout color typography spacing components

Path to the source project

Path to the HarmonyOS target project

Check API usage in HarmonyOS project for validity, deprecation, and correctness. Detects invalid @ohos imports and deprecated @system APIs.

Path to the HarmonyOS project

Build and compare static call graphs between source and HarmonyOS target projects. Analyzes class/function coverage and call relationships.

Path to the source project

Path to the HarmonyOS target project

Compare screenshots between source and HarmonyOS target builds. Detects visual differences in layout, color, typography, and spacing.

Directory containing source project screenshots

Directory containing HarmonyOS target project screenshots

Validate network behavior between source and target projects. Compares HTTP requests, headers, bodies, endpoints, and responses to detect missing headers, wrong parameters, and mismatched URLs.

Path to the source project's network log file (JSON array of NetworkRequest)

Path to the HarmonyOS target project's network log file (JSON array of NetworkRequest)

Validate that state management has not regressed after migration. Checks 12 state categories including auth, cache, cart, favorites, drafts, playback, settings, form data, session, preferences, notifications, and local data.

Path to the source project root

Path to the HarmonyOS target project root

Validate UI component migration completeness between source and HarmonyOS target projects. Checks screen/component/page coverage.

Source framework hint: android, ios, flutter, react-native, uniapp, etc.

Path to the source project

Path to the HarmonyOS target project

Verify HarmonyOS build output integrity. Checks for HAP/HSP/APP artifacts, build directories, and build configuration files.

Optional: specific build output directory path

Path to the HarmonyOS project

Compare source project features against HarmonyOS target project to detect missing capabilities. Returns feature parity report with matched/missing/partial statistics.

Path to the source project (Android/iOS/Flutter/RN/etc.)

Path to the HarmonyOS target project

Deeply analyze ArkTS/ArkUI code for adaptive UI issues. Detects 13 types of responsiveness problems: fixed widths/heights, overflow, landscape anomalies, foldable gaps, overlap, truncation, hardcoded dp, missing breakpoints, missing scroll, missing safe area, unresponsive images, and rigid layouts.

Path to the HarmonyOS project

Filter by target device types

Filter by target orientations

Check responsive layout across different device sizes. Analyzes layout adaptability, breakpoints, flexible units, and provides recommendations.

Optional: custom device sizes to check against

Path to the HarmonyOS project

Compare two behavior recordings (source vs target). Returns BehaviorComparison with matched/mismatched steps and similarity score.

The source platform behavior recording

TAP SWIPE TYPE LONG_PRESS SCROLL WAIT ASSERT NAVIGATE

id name platform steps duration timestamp

The HarmonyOS target platform behavior recording

Compare a single source screenshot against a HarmonyOS target screenshot. Detects visual differences in layout, color, typography, and spacing.

Path to the source project screenshot file

Path to the HarmonyOS target project screenshot file

Generate complete ArkUI page code from a design analysis result. Supports both screenshot-based and Figma-based designs. Generates @Component struct with proper @State, layouts, styles, and imports.

Name for the generated page

Path to the design file

Type of ArkUI component to generate

Theme for the generated page

Design input type

Convert a design specification to ArkUI visual code. Generates complete ArkUI page code with CSS token mapping, layout configuration, and component tree. Includes mock data demonstrating a login page design conversion with proper color tokens, typography, spacing, and shadow mappings.

List of expected UI components in the design

Design specification description (e.g. 'login page', 'home page with tabs')

Detect layout differences between source and HarmonyOS target projects. Scans file structure to estimate layout differences in position, size, margins, padding, alignment, and visibility.

Path to the source project

Path to the HarmonyOS target project

Record user behavior flow with steps (TAP, SWIPE, TYPE, SCROLL, etc.). Creates a BehaviorRecording that can be replayed or compared against target.

Name of the behavior recording

Platform identifier (e.g. 'android', 'ios', 'harmonyos')

Array of behavior steps to record

Replay a recorded behavior flow against a HarmonyOS target project. Takes a BehaviorRecording and simulates replay, returning pass/fail results for each step.

The behavior recording to replay

Path to the HarmonyOS target project

Analyze a screenshot (Android app, Figma design, or mockup) and generate ArkUI code. Detects UI elements, layouts, colors, and fonts, then generates complete HarmonyOS page code.

Name for the generated page (e.g., 'LoginPage', 'HomePage')

Path to the screenshot file (PNG, JPG, WebP)

Validate design tokens migration between source and HarmonyOS target projects. Detects color, typography, spacing, radius, and shadow tokens from source and compares with target.

Path to the source project

Path to the HarmonyOS target project