What is the endpoint for [B076]Hiro-OCSR?

The [B076]Hiro-OCSR endpoint is POST https://connect.patsnap.com/ocsr_wrapper/v1/ocsr.

Where can I find the OpenAPI schema for [B076]Hiro-OCSR?

The OpenAPI schema is available at /openapi.json#/paths/~1ocsr_wrapper~1v1~1ocsr/post. You can also browse the full specification at /openapi.json.

[B076]Hiro-OCSR

Q: What data can [B076]Hiro-OCSR return?

[B076]Hiro-OCSR Upload one or more images to recognize chemical structures, returning the SMILES and structure classification for each image in input order. See the Response Schema and Success Response Example on this page for the full structure.

post

https://connect.patsnap.com/ocsr_wrapper/v1/ocsr

Try in Sandbox

Upload one or more images to recognize chemical structures, returning the SMILES and structure classification for each image in input order.

Multiple images can be uploaded at once; the number of results equals the number of input images, kept in input order.

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`count`	`integer<int32>`	`2`	Number of results (equals number of input images).
`results`	`array`	`[ { "h2o": false, "salt": false, "metal": false, "SMILES": "CC(=O)Oc1ccccc1C(=O)O", "charge": false, "isotope": false, "image_type": "molecule" } ]`	Per-image OCSR results, in input order.
`h2o`	`boolean`	-	Whether a water/hydrate component was detected.
`salt`	`boolean`	-	Whether a salt component was detected.
`error`	`string`	`failed to recognize structure`	Per-image error reported by the model, if any.
`metal`	`boolean`	-	Whether a metal atom was detected.
`charge`	`boolean`	-	Whether a net charge was detected.
`smiles`	`string`	`CC(=O)Oc1ccccc1C(=O)O`	Recognized SMILES string (empty if unrecognized).
`isotope`	`boolean`	-	Whether an isotope label was detected.
`image_type`	`string`	`molecule`	Model's classification of the depicted structure (e.g. 'molecule').
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "count": 2,
    "results": [
      {
        "h2o": false,
        "salt": false,
        "error": "failed to recognize structure",
        "metal": false,
        "charge": false,
        "smiles": "CC(=O)Oc1ccccc1C(=O)O",
        "isotope": false,
        "image_type": "molecule"
      }
    ]
  },
  "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