{
  "openapi": "3.0.1",
  "info": {
    "title": "Openverse Creative Commons Media Scraper: CC0 Images & Audio",
    "description": "Search openly-licensed Creative Commons and public-domain images and audio from Openverse (Flickr, Wikimedia, museums, Jamendo). Every asset returns its license, human-readable label, ready-to-use attribution, provider and commercial-use flags. Export to JSON, CSV or Excel.",
    "version": "0.1",
    "x-build-id": "lDnclcO14FlKsqpPY"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapers_lat~openverse-cc-media-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapers_lat-openverse-cc-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/scrapers_lat~openverse-cc-media-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapers_lat-openverse-cc-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/scrapers_lat~openverse-cc-media-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapers_lat-openverse-cc-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",
        "properties": {
          "mediaType": {
            "title": "Media type",
            "enum": [
              "image",
              "audio"
            ],
            "type": "string",
            "description": "Which Openverse catalog to search: openly-licensed images or audio.",
            "default": "image"
          },
          "query": {
            "title": "Search query",
            "type": "string",
            "description": "Keywords to search for, e.g. 'mountain', 'jazz', 'vintage poster'. Combine with the filters below to narrow results."
          },
          "license": {
            "title": "License codes (optional)",
            "type": "string",
            "description": "Comma-separated Creative Commons license codes to restrict results: cc0, pdm, by, by-sa, by-nc, by-nd, by-nc-sa, by-nc-nd. Example: 'cc0,by' for the most permissive, reuse-friendly media."
          },
          "licenseType": {
            "title": "License usage",
            "enum": [
              "",
              "commercial",
              "modification",
              "both"
            ],
            "type": "string",
            "description": "Filter by how the media may be used: commercial (allows commercial use), modification (allows edits/derivatives), or both.",
            "default": ""
          },
          "source": {
            "title": "Source / provider (optional)",
            "type": "string",
            "description": "Restrict to a single provider, e.g. flickr, wikimedia, jamendo, freesound, met (The Met), smithsonian_*."
          },
          "category": {
            "title": "Category (optional)",
            "type": "string",
            "description": "Content category. Images: photograph, illustration, digitized_artwork. Audio: music, sound_effect, podcast, audiobook, news."
          },
          "extension": {
            "title": "File extension (optional)",
            "type": "string",
            "description": "Restrict to a file type. Images: jpg, png, gif, svg. Audio: mp3, ogg, flac, wav."
          },
          "aspectRatio": {
            "title": "Aspect ratio (images, optional)",
            "type": "string",
            "description": "Image shape filter: tall, wide or square."
          },
          "size": {
            "title": "Image size (images, optional)",
            "type": "string",
            "description": "Image resolution filter: small, medium or large."
          },
          "creator": {
            "title": "Creator (optional)",
            "type": "string",
            "description": "Only return media by this creator / artist name."
          },
          "maxResults": {
            "title": "Max Media Items To Scrape",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Maximum number of media items to collect across all pages."
          },
          "includeDetail": {
            "title": "Fetch full item detail (paid add-on)",
            "type": "boolean",
            "description": "When enabled, each item is enriched from its detail endpoint with the complete tag set, related-media link and any metadata the search list omits (filesize, filetype, category). Charged per item on a successful detail fetch. Paid plans only.",
            "default": false
          },
          "withAiCaption": {
            "title": "AI caption & SEO metadata (paid add-on)",
            "type": "boolean",
            "description": "Use AI to generate accessibility alt text, an SEO caption and keywords for each item from its title and tags (the model does not see the file itself). Charged per item captioned. Paid plans only.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}