{
  "openapi": "3.0.1",
  "info": {
    "title": "EPO European Patent Search",
    "description": "Search 130M+ patents from the European Patent Office OPS API. Find patents by title, applicant, inventor, IPC/CPC class, or date. Get abstracts, classifications, and Espacenet links. Free EPO API credentials.",
    "version": "1.13",
    "x-build-id": "C8TD5ctVSDprxsehP"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ryanclinton~epo-patent-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ryanclinton-epo-patent-search",
        "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/ryanclinton~epo-patent-search/runs": {
      "post": {
        "operationId": "runs-sync-ryanclinton-epo-patent-search",
        "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/ryanclinton~epo-patent-search/run-sync": {
      "post": {
        "operationId": "run-sync-ryanclinton-epo-patent-search",
        "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": [
          "consumerKey",
          "consumerSecret"
        ],
        "properties": {
          "mission": {
            "title": "Mission (optional preset)",
            "enum": [
              "",
              "find_emerging_competitors",
              "technology_landscape",
              "startup_moat",
              "freedom_to_operate",
              "threat_radar",
              "investor_due_diligence"
            ],
            "type": "string",
            "description": "Optional goal-based preset that configures the run for a business question. Any field you set explicitly overrides the mission. find_emerging_competitors = surface fast-growing new entrants. technology_landscape = one analytics record for the whole domain. startup_moat = assess an applicant's patent moat. freedom_to_operate = granted enforceable patents + coverage. threat_radar = prioritised competitor alerts (set watchlistName). investor_due_diligence = portfolio + landscape diligence view.",
            "default": ""
          },
          "consumerKey": {
            "title": "EPO Consumer Key",
            "type": "string",
            "description": "EPO OPS Consumer Key (free from developers.epo.org)"
          },
          "consumerSecret": {
            "title": "EPO Consumer Secret",
            "type": "string",
            "description": "EPO OPS Consumer Secret"
          },
          "titleKeywords": {
            "title": "Title Keywords",
            "type": "string",
            "description": "Search for keywords in patent title"
          },
          "applicant": {
            "title": "Applicant / Company",
            "type": "string",
            "description": "Search by applicant or company name"
          },
          "inventor": {
            "title": "Inventor Name",
            "type": "string",
            "description": "Search by inventor name"
          },
          "query": {
            "title": "CQL Query",
            "type": "string",
            "description": "Raw CQL search query (e.g., \"ti=solar and pa=Tesla and pd>=2023\"). Overrides other search fields if provided."
          },
          "publicationNumber": {
            "title": "Publication Number",
            "type": "string",
            "description": "Lookup a specific patent by publication number (e.g., \"EP1234567\")"
          },
          "publicationCountry": {
            "title": "Publication Country",
            "enum": [
              "",
              "EP",
              "WO",
              "GB",
              "US",
              "DE",
              "FR",
              "JP",
              "CN",
              "KR",
              "CA",
              "AU",
              "AT",
              "BE",
              "CH",
              "DK",
              "ES",
              "FI",
              "IE",
              "IT",
              "NL",
              "NO",
              "SE",
              "PT",
              "PL",
              "CZ",
              "HU",
              "RO",
              "BG",
              "HR",
              "SK",
              "SI",
              "LT",
              "LV",
              "EE",
              "LU",
              "CY",
              "MT",
              "GR",
              "TR",
              "RU",
              "BR",
              "IN",
              "MX",
              "ZA",
              "NZ",
              "IL",
              "SG",
              "TW",
              "HK"
            ],
            "type": "string",
            "description": "Filter by publication office / country code (e.g., GB for Great Britain, US for United States)",
            "default": ""
          },
          "dateFrom": {
            "title": "Date From",
            "type": "string",
            "description": "Publication date from (YYYY or YYYYMMDD)"
          },
          "dateTo": {
            "title": "Date To",
            "type": "string",
            "description": "Publication date to (YYYY or YYYYMMDD)"
          },
          "maxResults": {
            "title": "Max Results",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Maximum number of results to return (max 2000)",
            "default": 100
          },
          "mode": {
            "title": "Run Mode",
            "enum": [
              "search",
              "monitor",
              "lite",
              "landscape"
            ],
            "type": "string",
            "description": "search = full results (default). monitor = track new patents, grants, family/citation changes since last run. lite = lightweight output for fast scanning. landscape = aggregates only (one landscape/analytics record, no individual patent rows) for technology-domain overviews.",
            "default": "search"
          },
          "watchlistName": {
            "title": "Watchlist Name",
            "type": "string",
            "description": "Monitor mode only. Name this watchlist to keep its cross-run state in a dedicated, purge-safe store — letting you run the same actor as several independent monitors (e.g. \"samsung-batteries\", \"competitor-X\"). Leave blank for a single shared monitor state. Each watchlist independently flags NEW publications and detects when a tracked application becomes a GRANTED patent."
          },
          "includeFamilyMembers": {
            "title": "Include Family Members",
            "type": "boolean",
            "description": "Fetch all patent family members (equivalent filings in other countries) for each result. Adds API calls per unique family, so runs take longer.",
            "default": false
          },
          "includeCitations": {
            "title": "Include Citations",
            "type": "boolean",
            "description": "Extract backward citations (prior art references) from patent bibliographic data. No extra API calls needed.",
            "default": true
          },
          "includeAnalytics": {
            "title": "Include Landscape Analytics",
            "type": "boolean",
            "description": "Emit a landscape/analytics record (recordType: \"landscape\") summarising the whole result set: top applicants (normalized), countries, IPCs, inventors, grant rate, filing trend + growth rate, emerging applicants, citation/family leaders. Filter it out downstream with recordType.",
            "default": true
          },
          "grantedOnly": {
            "title": "Granted Patents Only",
            "type": "boolean",
            "description": "Keep only granted patents (applicationStatus = granted). Applied after fetching.",
            "default": false
          },
          "minCitations": {
            "title": "Minimum Citations",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only patents with at least this many backward citations. 0 = no filter.",
            "default": 0
          },
          "minFamilySize": {
            "title": "Minimum Family Size",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only patents whose family spans at least this many jurisdictions. Needs includeFamilyMembers to be meaningful. 0 = no filter.",
            "default": 0
          },
          "dedupeFamilies": {
            "title": "Deduplicate Families",
            "type": "boolean",
            "description": "Keep only one representative publication per patent family (collapses equivalent filings across jurisdictions). A common patent-analysis requirement.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}