{ "openapi": "3.0.1", "info": { "title": "Pinterest Images & Videos Downloader by Keyword", "description": "Downloads Pinterest images, videos and every page of idea pins into your run's storage, by keyword, profile, board or pin URL. Each file gets a SHA-256 checksum, size, resolution and, for video, duration, fps, codec and audio flag. No login. A file that fails to download is never charged.", "version": "1.0", "x-build-id": "GVvysU2sfCOc93mEc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~pinterest-media-downloader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-pinterest-media-downloader", "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/accountable_eel~pinterest-media-downloader/runs": { "post": { "operationId": "runs-sync-accountable_eel-pinterest-media-downloader", "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/accountable_eel~pinterest-media-downloader/run-sync": { "post": { "operationId": "run-sync-accountable_eel-pinterest-media-downloader", "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": { "queries": { "title": "Keywords to search on Pinterest", "type": "array", "description": "One search term per line, as you would type it into Pinterest. Keywords are one of four ways in: use this field, or fill Pinterest profiles, boards or Pin URLs below. At least one of the four is needed. Accepted formats: scandinavian living room, minimalist bathroom, cottagecore bedroom. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "profiles": { "title": "Pinterest profiles", "type": "array", "description": "Usernames or profile URLs, one per line, e.g. marthastewart or https://www.pinterest.com/marthastewart/. Downloads their created pins.", "items": { "type": "string" } }, "boards": { "title": "Pinterest boards", "type": "array", "description": "Board URLs, one per line, e.g. https://www.pinterest.com/marthastewart/crafts/. Private boards are not available.", "items": { "type": "string" } }, "pins": { "title": "Pin URLs", "type": "array", "description": "Pin URLs or pin.it short links, one per line, e.g. https://www.pinterest.com/pin/32088216099711929/.", "items": { "type": "string" } }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "source", "sourceValue", "pinCount", "fileCount", "truncated", "files", "pinId", "pinUrl", "kind", "pageIndex", "kvKey", "kvUrl", "originalMediaUrl", "bytes", "sha256", "width", "height", "duration_s", "fps", "codec", "hasAudio", "title", "description", "altText", "pinnerUsername", "boardName", "link", "createdAt", "videoSkipped", "error" ], "enumTitles": [ "Source type", "Source", "Pins found", "Files stored", "More pins were available", "All files (full list)", "Pin ID", "Pin link", "File kind", "Page", "Storage key", "Storage URL", "Original media URL", "Size (bytes)", "SHA-256", "Width", "Height", "Duration (s)", "FPS", "Codec", "Has audio", "Pin title", "Description", "Image alt text", "Pinner username", "Board", "Links to", "Pinned on", "Video skipped", "Error" ] }, "default": [ "source", "sourceValue", "pinCount", "fileCount", "truncated", "files", "pinId", "pinUrl", "kind", "pageIndex", "kvKey", "kvUrl", "originalMediaUrl", "bytes", "sha256", "width", "height", "duration_s", "fps", "codec", "hasAudio", "title", "description", "altText", "pinnerUsername", "boardName", "link", "createdAt", "videoSkipped", "error" ] }, "expandRows": { "title": "One row per file (recommended) — turn off for one row per source instead", "type": "boolean", "description": "When on, each file found gets its own row instead of being grouped under its source. You're still only charged once per source, no matter how many rows it produces.", "default": true }, "maxPinsPerSource": { "title": "Most pins per source", "type": "integer", "description": "How many pins to download from each keyword, profile or board. Each pin can hold several files. Capped at 100.", "default": 25 }, "kinds": { "title": "Which media to download", "enum": [ "all", "images", "videos" ], "type": "string", "description": "\"All\" downloads images and videos (a video pin also gets its cover still). \"Images only\" skips video files and keeps covers. \"Videos only\" skips pins that have no video.", "default": "all" }, "maxMb": { "title": "Max file size (MB)", "type": "integer", "description": "Aborts a single file's download once it exceeds this size. 1-300.", "default": 100 }, "skipDuplicatePins": { "title": "Never download the same pin twice", "type": "boolean", "description": "On by default. The same pin often shows up in two sources. With this on, each pin is downloaded, and billed, once per run.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 4, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy config. Residential recommended for anti-bot-sensitive targets.", "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 } } } } } } } } } }