Patsnap Tech Pre-research Report API

openapi: 3.1.0
info:
  title: Patsnap Open Platform AI Translation Tech Pre-research Report API
  version: 1.0.0
  description: OpenAPI specification for Patsnap Open Platform APIs, including patent search, analytics, and Eureka AI capabilities.
servers:
- url: https://connect.patsnap.com
  description: Patsnap Open Platform API gateway
tags:
- name: Tech Pre-research Report
  description: Tech Pre-research Report APIs.
paths:
  /ai/quick-search-report/creation/custom-dir:
    post:
      operationId: ai34-2CreationCustomDir
      summary: AI34-2 Quick-search report creation - custom directory(Beta)
      description: Based on the input directory related to a certain technology, generate the pre-research report of that technology.
      tags:
      - Tech Pre-research Report
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Successful ai34-2 quick-search report creation - custom directory(beta) response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AI34-2CreationCustomDirResponse'
        '201':
          description: Created.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '404':
          description: Not Found.
      externalDocs:
        description: API Reference documentation
        url: https://open.patsnap.com/devportal/api-reference/ai/quick-search-report/creation/custom-dir
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AI34-2CreationCustomDirRequest'
  /ai/quick-search-report/query:
    get:
      operationId: ai34-3QuickSearchReportQuery
      summary: AI34-3 Quick-search report Query(Beta)
      description: Query the status of report generation by using the report ID generated through the creation of the pre-research report interface.
      tags:
      - Tech Pre-research Report
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Successful ai34-3 quick-search report query(beta) response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AI34-3QuickSearchReportQueryResponse'
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '404':
          description: Not Found.
      externalDocs:
        description: API Reference documentation
        url: https://open.patsnap.com/devportal/api-reference/ai/quick-search-report/query
      parameters:
      - name: report_id
        in: query
        required: true
        description: report_id
        schema:
          type: string
          example: f70a279b-c000-4a6d-8319-61672debd623
          description: report_id
  /ai/quick-search-report/creation:
    post:
      operationId: ai34-1QuickSearchReportCreation
      summary: AI34-1 Quick-search report creation(Beta)
      description: Based on the input question related to a certain technology, generate the pre-research report of that technology.
      tags:
      - Tech Pre-research Report
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Successful ai34-1 quick-search report creation(beta) response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AI34-1QuickSearchReportCreationResponse'
        '201':
          description: Created.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '404':
          description: Not Found.
      externalDocs:
        description: API Reference documentation
        url: https://open.patsnap.com/devportal/api-reference/ai/quick-search-report/creation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AI34-1QuickSearchReportCreationRequest'
components:
  schemas:
    AI34-2CreationCustomDirResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AI34-2CreationCustomDir_QuickSearchReportResponse'
        status:
          type: boolean
          example: 'false'
          description: Status
        error_msg:
          type: string
          example: The request parameter format is incorrect！
          description: Error Message
        error_code:
          type: integer
          example: '0'
          description: Error Code
      required:
      - status
      - error_code
    AI34-3QuickSearchReportQueryResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AI34-3QuickSearchReportQuery_QueryQuickSearchReportResponse'
        status:
          type: boolean
          example: 'false'
          description: Status
        error_msg:
          type: string
          example: The request parameter format is incorrect！
          description: Error Message
        error_code:
          type: integer
          example: '0'
          description: Error Code
      required:
      - status
      - error_code
    AI34-1QuickSearchReportCreation_QuickSearchReportResponse:
      type: object
      properties:
        report_id:
          type: string
          example: 67bfdb99-fd1c-4a7e-819e-2218f976378c
          description: Create the ID of the quick-search report
        analysis_directory:
          type: array
          example:
          - 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
          description: Create the directory of the quick-search report
          items:
            $ref: '#/components/schemas/AI34-1QuickSearchReportCreation_AnalysisDirectoryDTO'
    AI34-2CreationCustomDir_QuickSearchReportResponse:
      type: object
      properties:
        report_id:
          type: string
          example: 67bfdb99-fd1c-4a7e-819e-2218f976378c
          description: Create the ID of the quick-search report
        analysis_directory:
          type: array
          example:
          - 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
          description: Create the directory of the quick-search report
          items:
            $ref: '#/components/schemas/AI34-2CreationCustomDir_AnalysisDirectoryDTO'
    AI34-3QuickSearchReportQuery_QueryQuickSearchReportResponse:
      type: object
      properties:
        report_url:
          type: string
          example: https://cn-patsnap-export.cdn.zhihuiya.com/7/20250226/eureka/scvdd%3D804a58753458dae8017e32ddb27c5d5cc01d285f
          description: URL of the quick-search report
        report_status:
          type: string
          example: SUCCEED
          description: Return status value（SUCCEED,RUNNING,FAILED）
        head_player_analysis:
          type: object
          example:
            head_player_analysis: {}
          description: Head player analysis
        key_patent_interpretation:
          type: object
          example:
            key_patent_interpretation: {}
          description: Key patent interpretation
    AI34-2CreationCustomDirRequest:
      type: object
      properties:
        analysis_directory:
          type: array
          example:
          - 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
          description: Create the directory of the quick-search report
          items:
            $ref: '#/components/schemas/AI34-2CreationCustomDir_AnalysisDirectoryDTO'
        report_id:
          type: string
          example: 67bfdb99-fd1c-4a7e-819e-2218f976378c
          description: Create the ID of the quick-search report
        technical_issues:
          type: string
          example: 关于提高锂电池能量密度的研究
          description: Technical issues requiring the creation of quick-search reports
      required:
      - analysis_directory
      - report_id
      - technical_issues
    AI34-1QuickSearchReportCreationRequest:
      type: object
      properties:
        auto_directory:
          type: boolean
          example: true
          description: Whether to automatically generate directories
        technical_issues:
          type: string
          example: 关于提高锂电池能量密度的研究
          description: Technical issues requiring the creation of quick-search reports
      required:
      - technical_issues
    AI34-1QuickSearchReportCreation_AnalysisDirectoryDTO:
      type: object
      properties:
        key:
          type: string
          example: TECH_RESEARCH_TECHNICAL_BACKGROUND
          description: 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:
          type: string
          example: 关于提高锂电池能量密度的研究
          description: Directory name
        source_type:
          type: string
          example: model
          description: Directory type
      required:
      - key
      - name
      - source_type
    AI34-2CreationCustomDir_AnalysisDirectoryDTO:
      type: object
      properties:
        key:
          type: string
          example: TECH_RESEARCH_TECHNICAL_BACKGROUND
          description: 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:
          type: string
          example: 关于提高锂电池能量密度的研究
          description: Directory name
        source_type:
          type: string
          example: model
          description: Directory type
      required:
      - key
      - name
      - source_type
    AI34-1QuickSearchReportCreationResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AI34-1QuickSearchReportCreation_QuickSearchReportResponse'
        status:
          type: boolean
          example: 'false'
          description: Status
        error_msg:
          type: string
          example: The request parameter format is incorrect！
          description: Error Message
        error_code:
          type: integer
          example: '0'
          description: Error Code
      required:
      - status
      - error_code
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer