{ "openapi": "3.0.1", "info": { "title": "Patent & IP Filing Monitor", "description": "Recurring USPTO patent monitoring for assignees, inventors, keywords, and CPC classifications with relevance scoring and alert-ready output.", "version": "1.0", "x-build-id": "MlJeV3FTgunsJGi6D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vamsi-krishna~patent-ip-filing-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vamsi-krishna-patent-ip-filing-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/vamsi-krishna~patent-ip-filing-monitor/runs": { "post": { "operationId": "runs-sync-vamsi-krishna-patent-ip-filing-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/vamsi-krishna~patent-ip-filing-monitor/run-sync": { "post": { "operationId": "run-sync-vamsi-krishna-patent-ip-filing-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": { "demoMode": { "title": "Demo mode (sample data)", "type": "boolean", "description": "ON = built-in sample patents for testing (not live USPTO). OFF for production only if you add your USPTO ODP API key below.", "default": true }, "usptoApiKey": { "title": "USPTO ODP API Key (your key, live data)", "type": "string", "description": "Required for live USPTO search. Each user must supply their own free key from data.uspto.gov (USPTO.gov account + validated ID.me). Stored as a secret; never shared by the Actor publisher." }, "dataSource": { "title": "Data Source", "enum": [ "auto", "demo", "odp", "patentsview" ], "type": "string", "description": "auto = live ODP when usptoApiKey is set, otherwise demo samples. demo = samples only. odp = live USPTO (key required). patentsview = legacy grants only (often unavailable).", "default": "auto" }, "searchDocumentTypes": { "title": "Document Types", "type": "array", "description": "Applications and/or grants. Live search needs usptoApiKey; demo mode includes both types as samples.", "items": { "type": "string", "enum": [ "application", "grant" ] }, "default": [ "application", "grant" ] }, "companyNames": { "title": "Company / Assignee Names", "type": "array", "description": "Company or assignee names to monitor (e.g. Apple Inc., Google LLC).", "default": [], "items": { "type": "string" } }, "inventorNames": { "title": "Inventor Names", "type": "array", "description": "Inventor names to track.", "default": [], "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Keywords to search in titles, abstracts, and claims.", "default": [], "items": { "type": "string" } }, "cpcClassifications": { "title": "CPC Classifications", "type": "array", "description": "CPC codes to monitor (e.g. G06N3/00).", "default": [], "items": { "type": "string" } }, "ipcClassifications": { "title": "IPC Classifications", "type": "array", "description": "IPC codes (live search via USPTO ODP key; demo uses sample matches).", "default": [], "items": { "type": "string" } }, "competitorList": { "title": "Competitor List", "type": "array", "description": "Competitor assignees for competitive intelligence.", "default": [], "items": { "type": "string" } }, "publicationDateFrom": { "title": "Publication Date From", "type": "string", "description": "Start date YYYY-MM-DD (live ODP; ignored in demo)." }, "publicationDateTo": { "title": "Publication Date To", "type": "string", "description": "End date YYYY-MM-DD (live ODP; ignored in demo)." }, "applicationDateFrom": { "title": "Application Date From", "type": "string", "description": "Filing date start YYYY-MM-DD (live ODP; ignored in demo)." }, "applicationDateTo": { "title": "Application Date To", "type": "string", "description": "Filing date end YYYY-MM-DD (live ODP; ignored in demo)." }, "patentStatus": { "title": "Patent Status", "type": "array", "description": "Status filter for live USPTO ODP. Demo returns sample statuses regardless.", "items": { "type": "string", "enum": [ "Application", "Published", "Granted", "Expired", "Abandoned" ] }, "default": [ "Application", "Published", "Granted" ] }, "technologyCategory": { "title": "Technology Category", "type": "string", "description": "Label for reporting (e.g. AI/ML, Biotech)." }, "alertFrequency": { "title": "Alert Frequency", "enum": [ "daily", "weekly", "monthly", "once" ], "type": "string", "description": "Affects batch ID and incremental deduplication.", "default": "once" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Max patents per search query.", "default": 100 }, "outputFormat": { "title": "Output Format", "enum": [ "json", "csv", "all" ], "type": "string", "description": "json = dataset only; csv/all also writes OUTPUT to key-value store.", "default": "json" }, "includeClaims": { "title": "Include Claims Summary", "type": "boolean", "description": "Whether to extract and include patent claims summary in the output.", "default": true }, "includeCitations": { "title": "Include Citations", "type": "boolean", "description": "Whether to include forward and backward citations in the output.", "default": true }, "minRelevanceScore": { "title": "Minimum Relevance Score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Filter results below this score (0-100). Store QA uses prefill 30 so demo Try-it runs always return matches.", "default": 30 }, "enableRiskAssessment": { "title": "Enable Risk Assessment", "type": "boolean", "description": "Calculate risk level from competitor matches and patent status.", "default": true } } }, "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 } } } } } } } } } }