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 direct 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
{
"pageSize": 10,
"imageUrl": "https://m.media-amazon.com/images/I/61v6nYvQ7+L._AC_SL1500_.jpg",
"page": 1
}Response body
Returns the documented upstream API response directly without an additional wrapper.
| Name | Type | Required | Description |
|---|---|---|---|
imageId | string | optional | Uploaded image ID; send it with paginated requests to improve response time Example: example-id |
total | integer | optional | Number of products on this page Example: 1 |
totalPage | integer | optional | Total number of pages Example: 1 |
sourceType | string | optional | Source type; fixed value "1688" |
type | string | optional | Rendering style; fixed value "productWorkbenches" |
columns | array | optional | Column definitions used for rendering Example: [] |
costToken | integer | optional | Tokens consumed Example: 1 |
products | array | optional | Product list; see the product fields below Example: [] |
offerId | string | optional | Product ID Example: example-id |
asin | string | optional | Product identifier, same as offerId Example: B072MQ5BRX |
imageUrl | string | optional | Product image URL Example: https://example.com/image.jpg |
title | string | optional | Product title |
price | number | optional | Wholesale price in CNY Example: 1 |
consignPrice | number | optional | Single-item dropshipping price in CNY Example: 1 |
salesQuantity | integer | optional | Monthly units sold Example: 1 |
estimatedSalesAmount | number | optional | Estimated sales revenue Example: 1 |
asinUrl | string | optional | Product URL Example: B072MQ5BRX |
products[].isOnePsale | string | optional | Whether single-item dropshipping is available |
products[].isJxhy | string | optional | Whether the product is a selected supply source |
products[].sellerIdentities | string | optional | Seller identities, such as Super Factory, Verified Supplier, or TrustPass member |
products[].offerIdentities | string | optional | Product badge, such as Strict Selection |
products[].repurchaseRate | string | optional | Repurchase rate |
products[].tradeScore | string | optional | Product transaction score |
products[].compositeServiceScore | string | optional | Composite service-experience score |
products[].sendGoodsAddressText | string | optional | Dispatch location |
products[].deliveryTime | string | optional | Dispatch time, such as 24 or 48 hours |
quantityBegin | integer | optional | Minimum order quantity Example: 1 |
products[].hasPromotion | string | optional | Whether a promotion is active |
products[].promotionType | string | optional | Promotion type |
products[].isPatentProduct | string | optional | Whether the product is patented |
products[].isSelect | string | optional | Cross-border Select collection indicator |
products[].currency | string | optional | Currency; fixed value "¥" |
sourceTool | string | optional | Source tool; fixed value identifying 1688 image search |
products[].dataType | string | optional | Data type; fixed value "monthlyData" |
errcode | integer | optional | Upstream status code returned by the provider. |
errmsg | string | optional | Upstream status message returned by the provider. |
code | string | optional | Provider-specific status code. |
msg | string | optional | Provider-specific status message. |
message | string | optional | Provider-specific message. |
costTime | integer | optional | Execution time reported by the upstream provider. |
page | integer | optional | Current page returned by the upstream provider. |
pageSize | integer | optional | Page size returned by the upstream provider. |
pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. |
dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. |
Response example
Direct response payload. No extra wrapper is added.
{
"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
}Responses
| Code | Description |
|---|---|
| 200 | API executed successfully. Body is the direct response payload. |
| 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.