https://api.nexscope.ai/api/skill-api/v1/skills/zhihuiya-utility-patent-image-search/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/zhihuiya-utility-patent-image-search/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
url | string | required | Image URL (maximum 1,000 characters) Example: https://m.media-amazon.com/images/I/719mRAn2VrL._AC_SL1500_.jpg |
patentType | string | required | Patent type: U for a utility model patent. Default: U Example: U |
model | integer | required | Image-search model. Design patents: 1 (smart association, recommended) or 2 (search this image). Utility model patents: 3 (match shape) or 4 (match shape, pattern, and color; recommended) Example: 4 |
country | string | optional | Patent authority codes for countries, organizations, or regions, separated by commas, for example CN,US,JP. Omit to search all patent authorities |
loc | string | optional | LOC classifications (Locarno classification numbers). Join multiple classifications with AND, OR, or NOT |
legalStatus | string | optional | Comma-separated patent legal-status codes. Values: 1 (published), 2 (substantive examination), 3 (granted), 8 (duplicate-grant avoidance), 11 (withdrawn), 12 (withdrawn-unspecified), 17 (deemed withdrawn), 18 (voluntarily withdrawn), 13 (rejected), 14 (fully revoked), 15 (expired), 16 (annual fee unpaid), 21 (rights restored), 22 (rights terminated), 23 (partially invalid), 24 (application terminated), 30 (abandoned), 19 (deemed abandoned), 20 (voluntarily abandoned), 25 (abandoned-unspecified), 222 (PCT did not enter designated state within designation period), 223 (PCT entered designated state within designation period), 224 (PCT entered designated state after designation period), and 225 (PCT did not enter designated state after designation period) |
simpleLegalStatus | string | optional | Comma-separated simplified patent legal-status codes. Values: 0 (inactive), 1 (active), 2 (pending), 220 (PCT designation period expired), 221 (within PCT designation period), and 999 (unconfirmed) |
assignees | string | optional | Applicant or patent owner (maximum 1,000 characters) |
applyStartTime | string | optional | Patent application start date in yyyyMMdd format |
applyEndTime | string | optional | Patent application end date in yyyyMMdd format |
publicStartTime | string | optional | Patent publication start date in yyyyMMdd format |
publicEndTime | string | optional | Patent publication end date in yyyyMMdd format |
limit | integer | optional | Number of patents to return, from 1 to 100. Default: 10 Example: 10 |
offset | integer | optional | Result offset, from 0 to 1,000. Default: 0 Example: 0 |
field | string | optional | Result sort field: SCORE (relevance), APD (application date), PBD (publication date), or ISD (grant date). Default: SCORE |
order | string | optional | Available when field is APD, PBD, or ISD: desc (descending) or asc (ascending). Default: desc |
lang | string | optional | Preferred title language: original (original patent title), cn (Chinese-translated title), or en (English-translated title). Default: original |
preFilter | integer | optional | Whether to enable country/LOC pre-filtering: 1 for enabled and 0 for disabled. Default: 1 Example: 1 |
stemming | integer | optional | Whether to enable stemming: 1 for enabled and 0 for disabled. Default: 0 Example: 0 |
mainField | string | optional | Primary patent fields, including title, abstract, claims, specification, publication number, application number, applicant, inventor, and IPC/UPC/LOC classifications (maximum 1,000 characters) |
includeMachineTranslation | boolean | optional | Include machine-translated data in the search Example: false |
scoreExpansion | boolean | optional | Score expansion Example: false |
isHttps | integer | optional | Whether to return images over HTTPS: 1 for HTTPS and 0 for HTTP. Default: 0 Example: 0 |
returnImgId | boolean | optional | Whether to return img_id. Default: false Example: false |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"allRecordsCount": 1,
"columns": [],
"costToken": 1,
"data": [
{
"apdt": 1,
"imgId": "example-id",
"loc": [],
"locMatch": 1,
"patentId": "example-id",
"pbdt": 1,
"score": 1,
"url": "https://example.com/image.jpg"
}
],
"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.allRecordsCount | integer | optional | Total number of matching records in the database Example: 1 |
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 | Matching patent records Example: [] |
data.data[] | object | required | Item in data data. |
data.data[].apdt | integer | optional | Application date (timestamp) Example: 1 |
data.data[].apno | string | optional | Application number Example: null |
data.data[].authority | string | optional | Patent authority (country code) Example: null |
data.data[].currentAssignee | string | optional | Current assignee Example: null |
data.data[].imgId | string | optional | Patent drawing img_id, returned only when returnImgId is true Example: example-id |
data.data[].inventor | string | optional | Inventor Example: null |
data.data[].loc | array | optional | LOC classification (Locarno classification number) Example: [] |
data.data[].locMatch | integer | optional | Whether a high-weight LOC class matched: 1 for matched and 0 for not matched. Available only when model=1 and field=SCORE Example: 1 |
data.data[].originalAssignee | string | optional | Original assignee Example: null |
data.data[].patentId | string | optional | Similar patent ID Example: example-id |
data.data[].patentPn | string | optional | Similar patent number Example: null |
data.data[].pbdt | integer | optional | Publication date (timestamp) Example: 1 |
data.data[].score | number | optional | Similarity score; higher values indicate greater similarity. Available only when field is SCORE Example: 1 |
data.data[].title | string | optional | Patent title Example: null |
data.data[].url | string | optional | URL of the similar patent drawing Example: https://example.com/image.jpg |
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 records returned in this response 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 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
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.