{ "openapi": "3.0.1", "info": { "title": "USPTO Patent Ownership & Assignment Monitor", "description": "Monitor patents, applications and companies for newly recorded USPTO assignment and ownership events. Compare official Assignment Center records with last successful state and emit typed conveyance alerts.", "version": "0.1", "x-build-id": "hQpgBFJkBHcYTkPvn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~uspto-patent-assignment-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-uspto-patent-assignment-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/automa-flow~uspto-patent-assignment-monitor/runs": { "post": { "operationId": "runs-sync-automa-flow-uspto-patent-assignment-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/automa-flow~uspto-patent-assignment-monitor/run-sync": { "post": { "operationId": "run-sync-automa-flow-uspto-patent-assignment-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": { "mode": { "title": "Mode", "enum": [ "watchlist" ], "type": "string", "description": "watchlist checks the patents, applications, publications and companies you supply. The daily bulk-XML mode is not offered because USPTO's PASDL portal no longer publishes an unattended daily file; it would fail every run.", "default": "watchlist" }, "monitorKey": { "title": "Monitor key", "pattern": "^[A-Za-z0-9_-]{1,80}$", "minLength": 1, "maxLength": 80, "type": "string", "description": "Use one key per watchlist. The same key compares against its last verified state. Adding a target creates its own baseline; removing a target prunes its stored assignments.", "default": "default" }, "patentNumbers": { "title": "Patent numbers", "maxItems": 1000, "type": "array", "description": "Granted USPTO patent numbers. Spaces, commas and a leading US prefix are ignored, including design (USD…), reissue (USRE45824) and plant (USPP33095) numbers. Each number is checked independently.", "items": { "type": "string", "minLength": 1, "maxLength": 32 } }, "applicationNumbers": { "title": "Application numbers", "maxItems": 1000, "type": "array", "description": "USPTO application numbers, digits only after punctuation is stripped.", "items": { "type": "string", "minLength": 1, "maxLength": 32 } }, "publicationNumbers": { "title": "Publication numbers", "maxItems": 1000, "type": "array", "description": "Pre-grant publication numbers such as US20180191929A1. A missing US prefix is added.", "items": { "type": "string", "minLength": 1, "maxLength": 32 } }, "companies": { "title": "Companies", "maxItems": 200, "type": "array", "description": "Exact assignee/assignor names; add aliases for accepted spellings. contains only filters the returned exact-name search. Large company histories can be truncated before recent records are reached; PARTIAL with no matching observations is not billed or stored. Use patent numbers when complete company coverage is unavailable.", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "title": "Company name", "type": "string", "description": "Exact assignee or assignor name as recorded at USPTO. Add aliases for other spellings.", "editor": "textfield", "minLength": 1, "maxLength": 200 }, "role": { "title": "Role", "type": "string", "description": "Search assignees, assignors, or either. Assignee and assignor watches do not share comparison state.", "editor": "select", "enum": [ "assignee", "assignor", "either" ], "default": "either" }, "aliases": { "title": "Aliases", "type": "array", "description": "Additional exact-normalized spellings that count as the same company. IBM does not match International Business Machines unless you add that alias.", "editor": "stringList", "maxItems": 20, "items": { "type": "string" } }, "match": { "title": "Match", "type": "string", "description": "exact keeps only records for those normalized names. contains is a local substring filter of records already returned for the exact names, not a USPTO wildcard.", "editor": "select", "enum": [ "exact", "contains" ], "enumTitles": [ "Exact normalized name", "Local substring of exact-search hits" ], "default": "exact" } }, "required": [ "name" ] } }, "conveyanceTypes": { "title": "Conveyance types", "maxItems": 9, "type": "array", "description": "Keep only these conveyance categories. Leave empty to keep every recorded document type, including OTHER.", "items": { "type": "string", "enum": [ "ASSIGNMENT", "MERGER", "NAME_CHANGE", "SECURITY_INTEREST", "LIEN_OR_MORTGAGE", "LICENSE", "RELEASE", "CORRECTIVE_ASSIGNMENT", "OTHER" ] } }, "changesOnly": { "title": "Changes only", "type": "boolean", "description": "Show only CHANGE rows after the baseline when enabled. The Console demo keeps this off so an unchanged demo still returns current observations. Error and incomplete-check receipts remain visible.", "default": true }, "baselineMode": { "title": "Baseline mode", "enum": [ "emitSnapshot", "storeOnly" ], "type": "string", "description": "emitSnapshot returns each target's first verified observation. If initial coverage is partial, unseen records remain BASELINE until a complete check is saved. storeOnly saves these silently. Updates to known records remain CHANGE events.", "default": "emitSnapshot" }, "lookbackDays": { "title": "Company lookback (days)", "minimum": 1, "maximum": 366, "type": "integer", "description": "Filter company observations by recorded date over the last 1-366 days. This is a local filter, not a server-side date search or a guarantee of complete company coverage.", "default": 90 } } }, "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 } } } } } } } } } }