{
"openapi": "3.0.1",
"info": {
"title": "Pinterest Scraper with AI Image Analysis",
"description": "Scrape Pinterest search: pins, images, videos, boards, pinners, links and dates. Optional AI image analysis adds description, category, style, colors, objects and tags. Monitor mode returns only new pins.",
"version": "0.1",
"x-build-id": "EGb5WHdlZtFzPd9vF"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/wakeful_outhouse~pinterest-ai-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-wakeful_outhouse-pinterest-ai-scraper",
"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/wakeful_outhouse~pinterest-ai-scraper/runs": {
"post": {
"operationId": "runs-sync-wakeful_outhouse-pinterest-ai-scraper",
"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/wakeful_outhouse~pinterest-ai-scraper/run-sync": {
"post": {
"operationId": "run-sync-wakeful_outhouse-pinterest-ai-scraper",
"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": [
"searchQueries"
],
"properties": {
"searchQueries": {
"title": "Search queries",
"type": "array",
"description": "One Pinterest search per line, e.g. boho living room or minimalist kitchen.",
"items": {
"type": "string"
}
},
"searchType": {
"title": "Search for",
"enum": [
"pins",
"videos"
],
"type": "string",
"description": "All pins or only video pins.",
"default": "pins"
},
"maxPinsPerQuery": {
"title": "Max pins per query",
"minimum": 0,
"type": "integer",
"description": "Stop after this many pins for each query. 0 means as many as Pinterest returns (usually several hundred). In monitor mode this counts all pins checked, new and already seen.",
"default": 100
},
"analyzeImages": {
"title": "Analyze images with AI",
"type": "boolean",
"description": "Let AI look at each image and add a description, category, subcategory, style, colors, objects, tags, mood, commercial intent, product type and text in the image. Charged per analyzed pin, only when the analysis succeeds. No API key needed.",
"default": false
},
"customCategories": {
"title": "Your categories",
"type": "array",
"description": "Optional. Your own list of categories, e.g. kitchen, bathroom, bedroom. AI puts each pin into one of them (field aiCustomCategory). Works only with AI analysis on.",
"default": [],
"items": {
"type": "string"
}
},
"maxAnalyzedPins": {
"title": "Max analyzed pins per run",
"minimum": 0,
"type": "integer",
"description": "Analyze only the first N pins of the run to cap the AI cost. Other pins are saved without AI fields. 0 means all pins.",
"default": 0
},
"monitorName": {
"title": "Monitor name (only new pins)",
"type": "string",
"description": "Turn on monitoring: give this search any name, for example boho-trends. Each run then saves only pins that earlier runs with the same name have not returned, so you pay only for new pins. Use it with an Apify Schedule. The first run returns everything. The list of seen pins is kept in the pinterest-pins-monitor key-value store of your account. Leave empty for a normal run."
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many queries run in parallel and how many images AI analyzes at once.",
"default": 5
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Residential proxy is recommended.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}