{ "openapi": "3.0.1", "info": { "title": "Creative Commons Media Search - Openverse Scraper", "description": "Search and export Creative Commons and public domain images and audio from Openverse's 800M+ item media index (Flickr, Wikimedia Commons, NASA, Smithsonian, Europeana, Jamendo and 50+ more). Filter by license, category and provider; each record includes the file URL, creator and attribution text.", "version": "0.1", "x-build-id": "0CBH1k3xpYa4arpPc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jungle_synthesizer~openverse-media-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jungle_synthesizer-openverse-media-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/jungle_synthesizer~openverse-media-scraper/runs": { "post": { "operationId": "runs-sync-jungle_synthesizer-openverse-media-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/jungle_synthesizer~openverse-media-scraper/run-sync": { "post": { "operationId": "run-sync-jungle_synthesizer-openverse-media-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": [ "maxItems" ], "properties": { "sp_intended_usage": { "title": "What is the intended usage of this data?", "minLength": 1, "type": "string", "description": "What will this data feed? E.g. lead lists, KYB checks, price tracking." }, "sp_improvement_suggestions": { "title": "How can we improve this crawler for you?", "minLength": 1, "type": "string", "description": "Provide any feedback or suggestions for improvements." }, "sp_contact": { "title": "Contact email (optional)", "minLength": 1, "type": "string", "description": "We'll personally help with your use case. No spam." }, "mediaTypes": { "title": "Media Types", "type": "array", "description": "Which Openverse media types to search. Select both to search images and audio in the same run. Leave empty to search both.", "items": { "type": "string", "enum": [ "images", "audio" ], "enumTitles": [ "Images", "Audio" ] } }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Full-text search phrase, matched against title, description and tags. Leave blank to browse by the filters below only." }, "licenses": { "title": "Licenses", "type": "array", "description": "Restrict results to one or more specific licenses. Leave empty to include every license Openverse indexes.", "items": { "type": "string", "enum": [ "by", "by-nc", "by-nc-nd", "by-nc-sa", "by-nd", "by-sa", "cc0", "pdm", "sampling+", "nc-sampling+" ], "enumTitles": [ "Attribution (CC BY)", "Attribution-NonCommercial (CC BY-NC)", "Attribution-NonCommercial-NoDerivatives (CC BY-NC-ND)", "Attribution-NonCommercial-ShareAlike (CC BY-NC-SA)", "Attribution-NoDerivatives (CC BY-ND)", "Attribution-ShareAlike (CC BY-SA)", "CC0 Public Domain Dedication", "Public Domain Mark", "Sampling+", "NonCommercial Sampling+" ] } }, "imageCategories": { "title": "Image Categories", "type": "array", "description": "Restrict image results to one or more categories. Only applies when Media Types includes Images. Leave empty to include all image categories.", "items": { "type": "string", "enum": [ "digitized_artwork", "illustration", "photograph" ], "enumTitles": [ "Digitized Artwork", "Illustration", "Photograph" ] } }, "audioCategories": { "title": "Audio Categories", "type": "array", "description": "Restrict audio results to one or more categories. Only applies when Media Types includes Audio. Leave empty to include all audio categories.", "items": { "type": "string", "enum": [ "audiobook", "music", "news", "podcast", "pronunciation", "sound_effect" ], "enumTitles": [ "Audiobook", "Music", "News", "Podcast", "Pronunciation", "Sound Effect" ] } }, "sources": { "title": "Providers", "type": "array", "description": "Restrict results to one or more specific source providers. A provider only applies to the media type(s) it serves. Leave empty to include every provider.", "items": { "type": "string", "enum": [ "animaldiversity", "bib_gulbenkian", "bio_diversity", "brooklynmuseum", "clevelandmuseum", "digitaltmuseum", "europeana", "finnish_heritage_agency", "finnish_satakunnan_museum", "flickr", "freesound", "geographorguk", "inaturalist", "jamendo", "justtakeitfree", "katmai_nps", "met", "museumsvictoria", "nappy", "nasa", "national_museum_of_finland", "nypl", "phylopic", "rawpixel", "rijksmuseum", "sciencemuseum", "sketchfab", "smithsonian_african_american_history_museum", "smithsonian_african_art_museum", "smithsonian_air_and_space_museum", "smithsonian_american_art_museum", "smithsonian_american_history_museum", "smithsonian_american_indian_museum", "smithsonian_anacostia_museum", "smithsonian_cooper_hewitt_museum", "smithsonian_freer_gallery_of_art", "smithsonian_gardens", "smithsonian_hirshhorn_museum", "smithsonian_institution_archives", "smithsonian_libraries", "smithsonian_national_museum_of_natural_history", "smithsonian_portrait_gallery", "smithsonian_postal_museum", "smithsonian_zoo_and_conservation", "smk", "spacex", "stocksnap", "svgsilh", "thingiverse", "wellcome_collection", "wikimedia", "wikimedia_audio", "woc_tech", "wordpress", "WoRMS" ], "enumTitles": [ "Animal Diversity Web", "Gulbenkian Art Library", "Biodiversity Heritage Library", "Brooklyn Museum", "Cleveland Museum of Art", "Digitalt Museum", "Europeana", "Finnish Heritage Agency", "Finnish Satakunnan Museum", "Flickr", "Freesound", "Geograph Britain and Ireland", "iNaturalist", "Jamendo", "Just take it free", "Katmai National Park Service", "Metropolitan Museum of Art", "Museums Victoria", "Nappy", "NASA", "National Museum of Finland", "New York Public Library", "PhyloPic", "Rawpixel", "Rijksmuseum", "Science Museum - UK", "Sketchfab", "Smithsonian Institution: National Museum of African American History and Culture", "Smithsonian Institution: National Museum of African Art", "Smithsonian Institution: National Air and Space Museum", "Smithsonian Institution: Smithsonian American Art Museum", "Smithsonian Institution: National Museum of American History", "Smithsonian Institution: National Museum of the American Indian", "Smithsonian Institution: Anacostia Community Museum", "Smithsonian Institution: Cooper Hewitt, Smithsonian Design Museum", "Smithsonian Institution: Freer Gallery of Art", "Smithsonian Institution: Smithsonian Gardens", "Smithsonian Institution: Hirshhorn Museum and Sculpture Garden", "Smithsonian Institution Archives", "Smithsonian Institution: Smithsonian Libraries", "Smithsonian Institution: National Museum of Natural History", "Smithsonian Institution: National Portrait Gallery", "Smithsonian Institution: National Postal Museum", "Smithsonian Institution: National Zoo", "National Gallery of Denmark (SMK)", "SpaceX", "StockSnap.io", "SVG Silh", "Thingiverse", "Wellcome Collection", "Wikimedia Commons", "Wikimedia Commons (Audio)", "WOCinTech Chat", "WP Photo Directory", "World Register of Marine Species" ] } }, "aspectRatio": { "title": "Aspect Ratio (images)", "type": "array", "description": "Restrict image results to one or more aspect ratios. Only applies when Media Types includes Images.", "items": { "type": "string", "enum": [ "square", "tall", "wide" ], "enumTitles": [ "Square", "Tall", "Wide" ] } }, "imageSize": { "title": "Image Size", "type": "array", "description": "Restrict image results to one or more file size classes. Only applies when Media Types includes Images.", "items": { "type": "string", "enum": [ "large", "medium", "small" ], "enumTitles": [ "Large", "Medium", "Small" ] } }, "includeMature": { "title": "Include Sensitive Content", "type": "boolean", "description": "Include results Openverse flags as sensitive/mature. Off by default, matching Openverse's own default.", "default": false }, "maxItems": { "title": "Max Items", "minimum": 1, "type": "integer", "description": "Maximum number of media records to return.", "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 }, "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 } } } } } } } } } }