{ "openapi": "3.0.1", "info": { "title": "Facebook AI Marketplace Search: Let AI Do the Work", "description": "🧠⚡ Start a smart AI search with no hard work needed. Tell AI what you want, and it will find the Marketplace listings you are looking for.", "version": "0.1", "x-build-id": "DZCbHVYNYWe8mbcfh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thedoor~facebook-marketplace-ai-filter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thedoor-facebook-marketplace-ai-filter", "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/thedoor~facebook-marketplace-ai-filter/runs": { "post": { "operationId": "runs-sync-thedoor-facebook-marketplace-ai-filter", "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/thedoor~facebook-marketplace-ai-filter/run-sync": { "post": { "operationId": "run-sync-thedoor-facebook-marketplace-ai-filter", "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": { "marketplaceUrls": { "title": "Marketplace URL(s)", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Optional fixed Facebook Marketplace search or item URLs. Use this mode when you already know the URLs to scrape.", "items": { "type": "string" } }, "aiSearchDescription": { "title": "AI search description - try to tell us the place and item you want", "maxLength": 1800, "type": "string", "description": "Try to tell us the place and item you want. Example: Find all Toyota cars in all states of the US. You can write in any language.", "default": "Find all Toyota cars in all states of the US" }, "aiImageFilterDescription": { "title": "AI image filter - describe the images you want to keep (optional)", "maxLength": 1800, "type": "string", "description": "Describe the images to keep. Example: Keep all white Toyota cars. Leave empty to disable the image filter.", "default": "Keep all white Toyota cars" }, "startUrls": { "title": "Marketplace search or item URLs", "type": "array", "description": "Optional Marketplace search, category, or item URLs. When provided, these take precedence over generated search input.", "items": { "type": "object", "properties": { "url": { "title": "URL", "description": "Marketplace URL.", "type": "string" } } } }, "searchQuery": { "title": "Search query", "type": "string", "description": "Marketplace keyword, for example Toyota or sofa." }, "marketplaceLocation": { "title": "Marketplace location", "type": "string", "description": "Facebook Marketplace location ID or slug." }, "countryCode": { "title": "Country preset (ISO 2-letter code)", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Optional country preset such as us, gb, vn, or jp. Uses the country's capital and a 65 km radius when marketplaceLocation and coordinates are not provided." }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of listings to inspect for each location before AI filtering.", "default": 100 }, "locationExpansionLimit": { "title": "Maximum locations", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of concrete locations created from a broad AI request such as all cities in Italy. Default 10; maximum 500.", "default": 10 } } }, "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 } } } } } } } } } }