{ "openapi": "3.0.1", "info": { "title": "Corporate & Patent Intelligence - PTAB, EPO, Registers", "description": "Patent disputes and company registers in one Actor: USPTO PTAB trials and EPO opposition watch (your own API keys), ClinicalTrials.gov and FDA Orange Book, Singapore ACRA and the UAE ADGM register. Receive only new or changed records.", "version": "0.1", "x-build-id": "VVHQ6B8fjNqe14FOQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stefano_seggio~global-corporate-patent-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stefano_seggio-global-corporate-patent-intelligence", "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/stefano_seggio~global-corporate-patent-intelligence/runs": { "post": { "operationId": "runs-sync-stefano_seggio-global-corporate-patent-intelligence", "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/stefano_seggio~global-corporate-patent-intelligence/run-sync": { "post": { "operationId": "run-sync-stefano_seggio-global-corporate-patent-intelligence", "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": [ "sources" ], "properties": { "sources": { "title": "Sources to run", "minItems": 1, "type": "array", "description": "Source ids to run in this execution. Held sources are not selectable: ae_registers.", "items": { "type": "string", "enum": [ "uspto_ptab", "epo_opposition", "clinicaltrials_orange_book", "sg_acra" ], "enumTitles": [ "USPTO Patent Trial and Appeal Board trial proceedings (IPR / PGR / CBM / DER) from the US…", "EPO Open Patent Services legal-status lookup for a watchlist of EP publication numbers, r…", "ClinicalTrials.gov v2 studies (newest update first) and FDA Orange Book products with the…", "Singapore ACRA register of corporate entities from data.gov.sg (monthly extract, 27 first…" ] }, "default": [ "clinicaltrials_orange_book" ] }, "sourceOptions": { "title": "Per-source options", "type": "object", "description": "Options keyed by source id, e.g. {\"clinicaltrials_orange_book\": {\"sponsors\": [\"Pfizer\"]}}. Each source validates its own slice and rejects unknown keys. Put credentials in the secret fields below, not here.", "default": {} }, "deltaMode": { "title": "Delta mode", "enum": [ "all", "onlyChanged", "onlyNew" ], "type": "string", "description": "onlyChanged = new and changed records (default). onlyNew = new records only. all = every record, unchanged ones included.", "default": "onlyChanged" }, "stateNamespace": { "title": "Delta memory namespace", "type": "string", "description": "Keeps delta memory separate between Tasks (different watchlists, filters or delta modes would otherwise consume each other's \"new\" records). Leave empty to use one namespace per Task, or \"default\" for ad-hoc runs. 1-40 characters: a-z, 0-9, \"-\"." }, "maxItemsPerSource": { "title": "Max records per source", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper bound on records taken from each source in one run.", "default": 500 }, "watchlistNames": { "title": "Watchlist keywords", "type": "array", "description": "Case-insensitive substrings matched against each record's names. Entries shorter than 3 characters, blank or punctuation-only entries are ignored. With no valid keyword nothing matches and the watchlist-hit event is never charged.", "default": [], "items": { "type": "string" } }, "maxWatchlistHitsPerRun": { "title": "Max billable watchlist hits per run", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Hard ceiling on watchlist-hit events charged in one run.", "default": 200 }, "maxWatchlistSpendUsd": { "title": "Max watchlist-hit spend per run (USD)", "minimum": 0, "maximum": 10000, "type": "number", "description": "Hard ceiling on USD charged for watchlist-hit in one run.", "default": 50 }, "usptoOdpApiKey": { "title": "USPTO Open Data Portal API key", "type": "string", "description": "Bring-your-own credential for uspto_ptab. Stored encrypted by Apify and never logged." }, "epoOpsConsumerKey": { "title": "EPO OPS consumer key", "type": "string", "description": "Bring-your-own credential for epo_opposition. Stored encrypted by Apify and never logged." }, "epoOpsConsumerSecret": { "title": "EPO OPS consumer secret", "type": "string", "description": "Bring-your-own credential for epo_opposition. Stored encrypted by Apify and never logged." }, "fdaApiKey": { "title": "openFDA API key (optional)", "type": "string", "description": "Bring-your-own credential for clinicaltrials_orange_book. Stored encrypted by Apify and never logged." } } }, "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 } } } } } } } } } }