What is the endpoint for [AI34-2]Quick-search report creation - custom directory(Beta)?

The [AI34-2]Quick-search report creation - custom directory(Beta) endpoint is POST https://connect.patsnap.com/ai/quick-search-report/creation/custom-dir.

Where can I find the OpenAPI schema for [AI34-2]Quick-search report creation - custom directory(Beta)?

The OpenAPI schema is available at /openapi.json#/paths/~1ai~1quick-search-report~1creation~1custom-dir/post. You can also browse the full specification at /openapi.json.

[AI34-2]Quick-search report creation - custom directory(Beta)

post

https://connect.patsnap.com/ai/quick-search-report/creation/custom-dir

Try in Sandbox

Based on the input directory related to a certain technology, generate the pre-research report of that technology.

Only TECH_RESEARCH_CUSTOM_MODULE_1/TECH_RESEARCH_CUSTOM_MODULE_2 can be modified

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`analysis_directory` Required	`array`	[ { "key": "TECH_RESEARCH_TECHNICAL_BACKGROUND", "name": "锂电池能量密度背景与目标", "source_type": "model" }, { "key": "TECH_RESEARCH_MARKET_ANALYSIS", "name": "锂电池市场需求分析", "source_type": "model" }, { "key": "TECH_RESEARCH_TECHNOLOGY_STATUS_CHALLENGES", "name": "能量密度提升技术挑战", "source_type": "model" }, { "key": "TECH_RESEARCH_EVOLUTION_PATH", "name": "锂电池能量密度演进路径", "source_type": "model" }, { "key": "TECH_RESEARCH_HEAD_PLAYER_ANALYSIS", "name": "高能量密度电池企业分析", "source_type": "model" }, { "key": "TECH_RESEARCH_TECHNICAL_SCHEME_REVIEW", "name": "提高能量密度技术方案", "source_type": "model" }, { "key": "TECH_RESEARCH_KEY_PATENT_INTERPRETATION", "name": "高能量密度电池核心技术", "source_type": "model" }, { "key": "TECH_RESEARCH_IDEA_SUMMARY", "name": "能量密度提升创新方向", "source_type": "model" }, { "key": "TECH_RESEARCH_CUSTOM_MODULE_1", "name": "能量密度与安全性平衡", "source_type": "customize" }, { "key": "TECH_RESEARCH_CUSTOM_MODULE_2", "name": "高能量密度电池应用场景", "source_type": "customize" } ]	Create the directory of the quick-search report
`key` Required	`string`	`TECH_RESEARCH_TECHNICAL_BACKGROUND`	Catalog identifier TECH_RESEARCH_TECHNICAL_BACKGROUND/TECH_RESEARCH_MARKET_ANALYSIS/TECH_RESEARCH_TECHNOLOGY_STATUS_CHALLENGES/TECH_RESEARCH_EVOLUTION_PATH/TECH_RESEARCH_HEAD_PLAYER_ANALYSIS/TECH_RESEARCH_TECHNICAL_SCHEME_REVIEW/TECH_RESEARCH_KEY_PATENT_INTERPRETATION/TECH_RESEARCH_IDEA_SUMMARY/TECH_RESEARCH_CUSTOM_MODULE_1/TECH_RESEARCH_CUSTOM_MODULE_2 Only TECH_RESEARCH_CUSTOM_MODULE_1/TECH_RESEARCH_CUSTOM_MODULE_2 can be modified
`name` Required	`string`	`关于提高锂电池能量密度的研究`	Directory name
`source_type` Required	`string`	`model`	Directory type
`report_id` Required	`string`	`67bfdb99-fd1c-4a7e-819e-2218f976378c`	Create the ID of the quick-search report
`technical_issues` Required	`string`	`关于提高锂电池能量密度的研究`	Technical issues requiring the creation of quick-search reports

Request Example

Example request body for this API endpoint

JSON

{
  "report_id": "67bfdb99-fd1c-4a7e-819e-2218f976378c",
  "technical_issues": "关于提高锂电池能量密度的研究",
  "analysis_directory": [
    {
      "key": "TECH_RESEARCH_TECHNICAL_BACKGROUND",
      "name": "关于提高锂电池能量密度的研究",
      "source_type": "model"
    }
  ]
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`report_id`	`string`	`67bfdb99-fd1c-4a7e-819e-2218f976378c`	Create the ID of the quick-search report
`analysis_directory`	`array`	[ { "key": "TECH_RESEARCH_TECHNICAL_BACKGROUND", "name": "锂电池能量密度背景与目标", "source_type": "model" }, { "key": "TECH_RESEARCH_MARKET_ANALYSIS", "name": "锂电池市场需求分析", "source_type": "model" }, { "key": "TECH_RESEARCH_TECHNOLOGY_STATUS_CHALLENGES", "name": "能量密度提升技术挑战", "source_type": "model" }, { "key": "TECH_RESEARCH_EVOLUTION_PATH", "name": "锂电池能量密度演进路径", "source_type": "model" }, { "key": "TECH_RESEARCH_HEAD_PLAYER_ANALYSIS", "name": "高能量密度电池企业分析", "source_type": "model" }, { "key": "TECH_RESEARCH_TECHNICAL_SCHEME_REVIEW", "name": "提高能量密度技术方案", "source_type": "model" }, { "key": "TECH_RESEARCH_KEY_PATENT_INTERPRETATION", "name": "高能量密度电池核心技术", "source_type": "model" }, { "key": "TECH_RESEARCH_IDEA_SUMMARY", "name": "能量密度提升创新方向", "source_type": "model" }, { "key": "TECH_RESEARCH_CUSTOM_MODULE_1", "name": "能量密度与安全性平衡", "source_type": "customize" }, { "key": "TECH_RESEARCH_CUSTOM_MODULE_2", "name": "高能量密度电池应用场景", "source_type": "customize" } ]	Create the directory of the quick-search report
`key` Required	`string`	`TECH_RESEARCH_TECHNICAL_BACKGROUND`	Catalog identifier TECH_RESEARCH_TECHNICAL_BACKGROUND/TECH_RESEARCH_MARKET_ANALYSIS/TECH_RESEARCH_TECHNOLOGY_STATUS_CHALLENGES/TECH_RESEARCH_EVOLUTION_PATH/TECH_RESEARCH_HEAD_PLAYER_ANALYSIS/TECH_RESEARCH_TECHNICAL_SCHEME_REVIEW/TECH_RESEARCH_KEY_PATENT_INTERPRETATION/TECH_RESEARCH_IDEA_SUMMARY/TECH_RESEARCH_CUSTOM_MODULE_1/TECH_RESEARCH_CUSTOM_MODULE_2 Only TECH_RESEARCH_CUSTOM_MODULE_1/TECH_RESEARCH_CUSTOM_MODULE_2 can be modified
`name` Required	`string`	`关于提高锂电池能量密度的研究`	Directory name
`source_type` Required	`string`	`model`	Directory type
`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": {
    "report_id": "67bfdb99-fd1c-4a7e-819e-2218f976378c",
    "analysis_directory": [
      {
        "key": "TECH_RESEARCH_TECHNICAL_BACKGROUND",
        "name": "关于提高锂电池能量密度的研究",
        "source_type": "model"
      }
    ]
  },
  "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