POST
https://api.nexscope.ai/api/skill-api/v1/skills/patent-references/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/patent-references/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
patentId | string | conditional | One or up to 100 Nexscope patent IDs separated by English commas; maximum 60,000 characters. Takes precedence when both identifiers are provided. Example: patent-id |
patentNumber | string | conditional | One or up to 100 publication or grant numbers separated by English commas; maximum 60,000 characters. Example: US10123456B2 |
Code example
{
"patentNumber": "US10123456B2"
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"columns": [],
"costToken": 6000,
"data": [
{
"citedOthers": [],
"citedPatents": [],
"patentId": "patent-id",
"pn": "US10123456B2"
}
],
"total": 1
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.columns | array | optional | Provider rendering columns. Example: [] |
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.costToken | integer | optional | Provider-reported token cost. Example: 6000 |
data.data | array | optional | Patent reference records. Example: [] |
data.data[] | object | required | Item in data data. |
data.data[].citedOthers | array | optional | Cited non-patent literature. Example: [] |
data.data[].citedPatents | array | optional | Cited patent references. Example: [] |
data.data[].patentId | string | optional | Queried patent ID. Example: patent-id |
data.data[].pn | string | optional | Publication number. Example: US10123456B2 |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.title | string | optional | Provider-specific response title. Example: null |
data.total | integer | optional | Number of returned records. Example: 1 |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.type | string | optional | Provider rendering style. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Responses
| Code | Description |
|---|---|
| 200 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 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.