POST
https://api.nexscope.ai/api/skill-api/v1/skills/1688-search-by-image/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/1688-search-by-image/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
imageUrl | string | optional | Valid, publicly accessible image URL (maximum 1,000 characters). Supported formats: PNG, JPG, and JPEG; WEBP and GIF are not supported. Provide exactly one of imageUrl, imageBase64, or imageId Example: https://m.media-amazon.com/images/I/61v6nYvQ7+L._AC_SL1500_.jpg |
imageBase64 | string | optional | Raw Base64-encoded image content without a data:image/jpeg;base64, prefix. Supported formats: PNG, JPG, and JPEG. |
imageId | string | optional | 1688 image ID. Image-search results also return this value; include it when page is greater than 1 to improve response time |
page | integer | optional | Page number starting from 1 Example: 1 |
pageSize | integer | optional | Number of products per page, maximum 50 Example: 10 |
priceStart | string | optional | Minimum price in CNY, for example 10 |
priceEnd | string | optional | Maximum price in CNY, for example 100 |
filter | string | optional | Comma-separated filter conditions. Use the supported filter values documented for this endpoint |
sort | string | optional | Sort condition as JSON in the form {field: direction}. Fields: price, rePurchaseRate, or monthSold. Directions: asc or desc |
keyword | string | optional | Keyword used to search within the results Example: phone case |
productCollectionId | string | optional | Single product-collection ID. Use a supported collection ID documented for this endpoint Example: example-id |
Request example
{
"imageUrl": "https://m.media-amazon.com/images/I/61v6nYvQ7+L._AC_SL1500_.jpg",
"pageSize": 10,
"page": 1
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | any | required | Data value used by this API operation. |
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
msg | string | null | required | Msg value used by this API operation. |
ts | string | required | Epoch milliseconds. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
traceId | string | null | required | Trace id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.imageId | string | optional | Uploaded image ID; send it with paginated requests to improve response time Example: example-id |
data.total | integer | optional | Number of products on this page Example: 1 |
data.totalPage | integer | optional | Total number of pages Example: 1 |
data.sourceType | string | optional | Source type; fixed value "1688" Example: null |
data.type | string | optional | Rendering style; fixed value "productWorkbenches" Example: null |
data.columns | array | optional | Column definitions used for rendering Example: [] |
data.costToken | integer | optional | Tokens consumed Example: 1 |
data.products | array | optional | Product list; see the product fields below Example: [] |
data.offerId | string | optional | Product ID Example: example-id |
data.asin | string | optional | Product identifier, same as offerId Example: B072MQ5BRX |
data.imageUrl | string | optional | Product image URL Example: https://example.com/image.jpg |
data.title | string | optional | Product title Example: null |
data.price | number | optional | Wholesale price in CNY Example: 1 |
data.consignPrice | number | optional | Single-item dropshipping price in CNY Example: 1 |
data.salesQuantity | integer | optional | Monthly units sold Example: 1 |
data.estimatedSalesAmount | number | optional | Estimated sales revenue Example: 1 |
data.asinUrl | string | optional | Product URL Example: B072MQ5BRX |
data.products[].isOnePsale | string | optional | Whether single-item dropshipping is available Example: null |
data.products[].isJxhy | string | optional | Whether the product is a selected supply source Example: null |
data.products[].sellerIdentities | string | optional | Seller identities, such as Super Factory, Verified Supplier, or TrustPass member Example: null |
data.products[].offerIdentities | string | optional | Product badge, such as Strict Selection Example: null |
data.products[].repurchaseRate | string | optional | Repurchase rate Example: null |
data.products[].tradeScore | string | optional | Product transaction score Example: null |
data.products[].compositeServiceScore | string | optional | Composite service-experience score Example: null |
data.products[].sendGoodsAddressText | string | optional | Dispatch location Example: null |
data.products[].deliveryTime | string | optional | Dispatch time, such as 24 or 48 hours Example: null |
data.quantityBegin | integer | optional | Minimum order quantity Example: 1 |
data.products[].hasPromotion | string | optional | Whether a promotion is active Example: null |
data.products[].promotionType | string | optional | Promotion type Example: null |
data.products[].isPatentProduct | string | optional | Whether the product is patented Example: null |
data.products[].isSelect | string | optional | Cross-border Select collection indicator Example: null |
data.products[].currency | string | optional | Currency; fixed value "¥" Example: null |
data.sourceTool | string | optional | Source tool; fixed value identifying 1688 image search Example: null |
data.products[].dataType | string | optional | Data type; fixed value "monthlyData" Example: null |
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.pageSize | integer | optional | Page size 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.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"data": {
"imageId": "example-id",
"total": 1,
"totalPage": 1,
"columns": [],
"costToken": 1,
"products": [],
"offerId": "example-id",
"asin": "B072MQ5BRX",
"imageUrl": "https://example.com/image.jpg",
"price": 1,
"consignPrice": 1,
"salesQuantity": 1,
"estimatedSalesAmount": 1,
"asinUrl": "B072MQ5BRX",
"quantityBegin": 1
},
"code": 0,
"msg": null,
"ts": "0",
"time": "2026-01-01 00:00:00",
"cost": "-1",
"traceId": null
}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.