What is the endpoint for [B072-1]Extract chemical structures from multiple patents-create?

The [B072-1]Extract chemical structures from multiple patents-create endpoint is POST https://connect.patsnap.com/synapse/patent/chemical/submitTask.

Where can I find the OpenAPI schema for [B072-1]Extract chemical structures from multiple patents-create?

The OpenAPI schema is available at /openapi.json#/paths/~1synapse~1patent~1chemical~1submitTask/post. You can also browse the full specification at /openapi.json.

[B072-1]Extract chemical structures from multiple patents-create

post

https://connect.patsnap.com/synapse/patent/chemical/submitTask

Try in Sandbox

Submit a chemical structure search task based on patent IDs or patent numbers, source, molecular weight range, etc., and return a task ID for querying results later

Either patent_ids or patent_numbers is required, if both are provided, patent_ids takes precedence.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`limit`	`integer<int32>`	`10`	Number of returned items, default 10.Maximum limit setting 100
`page`	`integer<int32>`	`1`	page, default 1
`patent_ids`	`array`	`[ "3b583fb3-4edc-45f9-9b8c-2d9a82f5a730" ]`	Patent ID list, either patent_ids or patent_numbers is required, if both are provided, patent_ids takes precedence, maximum 100
`patent_numbers`	`array`	`[ "US20230233575A1" ]`	Patent number list, either patent_ids or patent_numbers is required, if both are provided, patent_ids takes precedence, maximum 100
`range_max`	`number<double>`	`888`	Maximum molecular weight
`range_min`	`number<double>`	`30`	Minimum molecular weight
`source` Required	`array`	`[ 1, 2, 3, 4, 5, 6, 7 ]`	Source, 1:Manual \| 2:Other \| 3:Picture \| 4:Claims \| 5:Abstract \| 6:Title \| 7:Description

Request Example

Example request body for this API endpoint

JSON

{
  "page": 1,
  "limit": 10,
  "source": [
    1,
    2,
    3,
    4,
    5,
    6,
    7
  ],
  "range_max": 888,
  "range_min": 30,
  "patent_ids": [
    "3b583fb3-4edc-45f9-9b8c-2d9a82f5a730"
  ],
  "patent_numbers": [
    "US20230233575A1"
  ]
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`task_id`	`string`	`8f1fbc521be54612940b894cf532198d`	Task ID for querying task results later
`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": {
    "task_id": "8f1fbc521be54612940b894cf532198d"
  },
  "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