项目管理 API

项目的创建、查询、编辑与删除接口,包括源语言/目标语言设置与项目状态说明

项目管理 API

项目是视频翻译的容器,一个项目对应一部短剧,项目下包含多集视频。源语言(sourceLanguage)与目标语言(targetLanguage)在创建时指定,创建后不允许修改

流程位置:创建项目是整个翻译流程的第一步,项目创建完成后即可上传视频

项目列表

GET /project/data.html

分页查询项目,每条回填视频总数(videoTotalCount)与已设置字幕区域的视频数(videoSubtitleRegionSetCount)。

分页与过滤通用参数(page/limit/dataEqual/dataLike/dataRange/sort/order)见 概述-分页与过滤参数

请求参数

名称位置类型必选说明
pagequeryinteger页码,从 1 开始
limitqueryinteger每页数量
sortquerystring排序字段
orderquerystring排序方向
dataEqualquerystring精确过滤条件 JSON 串,如 {"name":"xxx"}
dataLikequerystring模糊过滤条件 JSON 串
dataRangequerystring范围过滤条件 JSON 串

返回示例

200 Response

{
  "id": "string",
  "code": 0,
  "msg": "string",
  "data": {}
}

返回结果

状态码状态码含义说明数据模型
200OKnoneBaseReturnModel

新增项目

GET /project/add.html

创建项目。项目 id 由服务端生成;缺必填参数返回参数缺失错误。

请求参数

名称位置类型必选说明
namequerystring项目名称
sourceLanguagequerystring源语言(创建后不可修改)
targetLanguagequerystring目标语言(创建后不可修改)
fontSizequeryinteger字号(0 表示自动计算)
subtitleRegionsquerystring字幕区域(JSON 格式,存储相对坐标)

返回示例

200 Response

{
  "id": "string",
  "code": 0,
  "msg": "string",
  "data": {}
}

返回结果

状态码状态码含义说明数据模型
200OKnoneBaseReturnModel

编辑项目

GET /project/edit.html

编辑项目信息。源语言(sourceLanguage)与目标语言(targetLanguage)不允许修改。

请求参数

名称位置类型必选说明
idquerystring项目 id
namequerystring项目名称
fontSizequeryinteger字号(0 表示自动计算)
subtitleRegionsquerystring字幕区域(JSON 格式,存储相对坐标)

返回示例

200 Response

{
  "id": "string",
  "code": 0,
  "msg": "string",
  "data": {}
}

返回结果

状态码状态码含义说明数据模型
200OKnoneBaseReturnModel

删除项目

GET /project/del.html

批量删除项目,级联删除项目下全部视频记录。

请求参数

名称位置类型必选说明
idsqueryarraystring项目 id 列表

返回示例

200 Response

{
  "id": "string",
  "code": 0,
  "msg": "string",
  "data": {}
}

返回结果

状态码状态码含义说明数据模型
200OKnoneBaseReturnModel

项目状态说明

项目状态 status 字段枚举:

状态值说明
init未开始
processing处理中
success成功(整剧全部完成)
fail失败

整剧打包下载(成品下载 API)要求项目状态为 success。