{ "openapi": "3.0.1", "info": { "title": "AliExpress Image Search: Find the Same Product (Paused)", "description": "PAUSED while we obtain written permission from AliExpress: runs fetch no data and charge no results, each product gets a free \"paused\" row. Once resumed it finds the same item on AliExpress, verified by an image match.", "version": "0.1", "x-build-id": "a8ve6lkLvwrm2ENQK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reliable_tools~aliexpress-image-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reliable_tools-aliexpress-image-search", "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/reliable_tools~aliexpress-image-search/runs": { "post": { "operationId": "runs-sync-reliable_tools-aliexpress-image-search", "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/reliable_tools~aliexpress-image-search/run-sync": { "post": { "operationId": "run-sync-reliable_tools-aliexpress-image-search", "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", "required": [ "products" ], "properties": { "products": { "title": "Products to source", "type": "array", "description": "One product per line. Use a product page URL (Shopify or any shop with standard product markup), an image URL followed by search words (\"https://.../photo.jpg | silicone baby bib\"), or just a product title. Add \" | your search words\" after any URL to override the search. Amazon product pages are not read: paste the product image URL with search words instead. Pages whose robots.txt does not allow automated visitors are skipped. At most 100 products are searched per run.", "items": { "type": "string" } }, "shipToCountry": { "title": "Ship to country", "type": "string", "description": "Two-letter country code used for the prices AliExpress shows, e.g. US, DE, GB, FR, AU.", "default": "US" }, "currency": { "title": "Currency", "type": "string", "description": "Currency for prices, e.g. USD, EUR, GBP.", "default": "USD" }, "maxCandidatesToCheck": { "title": "Candidates to check per product", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many AliExpress search results get the AI image check. More candidates find more matches but take longer.", "default": 10 }, "minMatchScore": { "title": "Minimum match score", "type": "string", "description": "A candidate counts as a verified match when the AI check says it is the same product with at least this probability (0 to 1). 0.6 is a good default; use 0.75 or higher for stricter matches.", "default": "0.6" }, "maxMatchesPerProduct": { "title": "Max verified matches per product", "minimum": 1, "maximum": 30, "type": "integer", "description": "Upper limit of verified matches returned (and charged) per input product.", "default": 5 }, "includeProductBox": { "title": "Product location box", "type": "boolean", "description": "Adds where the product sits inside the match photo (box edges as fractions of the image), handy for cropping.", "default": false } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }