{ "openapi": "3.0.1", "info": { "title": "Patent Filing Monitor", "description": "Normalize buyer-owned, rights-holder-authorized, PatentsView CC BY 4.0, or licensed patent exports into provenance-linked evidence rows with stable identity, freshness, confidence gaps, review priority, and current-run settlement. No source fetch, login, legal conclusion, or automated decision.", "version": "0.2", "x-build-id": "4MDCwCBsLIaIcvYoy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zinin~patent-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zinin-patent-monitor", "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/zinin~patent-monitor/runs": { "post": { "operationId": "runs-sync-zinin-patent-monitor", "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/zinin~patent-monitor/run-sync": { "post": { "operationId": "run-sync-zinin-patent-monitor", "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": { "schemaVersion": { "title": "Contract version", "enum": [ "2.0" ], "type": "string", "description": "Closed public input contract version.", "default": "2.0" }, "authorization": { "title": "Rights confirmation", "enum": [ "I confirm I may process and commercially use these patent records." ], "type": "string", "description": "Required buyer attestation of processing and commercial-use rights; recorded but not independently verified by the Actor.", "default": "I confirm I may process and commercially use these patent records." }, "sourceContext": { "title": "Source rights context", "enum": [ "buyer_owned_patent_export", "rights_holder_authorized_export", "patentsview_cc_by_4_export", "other_licensed_patent_export" ], "type": "string", "description": "Buyer-declared rights context for the supplied structured export; the Actor records but does not independently verify it.", "default": "patentsview_cc_by_4_export" }, "watchName": { "title": "Review batch name", "pattern": "\\S", "minLength": 1, "maxLength": 80, "type": "string", "description": "Stable buyer label returned with this review batch; it is not a cross-run source baseline.", "default": "patent-evidence-review" }, "freshnessDays": { "title": "Freshness threshold (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Age threshold used to label buyer-supplied patent evidence as fresh, stale, or unknown.", "default": 30 }, "patents": { "title": "Authorized patent records", "minItems": 1, "maxItems": 100, "type": "array", "description": "1–100 buyer-owned, rights-holder-authorized, PatentsView CC BY 4.0, or otherwise licensed records. sourceLicense and changesMade are required for attribution truth.", "items": { "type": "object", "additionalProperties": false, "properties": { "sourceQuery": { "title": "Source Query", "description": "Buyer-supplied source query for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "nullable": true, "maxLength": 200, "pattern": "\\S" }, "patentId": { "title": "Patent Id", "description": "Buyer-supplied patent id for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[A-Za-z0-9._/\\-]+$" }, "title": { "title": "Title", "description": "Buyer-supplied title for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "minLength": 1, "maxLength": 500, "pattern": "\\S" }, "patentDate": { "title": "Patent Date", "description": "Buyer-supplied patent date for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "assignee": { "title": "Assignee", "description": "Buyer-supplied assignee for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "nullable": true, "maxLength": 300, "pattern": "\\S" }, "abstractSnippet": { "title": "Abstract Snippet", "description": "Buyer-supplied abstract snippet for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "nullable": true, "maxLength": 1000, "pattern": "\\S" }, "url": { "title": "Url", "description": "Buyer-supplied url for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "nullable": true, "maxLength": 2000, "pattern": "^https://" }, "jurisdiction": { "title": "Jurisdiction", "description": "Buyer-supplied jurisdiction for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "nullable": true, "maxLength": 40, "pattern": "\\S" }, "recordStatus": { "title": "Record Status", "description": "Buyer-supplied record status for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "enum": [ "granted", "published", "application", "unknown" ] }, "sourceName": { "title": "Source Name", "description": "Buyer-supplied source name for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "minLength": 1, "maxLength": 200, "pattern": "\\S" }, "sourceUrl": { "title": "Source Url", "description": "Buyer-supplied source url for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "minLength": 9, "maxLength": 2000, "pattern": "^https://" }, "sourceLicense": { "title": "Source License", "description": "Buyer-supplied source license for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "minLength": 1, "maxLength": 700, "pattern": "\\S" }, "changesMade": { "title": "Changes Made", "description": "Buyer-supplied changes made for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "minLength": 1, "maxLength": 500, "pattern": "\\S" }, "sourceRetrievedAt": { "title": "Source Retrieved At", "description": "Buyer-supplied source retrieved at for the authorized patent record; recorded as submitted and not independently verified by the Actor.", "type": "string", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,9})?Z$" } }, "required": [ "patentId", "title", "sourceName", "sourceUrl", "sourceLicense", "changesMade" ] }, "default": [ { "sourceQuery": "battery thermal management", "patentId": "US12345678B2", "title": "Thermal management system for an energy storage assembly", "patentDate": "2026-07-14", "assignee": "Example Energy Systems Inc.", "abstractSnippet": "A supplied excerpt describing a thermal management assembly.", "url": "https://patents.google.com/patent/US12345678B2/en", "jurisdiction": "US", "recordStatus": "granted", "sourceName": "PatentsView PatentSearch export", "sourceUrl": "https://search.patentsview.org/docs/", "sourceLicense": "CC BY 4.0; attribution and indication of changes required.", "changesMade": "Selected fields, normalized whitespace, and truncated the supplied abstract excerpt.", "sourceRetrievedAt": "2026-08-12T10:00:00.000Z" } ] }, "queries": { "title": "Legacy queries (migration only)", "minItems": 1, "maxItems": 25, "type": "array", "description": "Backward-compatible API field. Google Patents and PatentsView are not called. A free diagnostic explains how to submit an authorized export.", "items": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "\\S" } }, "sinceDays": { "title": "Legacy lookback", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Legacy migration-only lookback value; no external patent source is queried." }, "limit": { "title": "Legacy result limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Legacy migration-only result limit; no external patent source is queried." }, "maxConcurrency": { "title": "Legacy concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Legacy migration-only concurrency value; the current zero-network processor does not use it." }, "patentsviewApiKey": { "title": "Legacy PatentsView key (not used)", "type": "string", "description": "Backward-compatible secret field. It remains stored in the run INPUT by Apify if supplied, but this Actor does not read, log, transmit, or copy it to Dataset/OUTPUT." } } }, "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 } } } } } } } } } }