[P067]Patent/Paper Markdown Fetch Tool

post
https://connect.patsnap.com/data-pd/convert/markdown/fetch
Try in Sandbox

A patent and paper data reading tool designed for AI Agents. Batch fetches Markdown-formatted data based on input key list (url or patent publication number pn), facilitating AI content analysis, reasoning and Q&A. Supports modular queries (basic/citation/legal/family), image processing and content compression.

Supports batch fetching of patent or paper data in Markdown format. Maximum 100 keys per request, 10-20 recommended. Input keys support two formats: url (containing patentId or paperId) and patent publication number (pn).

Request Parameters

List of parameters supported by this API endpoint

NameTypeExampleDescription
keys
Required
array[ "https://eureka.zhihuiya.com/view/#/fullText'figures/?patentId=07c38692-9ccf-4ead-8f0f-484f7aa929b7" ]
Key list (url containing patentId or paperId, or patent publication number pn). Limit: 1-100, recommended 10-20.
key_type
stringurl
Key type. url: url containing patentId or paperId; pn: patent publication number
compress
boolean-
Whether to compress returned Markdown content (using gzip+base64 encoding), recommended when response content is large
include_images
boolean-
Whether to include image links (only valid for patents, image URLs will be automatically signed)
module
array[ "basic", "citation", "legal", "family" ]
Query module list. Patent options: basic, citation, legal, family; Paper options: basic. Default: basic module
include_structured
boolean-
Whether to return structured raw JSON data (structured field), default false. Enable when raw structured data is needed for secondary processing

Response Schema

Structure of the API response data

Field NameTypeExampleDescription
total
integer<int32>2
Total number of submitted keys
results
array[ { "key": "https://eureka.zhihuiya.com/view/#/fullText'figures/?patentId=07c38692-9ccf-4ead-8f0f-484f7aa929b7", "images": [ { "image_id": "HDA0003320126060000011", "image_url": "https://example.com/image.png" } ], "source": "patent", "message": "获取成功", "modules": [ "basic", "citation", "legal", "family" ], "success": true, "compress": false, "key_type": "url", "markdown": "# 专利详细信息\n\n## 基本信息\n...", "structured": {} } ]
Result list containing detailed results for each key
key
stringhttps://eureka.zhihuiya.com/view/#/fullText'figures/?patentId=07c38692-9ccf-4ead-8f0f-484f7aa929b7
Original input key (url or patent publication number pn)
images
array[ { "image_id": "HDA0003320126060000011", "image_url": "https://example.com/image.png" } ]
Image info list (only available for patents when include_images=true)
image_id
stringHDA0003320126060000011
Image ID
image_url
stringhttps://example.com/image.png
Image URL (signed)
source
stringpatent
Data source type: patent or paper
message
string获取成功
Processing message (success or failure reason)
modules
array[ "basic", "citation", "legal", "family" ]
Query module list
success
booleantrue
Whether fetch was successful
compress
boolean-
Whether markdown content is compressed (gzip+base64)
key_type
stringurl
Key type (url or pn)
markdown
string# 专利详细信息 ## 基本信息 ...
Converted Markdown content
structured
object{ "basic": { "title": "专利标题", "abstract": "专利摘要...", "patent_id": "07c38692-9ccf-4ead-8f0f-484f7aa929b7" } }
Structured raw JSON data grouped by module (basic/citation/legal/family), unrequested modules are null; only available when include_structured=true
time_cost
number<double>12.5
Total time cost (seconds)
failed_count
integer<int32>-
Number of failed items
success_count
integer<int32>2
Number of successfully fetched items

Success Response Example

Example of a successful API response

JSON
{
  "total": 2,
  "status": true,
  "results": [
    {
      "key": "https://eureka.zhihuiya.com/view/#/fullText'figures/?patentId=07c38692-9ccf-4ead-8f0f-484f7aa929b7",
      "images": [
        {
          "image_id": "HDA0003320126060000011",
          "image_url": "https://example.com/image.png"
        }
      ],
      "source": "patent",
      "message": "获取成功",
      "modules": [
        "basic",
        "citation",
        "legal",
        "family"
      ],
      "success": true,
      "compress": false,
      "key_type": "url",
      "markdown": "# 专利详细信息\n\n## 基本信息\n...",
      "structured": {
        "basic": {
          "title": "专利标题",
          "abstract": "专利摘要...",
          "patent_id": "07c38692-9ccf-4ead-8f0f-484f7aa929b7"
        }
      }
    }
  ],
  "time_cost": 12.5,
  "error_code": 0,
  "failed_count": 0,
  "success_count": 2
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error CodeDescription
68300004Invalid parameter!
68300005Search api failure!
68300006Analytic basic access error!
68300007Bad request!
68300008Service error, please try again later!
68300010The file does not comply with upload specifications!

Platform Errors

Error CodeDescription
67200000API call exceeds the total limit set by the platform!
67200001API call exceeds the total limit set by the platform!
67200002The current call rate is too fast, exceeding the current configuration limit QPS!
67200003The key and secret parameters for applying for the token are incorrect or the client has been disabled!
67200004The requested api does not have permission. Please contact our support personnel!
67200005Insufficient account balance/number of calls!
67200006The client has exceeded the activation validity period!
67200007The current call exceeds the configured usage limit of the day!
67200008Please check if the required apikey in the query parameter has been transmitted!
67200009The apikey does not match the passed bearerToken. Please check if a valid token is being used!
67200012The request is illegal!
67200100The current server status is busy, request response timeout!
67200101The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status CodeDescription
0Success
401Unauthorized
403Forbidden
404Not Found
422Validation Error