{
  "openapi": "3.0.1",
  "info": {
    "title": "1688 Reverse Image Search — Suppliers, Prices & Matches",
    "description": "Find 1688 and Taobao products by photo. Enrich 1688 with galleries, variants, quantity prices, MOQ and supplier data. JSON/CSV/API. Taobao details currently unavailable. Photo-search fees and platform usage apply.",
    "version": "0.8",
    "x-build-id": "6D8Zb1Ol3JdRlBfTN"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/apivault_labs~1688-image-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-apivault_labs-1688-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/apivault_labs~1688-image-search/runs": {
      "post": {
        "operationId": "runs-sync-apivault_labs-1688-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/apivault_labs~1688-image-search/run-sync": {
      "post": {
        "operationId": "run-sync-apivault_labs-1688-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",
        "properties": {
          "operation": {
            "title": "Photo search or known product details",
            "enum": [
              "image_search",
              "product_details"
            ],
            "type": "string",
            "description": "Image search is the existing default. Product details requires canonical productUrls; no photo search event is charged in URL-only mode, platform usage still applies.",
            "default": "image_search"
          },
          "includeDetails": {
            "title": "Get additional images, variants and product details",
            "type": "boolean",
            "description": "Optional 1688 enrichment after photo search. Taobao details are disabled due to provider verification; its search cards remain. Adds platform usage, no new detail event.",
            "default": false
          },
          "productUrls": {
            "title": "Canonical product URLs for product_details mode",
            "maxItems": 20,
            "type": "array",
            "description": "Canonical 1688 offer URLs for rich details. Taobao/Tmall URLs return explicit source-access-unavailable diagnostics in this release. No photo required in product_details mode.",
            "items": {
              "type": "string"
            }
          },
          "maxDetailProducts": {
            "title": "Maximum products to enrich",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Bound detail collection. Coverage reports truncation; unknown fields stay null. The overall run deadline still applies.",
            "default": 5
          },
          "maxImagesPerProduct": {
            "title": "Maximum source images per product",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Bound detail collection. Coverage reports truncation; unknown fields stay null. The overall run deadline still applies.",
            "default": 100
          },
          "maxVariantsPerProduct": {
            "title": "Maximum variants per product",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Bound detail collection. Coverage reports truncation; unknown fields stay null. The overall run deadline still applies.",
            "default": 200
          },
          "detailTimeoutSecs": {
            "title": "Shared details time budget (seconds)",
            "minimum": 10,
            "maximum": 180,
            "type": "integer",
            "description": "Bound detail collection. Coverage reports truncation; unknown fields stay null. The overall run deadline still applies.",
            "default": 90
          },
          "includeTitleKeywords": {
            "title": "Keep products containing these phrases",
            "maxItems": 20,
            "type": "array",
            "description": "Optional phrases matched in the original product name or its translation, when available. A product must contain at least one phrase. This is a text filter, not a visual similarity score. Chinese phrases also work.",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          },
          "excludeTitleKeywords": {
            "title": "Exclude products containing these phrases",
            "maxItems": 20,
            "type": "array",
            "description": "Optional phrases that exclude a product even if it matches a keep phrase. Checked in the original name and available translation, ignoring case. Completed photo searches remain charged if filters remove all cards.",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            }
          },
          "marketplace": {
            "title": "Where to search",
            "enum": [
              "1688",
              "taobao",
              "both"
            ],
            "type": "string",
            "description": "Choose 1688, Taobao, or both. Searching both uses more time and resources.",
            "default": "1688"
          },
          "imageUrl": {
            "title": "Product photo link (easiest)",
            "type": "string",
            "description": "A sample photo is filled in for a quick test. Replace it with a direct public HTTPS image link, or upload your own photo; the sample is ignored when you add your own. Add 1-3 photos total. Public HTTPS redirects are supported; photos must decode and be at most 5 MB and 25 million pixels."
          },
          "additionalImageUrls": {
            "title": "More photos of the same product",
            "maxItems": 3,
            "uniqueItems": true,
            "type": "array",
            "description": "Optional front, side, or detail views. Use no more than three photos total. A second view can help find recurring listings.",
            "items": {
              "type": "string"
            }
          },
          "uploadedImages": {
            "title": "Upload product photos",
            "maxItems": 3,
            "type": "array",
            "description": "Add JPEG, PNG, WebP or GIF photos, up to 5 MB and 25 million pixels each. Damaged files are rejected. Select a storage in the upload dialog if asked; no second selection is needed.",
            "items": {
              "type": "string"
            }
          },
          "imageStoreId": {
            "title": "Previously selected photo storage",
            "type": "string",
            "description": "Kept for existing saved tasks; new uploads do not need this field."
          },
          "imagesBase64": {
            "title": "Encoded photos (API users)",
            "maxItems": 3,
            "type": "array",
            "description": "Optional encoded JPG, PNG, WebP, or GIF images, up to 5 MB each after decoding. Avoid including private or sensitive photos in run input.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Results to request per photo and marketplace",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Request 1-5,000 candidates. The actual number of distinct listings can be lower, especially for deep searches. Larger searches take longer and use more resources.",
            "default": 10
          },
          "sortBy": {
            "title": "Sort products",
            "enum": [
              "relevance",
              "price_asc",
              "price_desc"
            ],
            "type": "string",
            "description": "Keep photo-match relevance order, or sort by listed price. Listings without a price appear last.",
            "default": "relevance"
          },
          "minMatchingPhotos": {
            "title": "Found in at least this many photos",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "For multi-photo searches, keep only offers or visible cards found in at least this many of your photos. Must not exceed the number of photos provided.",
            "default": 1
          },
          "minPriceCny": {
            "title": "Minimum listed price (CNY)",
            "minimum": 0,
            "maximum": 1000000,
            "type": "number",
            "description": "Optional lower bound for the listed product price. Listings without a price are excluded when a price filter is set."
          },
          "maxPriceCny": {
            "title": "Maximum listed price (CNY)",
            "minimum": 0,
            "maximum": 1000000,
            "type": "number",
            "description": "Optional upper bound for the listed product price. This is the listed price, not an all-in landed cost."
          },
          "maxMinimumOrderQuantity": {
            "title": "Largest acceptable minimum order (1688)",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Optional: keep 1688 listings only when their reported minimum order is at or below this quantity. 1688 listings without a reported minimum order are excluded. Taobao listings remain available because this field is not provided for them."
          },
          "runTimeout": {
            "title": "Search time budget (seconds)",
            "minimum": 30,
            "maximum": 1500,
            "type": "integer",
            "description": "Stop further requests after 30–1500 seconds; partial verified cards and diagnostics remain available. Deep searches may stop below the requested result count. Platform timeout takes precedence.",
            "default": 240
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}