Found API Docs

/found/get_version

Basic Information

Path： /found/get_version

Method： GET

Interface Description：

Get Found's version number

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other

Return Data

Name	Type	Required	Default Value	Remarks	Other
	string	Optional

/found/log

Basic Information

Path： /found/log

Method： POST

Interface Description：

Print a message to the log file

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other
message	string	Required

Return Data

Name	Type	Required	Default Value	Remarks	Other
	string	Optional

/found/get_database_path

Basic Information

Path： /found/get_database_path

Method： GET

Interface Description：

Get Found's database directory path, for example "C:/ProgramData/Aalab/Found/database.found"

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other

Return Data

Name	Type	Required	Default Value	Remarks	Other
	string	Optional

/found/alert

Basic Information

Path： /found/alert

Method： POST

Interface Description：

Create an alert in Found

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other
type	string	Required		ok\|error\|empty
message	string	Required

Return Data

Name	Type	Required	Default Value	Remarks	Other
success	boolean	Required
message	string	Required		Invalid Type

/asset/get_uuid

Basic Information

Path： /asset/get_uuid

Method： POST

Interface Description：

Get the UUID of an asset in the database. Initialization is not performed for files that are not recorded in the database..

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other
file	string	Required		Supports UUID and path.

Return Data

Name	Type	Required
success	boolean	Optional
message	string	Optional
data	object	Optional
id	string	Optional

/asset/get_thumbnail

Basic Information

Path： /asset/get_thumbnail

Method： POST

Interface Description：

Get the thumbnail path of an asset. If the file is invalid or the thumbnail does not exist, an empty value is returned.

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other
file	string	Required		Supports UUID and path.

Return Data

Name	Type	Required	Default Value	Remarks	Other
	string	Optional

/asset/set_thumbnail

Basic Information

Path： /asset/set_thumbnail

Method： POST

Interface Description：

If the asset does not exist in the database, the operation fails. When the length of the thumbnail is less than 1000 characters, check if the string represent a valid local image file. If so, treat it as a file and read the thumbnail. Otherwise, attempt to parse it as a base64-encoded image file of the thumbnail. When the thumbnail is in base64 format, ignore the "mode" parameter, and the new thumbnail is not written to the database.

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Remarks
file	string	Required	Supports UUID and path.
thumbnail	string	Required
mode	string	Optional	Valid values: ref\|copy This determines whether to update the database with a path reference to the thumbnail or make a new file copy and place it in the "thumbnails" directory using a UUID as the filename. If the original thumbnail exists in the cache and it is different from the new thumbnail address, the original thumbnail in the cache is deleted. If there is a thumbnail but it does not belong to the cache, no changes are made to the original thumbnail file.

Return Data

Name	Type	Required	Remarks
success	boolean	Required	If the thumbnail does not exist, an error is returned.
message	string	Required	Thumbnail is not available
data	object	Required
thumbnail_path	string	Required

/asset/rename

Basic Information

Path： /asset/rename

Method： POST

Interface Description：

Rename a file (automatically correct all associated asset information in the database, such as notes and collections). If the asset is not recorded in the database, it is equivalent to simply renaming the file.

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other
file	string	Required		The sequence frame number should be "*" or "#", and the number of digits should be the same.
new_filename	string	Required		New file name. If the sequence frame is missing the number, automatically append "_(original number)" before the file extension (if it exists). Otherwise, the number of digits should be equal to or greater than the original number of digits.

Return Data

Name	Type	Required
success	boolean	Required
message	string	Required
data	object	Optional

/asset/get_asset_info

Basic Information

Path： /asset/get_asset_info

Method： POST

Interface Description：

Get the analyzed asset information in JSON format.

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other
file	string	Required		Supports path and UUID. Sequence frames are identified using "" or "####" (strict validation of the number of digits).

Return Data

Name	Type	Required	Remarks
success	boolean	Required
message	string	Required
data	object	Required	Returns the asset information in JSON format.

/asset/get_notes

Basic Information

Path： /asset/get_notes

Method： POST

Interface Description：

Get the notes of an asset. Returns empty when fails.

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other
file	string	Required		Supports path and UUID. Sequence frames are identified using "" or "####" (strict validation of the number of digits).

Return Data

Name	Type	Required	Default Value	Remarks	Other
	string	Optional		notes

/asset/set_notes

Basic Information

Path： /asset/set_notes

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other
file	string	Required		Supports UUID and path.
notes	string	Required

Return Data

Name	Type	Required	Remarks
success	boolean	Required	If the thumbnail does not exist, an error is returned.
message	string	Required	Thumbnail is not available
data	object	Optional

/asset/set_token

Basic Information

Path： /asset/set_token

Method： POST

Interface Description：

Set a token icon. If it doesn't exist, create a new token.
If "related_file" is specified, temporarily hide the file in the browsing area(regardless of whether the file exists or not).
When the "progress" value is negative or exceeds 1(out of valid range):

If "related_file" is not specified, delete the token.
If "related_file" is specified and the path is a regular path, switch the token to the icon of "related_file".
If "related_file" is specified and the path is a collection, switch the token to the icon of "related_file" and trigger "add_asset" to add the "target_file" to the corresponding collection.
When the length of the thumbnail is less than 1000 characters, check if the characters represent a valid local image file. If so, treat it as a file and read the thumbnail. Otherwise, attempt to parse it as a base64-encoded image file for the thumbnail.

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Remarks	Other
path	string	Required	Path to create the token, which can be a folder or collection UUID.
name	string	Required	Token's display name (unique identifier, no duplicate names allowed).
progress	number	Required	Range from 0 to 1, controls the progress. If the value is outside the valid range (negative or greater than 1), the token is deleted or switched to the target file.
progress_bar	boolean	Optional	Display optional progress bar.
thumbnail	string	Optional	Optional base64-encoded thumbnail. If not provided, an empty thumbnail is used.
related_file	string	Optional	Target replacement file. If the "path" parameter points to a folder, this "related_file" should points to a file inside the folder (file's own path can be omitted, only the file's name is required).
PID	number[]	Optional	One or multiple PID (Process ID) to associate with the end task function.	itemType:number

Return Data

Name	Type	Required
success	boolean	Required
message	string	Required
data	object	Required

/collection/add_asset

Basic Information

Path： /collection/add_asset

Method： POST

Interface Description：

Returns the added asset ID (if the file already exists in the database, the corresponding asset is added to the collection directly).

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Remarks
collection	string	Required	uuid
file	string	Required	file path
thumbnail	string	Optional	Manually specify the thumbnail (if the original thumbnail exists in the cache, the original thumbnail is deleted and replaced with the specified thumbnail address, provided that they are different).
analyze	boolean	Optional	true\|false determines whether to immediately start analyzing/updating the asset (if the file does not exist in the database or the information is outdated). Default: true. If a thumbnail is specified, the thumbnail generation step is skipped.
mode	string	Optional	ref\|copy used to specify whether to reference or copy the asset. If value is "copy", the asset is copied to the cache directory with a randomly generated unique file name. If a thumbnail is specified, it is also copied to the thumbnail directory with a randomly generated file name instead of referencing the original thumbnail.
notes	string	Optional	Asset Notes

Return Data

Name	Type	Required	Remarks
success	boolean	Required
message	string	Required
data	object	Required
id	string	Required	Asset id

/utilities/convert_vid2gif

Basic Information

Path： /utilities/convert_vid2gif

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Remarks
file	string	Required	Supports UUID and path.
output_path	string	Optional	Default is the original name with the .gif extension.
fps	string	Optional	origin\|half\|quarter
start_timecode	string	Optional	Default is 0 seconds. Supports two timestamp formats used in notes without the prefix"Timecode-".
end_timecode	string	Optional	Default is the full length. Supports two timestamp formats without "Timecode-".
colors	number	Optional	256\|128\|64

Return Data

Name	Type	Required	Default Value	Remarks	Other

/utilities/convert_vid2seq

Basic Information

Path： /utilities/convert_vid2seq

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Remarks
file	string	Required	Supports UUID and path.
output_path	string	Optional	Default to high quality filename.jpg; can be specified to png. The frame number placeholder has a width of the maximum value in (number of digits in the end frame range, 4, the maximum consecutive # in the output path); if absent or #, it will automatically be added before the suffix, and if there is no suffix, the format defaults to jpg.
start_timecode	string	Optional	Default as 0 seconds; supports two formats of timestamps, excluding "Timecode".
end_timecode	string	Optional	Default as full length; supports two formats of timestamps, excluding "Timecode".

Return Data

Name	Type	Required	Default Value	Remarks	Other

/utilities/convert_seq2gif

Basic Information

Path： /utilities/convert_seq2gif

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Remarks
file	string	Required	Supports UUID and path.,Frame number for sequence frames is in the path****.ext\|path####.ext
output_path	string	Required
fps	number	Required
start_frame	number	Optional	Default to the first frame that can be found.
end_frame	number	Optional	Default to the last frame that can be found.
colors	number	Optional	256\|128\|64
acescg	boolean	Optional	only works for EXR

Return Data

Name	Type	Required	Default Value	Remarks	Other

/utilities/convert_seq2mp4

Basic Information

Path： /utilities/convert_seq2mp4

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Remarks
file	string	Required	Supports UUID and path. Frame number for sequence should be like path****.ext\|path####.ext
output_path	string	Required
fps	number	Required
start_frame	number	Optional	Default to the first frame that can be found.
end_frame	number	Optional	Default as the last frame that can be found
codec	string	Optional	h264\|hevc
quality	string	Optional	high\|mid\|best
resolution	string	Optional	origin\|half\|quarter
acescg	boolean	Optional	only works for EXR

Return Data

Name	Type	Required	Default Value	Remarks	Other

/utilities/convert_img2jpg

Basic Information

Path： /utilities/convert_img2jpg

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other
file	string	Required
output_path	string	Required

Return Data

Name	Type	Required	Default Value	Remarks	Other

/preview/generate_snapshot

Basic Information

Path： /preview/generate_snapshot

Method： POST

Interface Description：

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Remarks
output_path	string	Required	The suffix determines the format as png or jpg.
fit_resolution_x	number	Optional	Controls the x-axis resolution.
fit_resolution_y	number	Optional	Controls the y-axis resolution.

Return Data

Name	Type	Required	Remarks
success	boolean	Required
message	string	Required
data	object	Required
timecode	string	Required	（For non-video and sequence frames, it will be an empty value）Returns the timecode in the format of hh:mm:ss::ff (if fps >= 100, it will be fff) or the frame number.
file	string	Required	Returns the current file path

/preview/generate_3dpass

Basic Information

Path： /preview/generate_3dpass

Method： POST

Interface Description：

If fit_resolution_x or fit_resolution_y is not specified and the source material is an image or video, the original size will be output. If it is viewing a 3D model, it will be output according to the size of the preview panel (equivalent to creating a floating image).
When only fit_resolution_x or fit_resolution_y is input, it controls the length of the output image's single side to the specified value.
When both are enabled simultaneously, it controls the output image to be scaled to fit within the specified resolution, meaning both sides need to be less than or equal to the specified resolution while maintaining the aspect ratio (decimal rounding).
background format is "255,255,255" or "255,255,255,255".
When the background is a four-digit value, the fourth digit represents the opacity channel value, resulting in a 32-bit PNG output.
When the background value exceeds the valid range, it will be clamp(value, 0, 255). When the value is invalid, it defaults to three zeros.
When no background is specified, the default output is a black RGB background image (0,0,0).
When the output format is jpg, the alpha value in the background is ignored.

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Remarks
pass	string	Required	raw\|normal\|zdepth
output_path	string	Required	The suffix determines the format as PNG or high-quality JPEG (z-depth calculation maps from the camera position to the furthest ray intersection distance, ranging from 0 to 255).
fit_resolution_x	number	Optional
fit_resolution_y	number	Optional
background	string	Optional	RGB or RGBA,0-255

Return Data

Name	Type	Required	Remarks
success	boolean	Required	It will fail if it's not a 3D file.
message	string	Required
data	object	Required
file	string	Required

/preview/get_info

Basic Information

Path： /preview/get_info

Method： GET

Interface Description：

Get the current preview panel information, including the file path, UUID, current timestamp (if available), and Notes.

Request Parameters

Headers

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body

Name	Type	Required	Default Value	Remarks	Other

Return Data

Name	Type	Required	Remarks
success	boolean	Required
message	string	Required
data	object	Required
file	string	Required	It will be an empty value if not loaded.
id	string	Required	File uuid
timecode	string	Required	(For non-video and sequence frames, it will be an empty value) Returns the timecode in the format of hh:mm:ss::ff (if fps >= 100, it will be fff) or the frame number.
notes	string	Required
display_size	string	Required	Preview panel display area size.

/asset/cancel_token

Basic Information

Path： /asset/cancel_token

Method： POST

Headers：

Parameter Name	Parameter Value	Required	Example	Remarks
Content-Type	application/json	yes		-

Body:

Name	Type	Required	Default Value	Remarks	Other
PID	number []	Required		One or more PID, delete all related token	item Type: number
		Optional			Return data

Name	Type	Required	Default Value	Remarks	Other
success	boolean	Required
message	string	Required			-