What is the endpoint for [M001-2]Formulation agent query?

The [M001-2]Formulation agent query endpoint is POST https://connect.patsnap.com/ai/formulation-agent-query.

What data can [M001-2]Formulation agent query return?

[M001-2]Formulation agent query Obtain the task results of the Formulation Agent through the task_id generated by [M001-1]. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [M001-2]Formulation agent query?

The OpenAPI schema is available at /openapi.json#/paths/~1ai~1formulation-agent-query/post. You can also browse the full specification at /openapi.json.

[M001-2]Formulation agent query

post

https://connect.patsnap.com/ai/formulation-agent-query

Try in Sandbox

Obtain the task results of the Formulation Agent through the task_id generated by [M001-1]

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`task_id` Required	`string`	`80d440b7-80a5-4233-a75f-ab72b0885c88`	Task id

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`status`	`integer<int32>`	`2`	Task status (1: running, 2: successful, 3: generation exception).
`formulations`	`array`	[ { "dimension": "Mechanical Reinforcement and Energy Dissipation", "formulation_1": { "source": "https://patents.google.com/patent/CN101792545B/zh", "status": "success", "solution_id": "d739436a-6ff9-458a-b7c4-8e6518862a11", "solution_type": "WEBSITE", "ingredient_list": [ { "content": [ 6, 40 ], "function": "Reinforcing filler", "ingredient": "Carbon black" }, { "content": [ 45, 80 ], "function": "Reinforcing filler", "ingredient": "Silica (white carbon black)" }, { "content": [ 3, 6 ], "function": "Filler dispersion/compatibilizer", "ingredient": "Silane coupling agent" }, { "content": [ 20, 45 ], "function": "Plasticizer", "ingredient": "Aromatic oil" }, { "content": [ 1, 5 ], "function": "Tackifier", "ingredient": "Tackifying resin" }, { "content": [ 1, 4.5 ], "function": "Activator", "ingredient": "Zinc oxide" }, { "content": [ 0.5, 2.5 ], "function": "Activator", "ingredient": "Stearic acid" }, { "content": [ 1.5, 3.5 ], "function": "Crosslinker (vulcanizing agent)", "ingredient": "Sulfur" }, { "content": [ 2, 5 ], "function": "Vulcanization accelerator", "ingredient": "Accelerator" } ] }, "formulation_2": { "source": "https://www.hsxjw.com/tianranjiaobaike_2115.html", "status": "success", "solution_id": "6a83f9bd-0506-43a6-aae1-d78bb6a8cc53", "solution_type": "WEBSITE", "ingredient_list": [ { "content": [ 50.9, 50.9 ], "function": "Polymer matrix", "ingredient": "Natural rubber" }, { "content": [ 2.04, 2.04 ], "function": "Activator", "ingredient": "Zinc oxide" }, { "content": [ 1.78, 1.78 ], "function": "Activator", "ingredient": "Stearic acid" }, { "content": [ 0.76, 0.76 ], "function": "Antioxidant", "ingredient": "Antioxidant 4010" }, { "content": [ 0.51, 0.51 ], "function": "Antioxidant", "ingredient": "Antioxidant D" }, { "content": [ 30.54, 30.54 ], "function": "Reinforcing filler", "ingredient": "Carbon black N330" }, { "content": [ 10.18, 10.18 ], "function": "Reinforcing filler", "ingredient": "Channel black" }, { "content": [ 1.53, 1.53 ], "function": "Plasticizer", "ingredient": "Pine tar" }, { "content": [ 0.31, 0.31 ], "function": "Vulcanization accelerator", "ingredient": "Accelerator NOBS" }, { "content": [ 1.43, 1.43 ], "function": "Crosslinker (vulcanizing agent)", "ingredient": "Sulfur" } ] }, "strategy_index": 0 } ]	Formulation list
`dimension`	`string`	`Mechanical Reinforcement and Energy Dissipation`	Dimension
`formulation_1`	`object`	{ "source": "https://patents.google.com/patent/CN101792545B/zh", "status": "success", "solution_id": "d739436a-6ff9-458a-b7c4-8e6518862a11", "solution_type": "WEBSITE", "ingredient_list": [ { "content": [ 6, 40 ], "function": "Reinforcing filler", "ingredient": "Carbon black" }, { "content": [ 45, 80 ], "function": "Reinforcing filler", "ingredient": "Silica (white carbon black)" }, { "content": [ 3, 6 ], "function": "Filler dispersion/compatibilizer", "ingredient": "Silane coupling agent" }, { "content": [ 20, 45 ], "function": "Plasticizer", "ingredient": "Aromatic oil" }, { "content": [ 1, 5 ], "function": "Tackifier", "ingredient": "Tackifying resin" }, { "content": [ 1, 4.5 ], "function": "Activator", "ingredient": "Zinc oxide" }, { "content": [ 0.5, 2.5 ], "function": "Activator", "ingredient": "Stearic acid" }, { "content": [ 1.5, 3.5 ], "function": "Crosslinker (vulcanizing agent)", "ingredient": "Sulfur" }, { "content": [ 2, 5 ], "function": "Vulcanization accelerator", "ingredient": "Accelerator" } ] }	Formulation 1
`source`	`string`	`https://patents.google.com/patent/CN101792545B/zh`	Source
`status`	`string`	`success`	Status
`name_cn`	`string`	`name`	Chinese name
`solution_id`	`string`	`d739436a-6ff9-458a-b7c4-8e6518862a11`	Solution ID
`country_name`	`string`	`中国`	Country name
`solution_type`	`string`	`WEBSITE`	Solution type
`ingredient_list`	`array`	[ { "content": [ 6, 40 ], "function": "Reinforcing filler", "ingredient": "Carbon black" }, { "content": [ 45, 80 ], "function": "Reinforcing filler", "ingredient": "Silica (white carbon black)" }, { "content": [ 3, 6 ], "function": "Filler dispersion/compatibilizer", "ingredient": "Silane coupling agent" }, { "content": [ 20, 45 ], "function": "Plasticizer", "ingredient": "Aromatic oil" }, { "content": [ 1, 5 ], "function": "Tackifier", "ingredient": "Tackifying resin" }, { "content": [ 1, 4.5 ], "function": "Activator", "ingredient": "Zinc oxide" }, { "content": [ 0.5, 2.5 ], "function": "Activator", "ingredient": "Stearic acid" }, { "content": [ 1.5, 3.5 ], "function": "Crosslinker (vulcanizing agent)", "ingredient": "Sulfur" }, { "content": [ 2, 5 ], "function": "Vulcanization accelerator", "ingredient": "Accelerator" } ]	Ingredient list
`content`	`array`	`[ 6, 40 ]`	Content range
`function`	`string`	`Reinforcing filler`	Function
`ingredient`	`string`	`Carbon black`	Ingredient name
`formulation_2`	`object`	{ "source": "https://www.hsxjw.com/tianranjiaobaike_2115.html", "status": "success", "solution_id": "6a83f9bd-0506-43a6-aae1-d78bb6a8cc53", "solution_type": "WEBSITE", "ingredient_list": [ { "content": [ 50.9, 50.9 ], "function": "Polymer matrix", "ingredient": "Natural rubber" }, { "content": [ 2.04, 2.04 ], "function": "Activator", "ingredient": "Zinc oxide" }, { "content": [ 1.78, 1.78 ], "function": "Activator", "ingredient": "Stearic acid" }, { "content": [ 0.76, 0.76 ], "function": "Antioxidant", "ingredient": "Antioxidant 4010" }, { "content": [ 0.51, 0.51 ], "function": "Antioxidant", "ingredient": "Antioxidant D" }, { "content": [ 30.54, 30.54 ], "function": "Reinforcing filler", "ingredient": "Carbon black N330" }, { "content": [ 10.18, 10.18 ], "function": "Reinforcing filler", "ingredient": "Channel black" }, { "content": [ 1.53, 1.53 ], "function": "Plasticizer", "ingredient": "Pine tar" }, { "content": [ 0.31, 0.31 ], "function": "Vulcanization accelerator", "ingredient": "Accelerator NOBS" }, { "content": [ 1.43, 1.43 ], "function": "Crosslinker (vulcanizing agent)", "ingredient": "Sulfur" } ] }	Formulation 2
`strategy_index`	`integer<int32>`	-	Strategy index
`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": {
    "status": 2,
    "formulations": [
      {
        "dimension": "Mechanical Reinforcement and Energy Dissipation",
        "formulation_1": {
          "source": "https://patents.google.com/patent/CN101792545B/zh",
          "status": "success",
          "name_cn": "name",
          "solution_id": "d739436a-6ff9-458a-b7c4-8e6518862a11",
          "country_name": "中国",
          "solution_type": "WEBSITE",
          "ingredient_list": [
            {
              "content": [
                6,
                40
              ],
              "function": "Reinforcing filler",
              "ingredient": "Carbon black"
            }
          ]
        },
        "formulation_2": {
          "source": "https://patents.google.com/patent/CN101792545B/zh",
          "status": "success",
          "name_cn": "name",
          "solution_id": "d739436a-6ff9-458a-b7c4-8e6518862a11",
          "country_name": "中国",
          "solution_type": "WEBSITE",
          "ingredient_list": [
            {
              "content": [
                6,
                40
              ],
              "function": "Reinforcing filler",
              "ingredient": "Carbon black"
            }
          ]
        },
        "strategy_index": 0
      }
    ]
  },
  "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