{ "openapi": "3.0.1", "info": { "title": "E-commerce Product Matching Tool", "description": "Match products across e-commerce datasets with E-Commerce Product Matching Tool. Use it with E-commerce Scraping Tool datasets to automatically find identical and similar products and power price monitoring or catalog comparison.", "version": "0.0", "x-build-id": "xK0Wk68hRRkOIlS3R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tri_angle~e-commerce-product-matching-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tri_angle-e-commerce-product-matching-tool", "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/tri_angle~e-commerce-product-matching-tool/runs": { "post": { "operationId": "runs-sync-tri_angle-e-commerce-product-matching-tool", "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/tri_angle~e-commerce-product-matching-tool/run-sync": { "post": { "operationId": "run-sync-tri_angle-e-commerce-product-matching-tool", "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": [ "datasetIdA", "datasetIdB" ], "properties": { "datasetIdA": { "title": "Dataset ID A", "type": "string", "description": "First product dataset to match. Must be the output of the Apify e-commerce scraper." }, "datasetIdB": { "title": "Dataset ID B", "type": "string", "description": "Second product dataset to match against. Must be the output of the Apify e-commerce scraper." }, "useLlmMatching": { "title": "Use LLM matching", "type": "boolean", "description": "After vector matching, also run LLM matching to confirm each result.", "default": false }, "vectorMatchesOnly": { "title": "Vector matches only", "type": "boolean", "description": "Keep only pairs that pass the vector similarity threshold. When LLM matching is on, this filters which pairs are passed on to the LLM step.", "default": false }, "maxOutputItems": { "title": "Max output items", "minimum": 1, "type": "integer", "description": "Limit the total number of output items. Leave empty for unlimited." }, "vectorSimilarityThreshold": { "title": "Vector similarity threshold", "minimum": 0, "maximum": 100, "type": "integer", "description": "Minimum vector-similarity score (0-100) for two products to be considered a match.", "default": 75 }, "vectorMatchesPerProduct": { "title": "Vector matches per product", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of top vector-matching results returned per product from the opposing dataset (some may fall below the similarity threshold).", "default": 1 }, "productMetadataMapping": { "title": "Product metadata mapping", "type": "object", "description": "Customize which fields appear in the `product_a_metadata` and `product_b_metadata`. Map metadata field names to dot-notation paths in source items. Without this, the full source item is used as metadata. The mapped fields are also seen by LLM matching and will influence its results." } } }, "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 } } } } } } } } } }