更新时间:2025-07-08 GMT+08:00
分享

创建配体文件预览任务

功能介绍

创建配体文件预览任务,支持SMI、SDF、PDB、MOL2。

URI

POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/preview

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,您可以从获取项目ID中获取。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

eihealth_project_id

String

参数解释

空间ID。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

ligand_file

DrugFile object

参数解释

配体文件。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

preview_count

Integer

参数解释

预览数量,如果分子数量大于预览数量,则超出预览数量部分只做计数。

约束限制

不涉及

取值范围

0-1000

默认取值

100

count_limit

Integer

参数解释

计数上限,如果分子数量大于计数上限,则终止计数并在结果中标明计数不完整(has_more=true),计数数量应不小于preview_count。

约束限制

不涉及

取值范围

0-1000000

默认取值

1000

generate_3d

Boolean

参数解释

是否生成3D构象,默认为true。

约束限制

不涉及

取值范围

  • true:生成3D构象。

  • false:不生成3D构象。

默认取值

true

表4 DrugFile

参数

是否必选

参数类型

描述

source

String

参数解释

受体数据源。

约束限制

不涉及

取值范围

  • EXTRANET:外部网络数据

  • PRIVATE:私有数据

  • PUBLIC:公共数据

  • RAW:源数据

默认取值

不涉及

url

String

参数解释

文件URL。

约束限制

当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址

取值范围

文件仅URL仅支持以.pdb、.mol2、.sdf、.smi为结尾,长度为[1-2000]个字符。

默认取值

不涉及

format

String

参数解释

文件格式。

约束限制

当数据源source为RAW时提供。

取值范围

  • PDB:PDB文件

  • SDF:SDF文件

  • MOL2:MOL2文件

  • SMI:SMI文件

默认取值

不涉及

data

String

参数解释

文件原始数据。

约束限制

当数据源source为RAW时提供。

取值范围

长度为[0-10000000]个字符。

默认取值

不涉及

响应参数

状态码:201

表5 响应Body参数

参数

参数类型

描述

id

String

参数解释

任务ID。

约束限制

不涉及

取值范围

长度为[1-128]个字符。

默认取值

不涉及

请求示例

创建配体文件预览任务,配体为源数据,且不生成3D构象。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/preview

{
  "ligand_file" : {
    "source" : "RAW",
    "format" : "PDB",
    "data" : "MODEL1 XXX..."
  },
  "generate_3d" : false
}

响应示例

状态码:201

配体预览任务创建成功响应。

{
  "id" : "c05ebc2029c24699af2354f67391604c"
}

状态码

状态码

描述

201

配体预览任务创建成功响应。

错误码

请参见错误码

相关文档