POST
https://api.nexscope.ai/api/skill-api/v1/skills/utility-patent-detector/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/utility-patent-detector/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
productTitle | string | required | Product title, max 1000 characters Example: Magnetic phone case with ring stand |
productDescription | string | required | Product description, max 1000 characters Example: A protective smartphone case with a magnetic ring stand and shockproof corners. |
region | string | required | Country/region code(s) where the product is intended for sale, multiple separated by commas. Currently supports US. Default US Example: US |
topNumber | integer | required | Number of results to recall, range: 10--200, default 100 Example: 10 |
Code example
{
"productDescription": "A protective smartphone case with a magnetic ring stand and shockproof corners.",
"productTitle": "Magnetic phone case with ring stand",
"region": "US",
"topNumber": 10
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"columns": [],
"costToken": 1,
"data": [
{
"applicantAddresses": [],
"applicants": [],
"applicationDate": "2026-01-01",
"classNumList": [],
"cpcKindRaw": [],
"estimatedDueDate": "2026-01-01",
"globalUtilityId": "example-id",
"images": [],
"inventorAddresses": [],
"inventors": [],
"patentImageUrl": "https://example.com/image.jpg",
"priorityNumber": [],
"publicationDate": "2026-01-01",
"region": "US",
"relatedPublicationDate": [],
"similarity": 1,
"troCase": false,
"troHolder": false
}
],
"detectId": "example-id",
"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 | Render column definitions Example: [] |
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.costToken | integer | optional | Token cost Example: 1 |
data.data | array | optional | Patent list (see below) Example: [] |
data.data[] | object | required | Item in data data. |
data.data[].applicantAddresses | array | optional | Rights holder addresses, array format Example: [] |
data.data[].applicants | array | optional | Applicants and countries concatenated, array format Example: [] |
data.data[].applicationDate | string | optional | Application date (yyyy-MM-dd) Example: 2026-01-01 |
data.data[].applicationNumber | string | optional | Application number Example: null |
data.data[].claims | string | optional | Claims Example: null |
data.data[].claimsCn | string | optional | Claims (Chinese) Example: null |
data.data[].classNumList | array | optional | Classification number path list, format: classNum1 > classNum2 > classNum3 Example: [] |
data.data[].cpcKindRaw | array | optional | CPC classification (raw JSONArray) Example: [] |
data.data[].estimatedDueDate | string | optional | Estimated expiration date (yyyy-MM-dd) Example: 2026-01-01 |
data.data[].globalUtilityId | string | optional | Patent ID Example: example-id |
data.data[].images | array | optional | Patent drawings Example: [] |
data.data[].inventorAddresses | array | optional | Inventor addresses, array format Example: [] |
data.data[].inventors | array | optional | Inventors and countries concatenated, array format Example: [] |
data.data[].patentAbstract | string | optional | Abstract Example: null |
data.data[].patentAbstractCn | string | optional | Abstract (Chinese) Example: null |
data.data[].patentImageUrl | string | optional | Patent cover image Example: https://example.com/image.jpg |
data.data[].patentValidity | string | optional | Patent validity: Active or Invalid Example: null |
data.data[].priorityNumber | array | optional | Priority numbers, array format Example: [] |
data.data[].publicationDate | string | optional | Publication date (yyyy-MM-dd) Example: 2026-01-01 |
data.data[].publicationNumber | string | optional | Publication number Example: null |
data.data[].region | string | optional | Receiving office Example: US |
data.data[].relatedPublicationDate | array | optional | First publication dates (yyyy-MM-dd), array format Example: [] |
data.data[].similarity | number | optional | Similarity between the product and this patent (0--1) Example: 1 |
data.data[].specification | string | optional | Specification Example: null |
data.data[].specificationCn | string | optional | Specification (Chinese) Example: null |
data.data[].title | string | optional | Utility patent title Example: null |
data.data[].titleCn | string | optional | Utility patent title (Chinese) Example: null |
data.data[].troCase | boolean | optional | Whether there is a TRO enforcement history Example: false |
data.data[].troHolder | boolean | optional | Whether it is a patent of a TRO rights holder Example: false |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
data.detectId | string | optional | Detection ID Example: example-id |
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 | Record count Example: 1 |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.type | string | optional | Render 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.