https://api.nexscope.ai/api/skill-api/v1/skills/patent-cited-by/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/patent-cited-by/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
patentId | string | conditional | One or up to 100 comma-separated PatSnap patent IDs. Takes precedence when both identifiers are provided. Example: patent-id |
patentNumber | string | conditional | One or up to 100 comma-separated publication or grant numbers. Example: US10123456B2 |
Request example
{
"patentNumber": "US10123456B2"
}Response body
Returns the PatSnap cited-by payload directly.
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Number of returned patent records. Example: 1 |
data | array | optional | Cited-by results. Example: [] |
data[].patentId | string | optional | Queried patent ID. Example: patent-id |
data[].pn | string | optional | Queried publication number. Example: US10123456B2 |
data[].citedBy3y | integer | optional | Citations received within three years. Example: 1 |
data[].citedBy5y | integer | optional | Citations received within five years. Example: 1 |
data[].citedByPatents | array | optional | Patents that cite the queried patent. Example: [] |
columns | array | optional | Provider rendering columns. Example: [] |
costToken | integer | optional | Provider-reported token cost. Example: 6000 |
errcode | integer | optional | Upstream status code returned by the provider. |
errmsg | string | optional | Upstream status message returned by the provider. |
code | string | optional | Provider-specific status code. |
msg | string | optional | Provider-specific status message. |
message | string | optional | Provider-specific message. |
type | string | optional | Provider-specific render or payload type. |
title | string | optional | Provider-specific response title. |
sourceType | string | optional | Provider-specific source platform type. |
sourceTool | string | optional | Provider-specific source tool name. |
costTime | integer | optional | Execution time reported by the upstream provider. |
page | integer | optional | Current page returned by the upstream provider. |
pageSize | integer | optional | Page size returned by the upstream provider. |
pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. |
totalPage | integer | optional | Total page count returned by the upstream provider. |
dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. |
Response example
Direct response payload. No extra wrapper is added.
{
"total": 1,
"data": [
{
"patentId": "patent-id",
"pn": "US10123456B2",
"citedBy3y": 1,
"citedBy5y": 1,
"citedByPatents": []
}
],
"columns": [],
"costToken": 6000
}Responses
| Code | Description |
|---|---|
| 200 | API executed successfully. Body is the direct response payload. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.