{
"openapi": "3.0.1",
"info": {
"title": "Product Search by Image - 1688, Alibaba, AliExpress",
"description": "Search 1688, Alibaba and AliExpress with one product photo in a single run. Get factory, wholesale and retail prices, sellers, links and match rank in one dataset. Add full details: price tiers, variants with stock, specs, shipping and verified Alibaba suppliers.",
"version": "0.0",
"x-build-id": "5FnNxiocT380UoLuy"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/zen-studio~product-search-by-image/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-zen-studio-product-search-by-image",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/zen-studio~product-search-by-image/runs": {
"post": {
"operationId": "runs-sync-zen-studio-product-search-by-image",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/zen-studio~product-search-by-image/run-sync": {
"post": {
"operationId": "run-sync-zen-studio-product-search-by-image",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"imageUrls": {
"title": "🖼️ Image links",
"maxItems": 25,
"type": "array",
"description": "Direct links to product photos (JPEG, PNG or WebP). Up to 25 images per run, including an uploaded photo. Every image is searched on each marketplace you pick.
Add all your photos to one run instead of starting one run per photo.",
"items": {
"type": "string"
}
},
"imageFile": {
"title": "📤 Or upload a photo",
"type": "string",
"description": "Upload a product photo from your computer. Works on its own or together with links, and counts toward the 25 images per run."
},
"targets": {
"title": "🛒 Marketplaces",
"type": "array",
"description": "Where to look. Leave empty to search all three. Every marketplace you add returns its own results for each image.",
"items": {
"type": "string",
"enum": [
"1688",
"alibaba",
"aliexpress"
],
"enumTitles": [
"1688",
"Alibaba",
"AliExpress"
]
}
},
"maxResultsPerImage": {
"title": "🔢 Results per image, per marketplace",
"minimum": 10,
"maximum": 500,
"type": "integer",
"description": "How many matches to return for each image on each marketplace, top matches first. Results add up per image per marketplace: 1 image x 3 marketplaces x 20 = up to 60 results.
Minimum 10, maximum 500. Defaults to 20."
},
"includeProductDetails": {
"title": "📦 Full product details",
"type": "boolean",
"description": "Adds price tiers, variants with stock, specifications, shipping and the seller profile to every result. Charged per result that has them. Pre-ticked in this form, off when left out of the input."
},
"alibabaResultType": {
"title": "Find on Alibaba",
"enum": [
"products",
"suppliers"
],
"type": "string",
"description": "Matching products, or the suppliers behind them (one result per supplier). Defaults to products."
},
"alibabaSupplierReport": {
"title": "Supplier verification report",
"type": "boolean",
"description": "Adds the third-party verification report and factory media for each supplier. Charged per result that has a report. Also adds full product details to every result, charged as details."
},
"alibabaVerifiedManufacturer": {
"title": "Verified manufacturers only",
"type": "boolean",
"description": "Only results from verified manufacturers."
},
"alibabaVerifiedSupplier": {
"title": "Verified suppliers only",
"type": "boolean",
"description": "Only results from verified suppliers."
},
"alibabaMinPrice": {
"title": "Minimum price (USD)",
"minimum": 0,
"type": "integer",
"description": "Only products priced at or above this. Not used when finding suppliers."
},
"alibabaMaxPrice": {
"title": "Maximum price (USD)",
"minimum": 0,
"type": "integer",
"description": "Only products priced at or below this. Not used when finding suppliers."
},
"alibabaMaxMoq": {
"title": "Maximum minimum order",
"minimum": 1,
"type": "integer",
"description": "Only products you can order in this quantity or less."
},
"aliexpressCountry": {
"title": "Deliver to",
"enum": [
"US",
"GB",
"DE",
"FR",
"ES",
"IT",
"NL",
"PL",
"BR",
"CA",
"AU",
"MX",
"JP",
"KR",
"IN",
"SA",
"AE",
"TR"
],
"type": "string",
"description": "Changes which products, prices and shipping you see. Defaults to United States."
},
"aliexpressCurrency": {
"title": "Currency",
"enum": [
"USD",
"EUR",
"GBP",
"BRL",
"CAD",
"AUD",
"JPY",
"KRW",
"INR",
"MXN",
"PLN",
"TRY"
],
"type": "string",
"description": "Defaults to USD."
},
"aliexpressLanguage": {
"title": "Language",
"enum": [
"en_US",
"de_DE",
"fr_FR",
"es_ES",
"it_IT",
"nl_NL",
"pl_PL",
"pt_BR",
"ja_JP",
"ko_KR",
"tr_TR"
],
"type": "string",
"description": "Defaults to English."
},
"sortBy1688": {
"title": "Sort 1688 results",
"enum": [
"relevance",
"bestSelling",
"priceAsc",
"priceDesc"
],
"type": "string",
"description": "Defaults to best match."
},
"minPrice1688": {
"title": "Minimum price (CNY)",
"minimum": 0,
"type": "integer",
"description": "Only products priced at or above this."
},
"maxPrice1688": {
"title": "Maximum price (CNY)",
"minimum": 0,
"type": "integer",
"description": "Only products priced at or below this."
},
"supplierIntelligence1688": {
"title": "Supplier intelligence",
"type": "boolean",
"description": "Adds dropshipping price and tiers, 7 and 30 day orders and distributor counts. Charged per result that has them. Also adds full product details to every result, charged as details."
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}