Found 纷得 API 文档
/found/get_version
基本信息
Path： /found/get_version
Method： GET
接口描述：
获取 Found 版本号
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 |
/found/log
基本信息
Path： /found/log
Method： POST
接口描述：
输出消息到 log 中
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| message | string | 必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 |
/found/get_database_path
基本信息
Path： /found/get_database_path
Method： GET
接口描述：
获取本地 Found 数据库目录路径，如 "C:/ProgramData/Aalab/Found/database.found"
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 |
/found/alert
基本信息
Path： /found/alert
Method： POST
接口描述：
创建Found内提示信息
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| type | string | 必须 | ok|error|空 | ||
| message | string | 必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| message | string | 必须 | Invalid Type |
/asset/get_uuid
基本信息
Path： /asset/get_uuid
Method： POST
接口描述：
获取单个资产在数据库内的 uuid。不对没有录入数据库的文件进行初始化。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持uuid与path |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 非必须 | |||
| message | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ id | string | 非必须 |
/asset/get_thumbnail
基本信息
Path： /asset/get_thumbnail
Method： POST
接口描述：
获取单个资产缩略图地址，无效文件或者不存在缩略图则返回空
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持uuid与path |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 |
/asset/set_thumbnail
基本信息
Path： /asset/set_thumbnail
Method： POST
接口描述：
如果数据库内不存在该资产则执行失败。
当thumbnail的长度为小于1000字符时，检测字符是否为本地有效图像文件，如是则当作文件读取缩略图，否则尝试解析为base64编码的图像文件作为缩略图。
当缩略图为base64时，忽略mode参数，新替换的缩略图不写入数据库。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持uuid与path | ||
| thumbnail | string | 必须 | |||
| mode | string | 非必须 | ref|copy 决定缩略图是改写数据库引用还是复制一份并放到thumbnails目录内使用uuid文件名。如文件已经存在原始缩略图在cache内，则删除原cache内缩略图（如果和新的缩略图地址不同）如有缩略图但不属于cache，则不对原始缩略图文件作更改 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | 不存在缩略图则报错 | ||
| message | string | 必须 | Thumbnail is not available | ||
| data | object | 必须 | |||
| ├─ thumbnail_path | string | 必须 |
/asset/rename
基本信息
Path： /asset/rename
Method： POST
接口描述：
重命名文件（自动修正所有数据库资产关联信息，如备注和收集等）如数据库内没有该资产记录，则等价于仅重命名文件
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 序列帧序号部分为*或者#,数字位数严格校验等位数 | ||
| new_filename | string | 必须 | 新文件名，如序列帧缺乏序号则自动在后缀名前（如存在）追加"_(原始序号)"，否则位数要求不少于原始位数 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| message | string | 必须 | |||
| data | object | 非必须 |
/asset/get_asset_info
基本信息
Path： /asset/get_asset_info
Method： POST
接口描述：
获取已经被分析过的资产信息 json
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持路径与uuid，序列帧识别****或####（位数严格校验） |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| message | string | 必须 | |||
| data | object | 必须 | 返回资产信息json |
/asset/get_notes
基本信息
Path： /asset/get_notes
Method： POST
接口描述：
获取单个资产备注，失败则返回空
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持路径与uuid，序列帧识别****或####（位数严格校验） |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 | notes |
/asset/set_notes
基本信息
Path： /asset/set_notes
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持uuid与path | ||
| notes | string | 必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | 不存在缩略图则报错 | ||
| message | string | 必须 | Thumbnail is not available | ||
| data | object | 非必须 |
/asset/set_token
基本信息
Path： /asset/set_token
Method： POST
接口描述：
设置一个token icon，不存在则创建 token。
如果有指定related_file，则在标签页内浏览区里临时隐藏该文件（不管该文件是否存在）
当progress 数值为负值或者超过1时：
如果没有指定related_file，则删除token；
如果有指定related_file且path为普通路径，则将该token切换为related_file的icon
如果有指定related_file且path为收集，则将该token切换为related_file的icon，并触发add_asset将target_file加入到对应收集中
当thumbnail的长度为小于1000字符时，检测字符是否为本地有效图像文件，如是则当作文件读取缩略图，否则尝试解析为base64编码的图像文件作为缩略图
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| path | string | 必须 | 创建token的路径，可以是文件夹或者收集uuid | ||
| name | string | 必须 | token显示名（区分唯一标识，禁止重名） | ||
| progress | number | 必须 | 范围0-1，控制进度。超出有效范围如负值或者大于1时删除token或者切换至目标文件 | ||
| progress_bar | boolean | 非必须 | 显示可选进度条 | ||
| thumbnail | string | 非必须 | 可选指定缩略图的base64，没有则空缩略图, | ||
| related_file | string | 非必须 | 目标替换文件，如果path是路径则必须是同路径的另外一个文件名（可不包含路径只用文件名） | ||
| PID | number[] | 非必须 | 一项或多项PID，关联结束任务功能 | item类型:number |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| message | string | 必须 | |||
| data | object | 必须 |
/collection/add_asset
基本信息
Path： /collection/add_asset
Method： POST
接口描述：
返回增加的资产id（如果数据库已经存在该文件则直接将对应资产加入到收集中）
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| collection | string | 必须 | uuid | ||
| file | string | 必须 | file path | ||
| thumbnail | string | 非必须 | 手动指定缩略图（如果已经存在cache内缩略图则删除原始缩略图，指定为这里的缩略图地址，前提是两者不一致） | ||
| analyze | boolean | 非必须 | true|false决定是否立马开始分析|更新资产（如果数据库中不存在该文件或者信息过时）默认 true。如有指定缩略图则跳过缩略图生成环节 | ||
| mode | string | 非必须 | ref|copy 默认引用资产，copy则是将资产复制到cache目录下并生成随机唯一文件名，如有指定缩略图，则将该缩略图同时复制到thumbnail目录下并生成随机文件名而非引用（即缩略图也创建拷贝而非引用） | ||
| notes | string | 非必须 | 资产备注 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| message | string | 必须 | |||
| data | object | 必须 | |||
| ├─ id | string | 必须 | 资产id |
/utilities/convert_vid2gif
基本信息
Path： /utilities/convert_vid2gif
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持uuid与path | ||
| output_path | string | 非必须 | 默认为原名.gif | ||
| fps | string | 非必须 | origin|half|quarter | ||
| start_timecode | string | 非必须 | 默认为0秒；支持两种格式时间戳，不含"Timecode-" | ||
| end_timecode | string | 非必须 | 默认全长；支持两种格式时间戳，不含"Timecode-" | ||
| colors | number | 非必须 | 256|128|64 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
/utilities/convert_vid2seq
基本信息
Path： /utilities/convert_vid2seq
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持uuid与path | ||
| output_path | string | 非必须 | 默认为高质量-qscale:v 2 filename_****.jpg；可指定后缀为png。帧号占位符位数为（结束帧范围位数，4，output_path中最大连续*|#个数）中最大值；如没有*或#，自动在后缀名前加入"_****"，没有后缀名则默认jpg | ||
| start_timecode | string | 非必须 | 默认为0秒；支持两种格式时间戳，不含"Timecode" | ||
| end_timecode | string | 非必须 | 默认全长；支持两种格式时间戳，不含"Timecode" |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
/utilities/convert_seq2gif
基本信息
Path： /utilities/convert_seq2gif
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持uuid与path，序列帧帧号为path****.ext|path####.ext | ||
| output_path | string | 必须 | |||
| fps | number | 必须 | |||
| start_frame | number | 非必须 | 默认能找到的第一帧 | ||
| end_frame | number | 非必须 | 默认能找到的最后一帧 | ||
| colors | number | 非必须 | 256|128|64 | ||
| acescg | boolean | 非必须 | only works for EXR |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
/utilities/convert_seq2mp4
基本信息
Path： /utilities/convert_seq2mp4
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | 支持uuid与path，序列帧帧号为path****.ext|path####.ext | ||
| output_path | string | 必须 | |||
| fps | number | 必须 | |||
| start_frame | number | 非必须 | 默认能找到的第一帧 | ||
| end_frame | number | 非必须 | 默认能找到的最后一帧 | ||
| codec | string | 非必须 | h264|hevc | ||
| quality | string | 非必须 | high|mid|best | ||
| resolution | string | 非必须 | origin|half|quarter | ||
| acescg | boolean | 非必须 | only works for EXR |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
/utilities/convert_img2jpg
基本信息
Path： /utilities/convert_img2jpg
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| file | string | 必须 | |||
| output_path | string | 必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
/preview/generate_snapshot
基本信息
Path： /preview/generate_snapshot
Method： POST
接口描述：
没有指定fit_resolution_x或者fit_resolution_y时，如原始素材是图像或者视频等，则输出原始尺寸，如在查看三维模型，则按照预览面板大小输出（即等同于创建悬浮图）
当仅输入fit_resolution_x或者fit_resolution_y时，控制输出图像单边长度为指定值
当同时启用两者时，控制输出图像缩放至指定分辨率内框大小内，即两边同时需要小于或等于该指定分辨率并维持大小比例不变（小数取整）
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| output_path | string | 必须 | 后缀决定png与jpg格式 | ||
| fit_resolution_x | number | 非必须 | 控制x轴分辨率 | ||
| fit_resolution_y | number | 非必须 | 控制y轴分辨率 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| message | string | 必须 | |||
| data | object | 必须 | |||
| ├─ timecode | string | 必须 | （非视频与序列帧则为空值）返回时间码，如hh:mm:ss::ff(如果fps>=100则为fff) 或者 帧号 | ||
| ├─ file | string | 必须 | 返回当前文件路径 |
/preview/generate_3dpass
基本信息
Path： /preview/generate_3dpass
Method： POST
接口描述：
没有指定fit_resolution_x或者fit_resolution_y时，如原始素材是图像或者视频等，则输出原始尺寸，如在查看三维模型，则按照预览面板大小输出（即等同于创建悬浮图）
当仅输入fit_resolution_x或者fit_resolution_y时，控制输出图像单边长度为指定值
当同时启用两者时，控制输出图像缩放至指定分辨率内框大小内，即两边同时需要小于或等于该指定分辨率并维持大小比例不变（小数取整）
background格式为 "255,255,255" 或 "255,255,255,255"。
当background 为四位数值时，第四位为opacity通道值，即输出32位png。
当background 数值超出有效范围时，默认clamp(value, 0, 255)，当值非法时，默认为三位0
当没有指定background时，默认输出黑色RGB背景图（0,0,0）。
输出格式为jpg时，忽略background中的alpha值
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| pass | string | 必须 | raw|normal|zdepth | ||
| output_path | string | 必须 | 后缀决定png与高质量jpg格式(zdepth计算由相机位置到最远ray交点距离映射0-255) | ||
| fit_resolution_x | number | 非必须 | |||
| fit_resolution_y | number | 非必须 | |||
| background | string | 非必须 | RGB或者RGBA,0-255 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | 非3D文件则失败 | ||
| message | string | 必须 | |||
| data | object | 必须 | |||
| ├─ file | string | 必须 |
/preview/get_info
基本信息
Path： /preview/get_info
Method： GET
接口描述：
获取当前预览面板信息，包括文件路径、uuid、当前时间戳（如有）和备注
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| message | string | 必须 | |||
| data | object | 必须 | |||
| ├─ file | string | 必须 | 没有加载则为空值 | ||
| ├─ id | string | 必须 | 文件uuid | ||
| ├─ timecode | string | 必须 | （非视频与序列帧则为空值）返回时间码，如hh:mm:ss::ff(如果fps>=100则为fff) 或者 帧号 | ||
| ├─ notes | string | 必须 | |||
| ├─ display_size | string | 必须 | 预览面板显示区域大小 |
/asset/cancel_token
基本信息
Path： /asset/cancel_token
Method： POST
Headers：
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | - |
Body:
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| PID | number [] | 必须 | 一项或多项 PID，删除所有相关 token | item 类型: number | |
| 非必须 | 返回数据 |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 必须 | |||
| message | string | 必须 | - |