POST
https://api.nexscope.ai/api/skill-api/v1/skills/ruiguan-detection-patent-design/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/ruiguan-detection-patent-design/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
imageUrl | string | required | Product image URL used for comparison with the patent database (maximum 1,000 characters) Example: https://m.media-amazon.com/images/I/719mRAn2VrL._AC_SL1500_.jpg |
queryMode | string | required | Search mode: physical for product-photo search, line for line-drawing search, or hybrid for combined search. Maximum 1,000 characters Example: physical |
topNumber | integer | required | Number of patents to return (maximum 100) Example: 10 |
regions | string | optional | Country or region codes where the product is sold, separated by commas, for example US,EU,CN. Maximum 1,000 characters Available options
Example: US |
productTitle | string | optional | Product title used to provide additional search context (maximum 1,000 characters) Example: Magnetic phone case |
productDescription | string | optional | Product description used to provide additional search context (maximum 1,000 characters) Example: A protective smartphone case with a magnetic ring stand and shockproof corners. |
patentStatus | string | optional | Patent-validity filter: 1 for active patents, 0 for inactive patents, or 1,0 for all patents. Maximum 1,000 characters Example: 1,0 |
enableRadar | boolean | optional | Whether to enable AI radar analysis for potential infringement Example: false |
topLoc | string | optional | Top-level LOC classes to search, for example 06,07. Pattern: ^(0[1-9]\ |
sourceLanguage | string | optional | Source-language code used to translate content into English, for example zh-CN. Leave empty when the text is already English. Maximum 1,000 characters |
Code example
{
"enableRadar": false,
"imageUrl": "https://m.media-amazon.com/images/I/719mRAn2VrL._AC_SL1500_.jpg",
"patentStatus": "1,0",
"productDescription": "A protective smartphone case with a magnetic ring stand and shockproof corners.",
"productTitle": "Magnetic phone case",
"queryMode": "physical",
"regions": "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",
"estimatedDueDate": "2026-01-01",
"globalImageId": "example-id",
"globalPatentId": "example-id",
"grantDate": "2026-01-01",
"images": [],
"inventors": [],
"patentFamily": [],
"patentImageUrl": "https://example.com/image.jpg",
"publicationDate": "2026-01-01",
"radarResult": {
"same": false
},
"troCase": false,
"troHolder": false
}
],
"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 | Column definitions used for rendering Example: [] |
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.costToken | integer | optional | Tokens consumed Example: 1 |
data.data | array | optional | Patent records; see the patent fields below Example: [] |
data.data[] | object | required | Item in data data. |
data.data[].abstracts | string | optional | Patent abstract Example: null |
data.data[].applicantAddresses | array | optional | Applicant addresses Example: [] |
data.data[].applicants | array | optional | Applicants Example: [] |
data.data[].applicationDate | string | optional | Patent application date Example: 2026-01-01 |
data.data[].applicationNumber | string | optional | Patent application number Example: null |
data.data[].estimatedDueDate | string | optional | Estimated expiration date Example: 2026-01-01 |
data.data[].globalImageId | string | optional | Patent image ID Example: example-id |
data.data[].globalPatentId | string | optional | Global patent ID Example: example-id |
data.data[].grantDate | string | optional | Patent grant date Example: 2026-01-01 |
data.data[].images | array | optional | Patent image URLs Example: [] |
data.data[].inventors | array | optional | Inventors Example: [] |
data.data[].isSketchText | string | optional | Whether the image is a line drawing Example: null |
data.data[].locOneInfo | string | optional | Top-level LOC details Example: null |
data.data[].locTwoInfo | string | optional | Second-level LOC details Example: null |
data.data[].patentFamily | array | optional | Patent family Example: [] |
data.data[].patentImageUrl | string | optional | URL of the patent drawing most similar to the product image Example: https://example.com/image.jpg |
data.data[].patentLoc | string | optional | LOC classifications for the patent, separated by commas Example: null |
data.data[].patentProd | string | optional | Patent title in English Example: null |
data.data[].patentProdCn | string | optional | Patent title in Chinese Example: null |
data.data[].patentValidity | string | optional | Patent validity Example: null |
data.data[].publicationDate | string | optional | Patent publication date Example: 2026-01-01 |
data.data[].publicationNumber | string | optional | Patent publication number Example: null |
data.data[].radarResult | object | optional | AI radar analysis result Example: {} |
data.data[].radarResult.exp | string | optional | Radar decision explanation Example: null |
data.data[].radarResult.same | boolean | optional | Whether infringement is suspected Example: false |
data.data[].registrationOfficeCode | string | optional | Patent registration office Example: null |
data.data[].similarity | string | optional | Similarity between the patent and product image (0-1) Example: null |
data.data[].specification | string | optional | Patent specification Example: null |
data.data[].troCase | boolean | optional | Whether the patent has a history of TRO enforcement Example: false |
data.data[].troHolder | boolean | optional | Whether the patent belongs to a TRO rights holder Example: false |
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 | Total number of patent records returned Example: 1 |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.type | string | optional | 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.