Get SAR File Detail
Query the status and result of a SAR extraction task. Returns details after all files are parsed
Request Parameters
List of parameters supported by this API endpoint
| Name | Type | Example | Description |
|---|---|---|---|
Required | string | abc123xyz | Task ID returned by the /file/extract API |
Response Schema
Structure of the API response data
| Field Name | Type | Example | Description |
|---|---|---|---|
data | object | - | response data |
files | array | [
{
"fileId": "abc123",
"status": "SUCCESS",
"fileName": "patent.pdf"
}
] | File detail list |
items | array | [
{
"unit": "nM",
"value": "10",
"resultId": "result_001",
"indicator": "IC50"
}
] | SAR extraction result list (only returned when status=SUCCESS) |
unit | string | nM | Unit |
match | boolean | true | Structure match |
value | string | 10 | Value |
source | object | {
"x": 100,
"y": 200,
"page": 1,
"width": 300,
"height": 50
} | Source bbox info |
target | array | [
"EGFR",
"HER2"
] | Standardized target |
indicator | string | IC50 | Indicator |
result_id | string | result_123456 | Result ID |
structure | object | {
"mol": "...",
"smiles": "CC(=O)Oc1ccccc1C(=O)O",
"inchyKey": "BSYNRYMUTXBXSQ-UHFFFAOYSA-N"
} | Structure |
mol | string | CC(=O)Oc1ccccc1C(=O)O
MJ201900
7 7 0 0 0 0 0 0 0 0999 V2000 | MOL format |
smiles | string | CC(=O)Oc1ccccc1C(=O)O | SMILES expression |
inchy_key | string | BSYNRYMUTXBXSQ-UHFFFAOYSA-N | InChI Key |
other_name | string | Compound A | Other name |
value_source | string | Literature | Value source |
dosing_regimen | object | {
"route": "Oral",
"dosage": "10 mg/kg",
"duration": "7 days",
"frequency": "Once daily"
} | Dosing regimen |
route | string | Oral | Route of administration |
dosage | string | 10 mg/kg | Dosage |
duration | string | 7 days | Duration |
frequency | string | Once daily | Frequency |
substance_code | object | {
"code": "C001",
"name": "Compound A"
} | Substance code |
protein_subtype | string | EGFR-T790M | Protein subtype |
experimental_method | string | MTT assay | Experimental method |
experimental_target | string | EGFR | Experimental target |
standardized_target | array | [
{
"targetId": "T001",
"displayNameCn": "表皮生长因子受体",
"displayNameEn": "EGFR"
}
] | Standardized target |
target_id | string | T001 | Target ID |
display_name_cn | string | 表皮生长因子受体 | Display name (CN) |
display_name_en | string | EGFR | Display name (EN) |
experimental_purpose | string | Cytotoxicity | Experimental purpose |
experimental_subject | string | Cell line | Experimental subject |
total | integer<int32> | 5 | Total result count (only returned when status=SUCCESS) |
status | string | SUCCESS | File status: PENDING / PROCESSING / SUCCESS / FAILED |
file_id | string | abc123xyz | File ID |
file_name | string | patent.pdf | File name |
status | string | PROCESSING | Overall task status: PENDING / PROCESSING / SUCCESS / FAILED / NOT_FOUND |
statusRequired | boolean | false | Status |
error_msg | string | The request parameter format is incorrect! | Error Message |
error_codeRequired | integer | 0 | Error Code |
Success Response Example
Example of a successful API response
JSON
{
"data": {
"files": [
{
"items": [
{
"unit": "nM",
"match": true,
"value": 10,
"source": {
"x": 100,
"y": 200,
"page": 1,
"width": 300,
"height": 50
},
"target": [
"EGFR",
"HER2"
],
"indicator": "IC50",
"result_id": "result_123456",
"structure": {
"mol": "CC(=O)Oc1ccccc1C(=O)O\n MJ201900 \n\n 7 7 0 0 0 0 0 0 0 0999 V2000",
"smiles": "CC(=O)Oc1ccccc1C(=O)O",
"inchy_key": "BSYNRYMUTXBXSQ-UHFFFAOYSA-N"
},
"other_name": "Compound A",
"value_source": "Literature",
"dosing_regimen": {
"route": "Oral",
"dosage": "10 mg/kg",
"duration": "7 days",
"frequency": "Once daily"
},
"substance_code": {
"code": "C001",
"name": "Compound A"
},
"protein_subtype": "EGFR-T790M",
"experimental_method": "MTT assay",
"experimental_target": "EGFR",
"standardized_target": [
{
"target_id": "T001",
"display_name_cn": "表皮生长因子受体",
"display_name_en": "EGFR"
}
],
"experimental_purpose": "Cytotoxicity",
"experimental_subject": "Cell line"
}
],
"total": 5,
"status": "SUCCESS",
"file_id": "abc123xyz",
"file_name": "patent.pdf"
}
],
"status": "PROCESSING"
},
"status": true,
"error_code": 0
}Error Codes
List of possible error codes returned by this endpoint
Business Errors
| Error Code | Description |
|---|---|
68300004 | Invalid parameter! |
68300005 | Search api failure! |
68300006 | Analytic basic access error! |
68300007 | Bad request! |
68300008 | Service error, please try again later! |
68300010 | The file does not comply with upload specifications! |
Platform Errors
| Error Code | Description |
|---|---|
67200000 | API call exceeds the total limit set by the platform! |
67200001 | API call exceeds the total limit set by the platform! |
67200002 | The current call rate is too fast, exceeding the current configuration limit QPS! |
67200003 | The key and secret parameters for applying for the token are incorrect or the client has been disabled! |
67200004 | The requested api does not have permission. Please contact our support personnel! |
67200005 | Insufficient account balance/number of calls! |
67200006 | The client has exceeded the activation validity period! |
67200007 | The current call exceeds the configured usage limit of the day! |
67200008 | Please check if the required apikey in the query parameter has been transmitted! |
67200009 | The apikey does not match the passed bearerToken. Please check if a valid token is being used! |
67200012 | The request is illegal! |
67200100 | The current server status is busy, request response timeout! |
67200101 | The API requested currently does not exist. Please check the request path! |
HTTP Status Codes
| Status Code | Description |
|---|---|
0 | Success |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Performance Metrics
Expected performance characteristics for this endpoint
Normal Response Time
5000 ms
Max Response Time
10000 ms