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 parameters
| Name | Type | Required | Description |
|---|---|---|---|
imageUrl | string | optional | Public HTTP/80 or HTTPS/443 URL, maximum 1,000 characters, without redirects. A sole direct source is checked for PNG/JPEG headers, at most 14.3 MiB, each dimension at most 20,000 and at most 40,000,000 pixels. This is not full pixel-integrity validation. 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 standard Base64 for PNG/JPEG; optional padding and outer whitespace allowed, embedded whitespace and data URI prefixes rejected for a sole direct source. Byte/header limits match imageUrl; at most 19,992,848 Base64 characters after outer whitespace trimming. Provide this as the only image source. |
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; default 20, maximum 50 Example: 20 |
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 |
Code example
{
"imageUrl": "https://m.media-amazon.com/images/I/61v6nYvQ7+L._AC_SL1500_.jpg",
"page": 1,
"pageSize": 20
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"columns": [],
"costToken": 1,
"imageId": "example-id",
"products": [
{
"asin": "example-id",
"asinUrl": "https://detail.1688.com/offer/1040473674152.html",
"consignPrice": 1,
"estimatedSalesAmount": 1,
"imageUrl": "https://example.com/image.jpg",
"offerId": "example-id",
"price": 1,
"quantityBegin": 1,
"salesQuantity": 1
}
],
"total": 1,
"totalPage": 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.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
data.imageId | string | optional | Uploaded image ID; send it with paginated requests to improve response time 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.products | array | optional | Product list; see the product fields below Example: [] |
data.products[] | object | required | Item in data products. |
data.products[].asin | string | optional | Product identifier, same as offerId Example: example-id |
data.products[].asinUrl | string | optional | Product URL Example: https://detail.1688.com/offer/1040473674152.html |
data.products[].compositeServiceScore | string | optional | Composite service-experience score Example: null |
data.products[].consignPrice | number | optional | Single-item dropshipping price in CNY Example: 1 |
data.products[].currency | string | optional | Currency; fixed value "¥" Example: null |
data.products[].dataType | string | optional | Data type; fixed value "monthlyData" Example: null |
data.products[].deliveryTime | string | optional | Dispatch time, such as 24 or 48 hours Example: null |
data.products[].estimatedSalesAmount | number | optional | Estimated sales revenue Example: 1 |
data.products[].hasPromotion | string | optional | Whether a promotion is active Example: null |
data.products[].imageUrl | string | optional | Product image URL Example: https://example.com/image.jpg |
data.products[].isJxhy | string | optional | Whether the product is a selected supply source Example: null |
data.products[].isOnePsale | string | optional | Whether single-item dropshipping is available 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[].offerId | string | optional | Product ID Example: example-id |
data.products[].offerIdentities | string | optional | Product badge, such as Strict Selection Example: null |
data.products[].price | number | optional | Wholesale price in CNY Example: 1 |
data.products[].promotionType | string | optional | Promotion type Example: null |
data.products[].quantityBegin | integer | optional | Minimum order quantity Example: 1 |
data.products[].repurchaseRate | string | optional | Repurchase rate Example: null |
data.products[].salesQuantity | integer | optional | Monthly units sold Example: 1 |
data.products[].sellerIdentities | string | optional | Seller identities, such as Super Factory, Verified Supplier, or TrustPass member Example: null |
data.products[].sendGoodsAddressText | string | optional | Dispatch location Example: null |
data.products[].sourceTool | string | optional | Source tool; fixed value identifying 1688 image search Example: null |
data.products[].sourceType | string | optional | Source type; fixed value "1688" Example: null |
data.products[].title | string | optional | Product title Example: null |
data.products[].tradeScore | string | optional | Product transaction score Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.sourceType | string | optional | Source type; fixed value "1688" Example: null |
data.title | string | optional | Provider-specific response title. Example: null |
data.total | integer | optional | Number of products on this page Example: 1 |
data.totalPage | integer | optional | Total number of pages Example: 1 |
data.type | string | optional | Rendering style; fixed value "productWorkbenches" 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.