{ "openapi": "3.0.1", "info": { "title": "Keyword Intent SERP Classifier", "description": "Classify query intent using SERP evidence such as result types, dominant page formats, transactional modifiers, local packs, comparison pages, videos,...", "version": "1.0", "x-build-id": "AKZOoHlJpcSqHvGzt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~keyword-intent-serp-classifier/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-keyword-intent-serp-classifier", "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/junipr~keyword-intent-serp-classifier/runs": { "post": { "operationId": "runs-sync-junipr-keyword-intent-serp-classifier", "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/junipr~keyword-intent-serp-classifier/run-sync": { "post": { "operationId": "run-sync-junipr-keyword-intent-serp-classifier", "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": { "startUrls": { "title": "Public snapshot URLs", "type": "array", "description": "Optional explicit public URLs; private and non-HTTP targets are rejected.", "items": { "type": "string" }, "default": [] }, "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Optional permitted public sitemap URLs.", "items": { "type": "string" }, "default": [] }, "htmlInputs": { "title": "HTML inputs", "type": "array", "description": "Deterministic HTML objects with sourceId, sourceUrl, and query context.", "items": { "type": "object", "additionalProperties": true }, "default": [] }, "allowedDomains": { "title": "Allowed domains", "type": "array", "description": "Optional hostname allowlist for network fetches.", "items": { "type": "string" }, "default": [] }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 25, "type": "integer", "description": "Overall HTML target cap.", "default": 1 }, "maxDepth": { "title": "Maximum crawl depth", "minimum": 0, "maximum": 0, "type": "integer", "description": "Fixed at zero because discovered links are not crawled.", "default": 0 }, "includeEvidence": { "title": "Include evidence", "type": "boolean", "description": "Include source evidence excerpts in dataset rows.", "default": true }, "includeRawSnapshots": { "title": "Store raw snapshots", "type": "boolean", "description": "Store capped raw HTML in key-value storage.", "default": false }, "requestDelayMs": { "title": "Request delay", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Delay between permitted public fetches.", "default": 250 }, "timeoutMs": { "title": "Request timeout", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Per-request timeout in milliseconds.", "default": 15000 }, "userAgentMode": { "title": "User agent mode", "enum": [ "standard", "compatibility" ], "type": "string", "description": "Standard or compatibility request header.", "default": "standard" }, "serpResults": { "title": "SERP result snapshots", "type": "array", "description": "Query-linked result records or snapshot objects containing results.", "items": { "type": "object", "additionalProperties": true }, "default": [] }, "queries": { "title": "Queries", "type": "array", "description": "Queries to classify when matching SERP evidence is supplied.", "items": { "type": "string" }, "default": [ "best workflow software" ] }, "serpHtmlInputs": { "title": "SERP HTML inputs", "type": "array", "description": "Captured query-linked SERP HTML objects.", "items": { "type": "object", "additionalProperties": true }, "default": [] }, "customIntentRules": { "title": "Custom intent rules", "type": "array", "description": "Optional objects with name or intent, regex pattern, and weight.", "items": { "type": "string" }, "default": [] }, "includeEvidenceUrls": { "title": "Include evidence URLs", "type": "boolean", "description": "Allow source URLs in common evidence fields.", "default": true }, "classifierMode": { "title": "Classifier mode", "enum": [ "standard", "strict" ], "type": "string", "description": "Deterministic evidence scoring profile.", "default": "standard" }, "confidenceThreshold": { "title": "Confidence threshold", "minimum": 0, "maximum": 1, "type": "number", "description": "Minimum top-score share required before selecting a single primary intent.", "default": 0.5 }, "maxQueries": { "title": "Maximum queries", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum distinct queries classified.", "default": 1 }, "maxSnapshots": { "title": "Maximum snapshots", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum supplied snapshots processed.", "default": 1 }, "maxSignalsPerQuery": { "title": "Signals per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum SERP evidence records scored per query.", "default": 25 }, "maxChargeUsd": { "title": "Maximum charge", "minimum": 0, "type": "number", "description": "Maximum accepted PPE spend before paid output stops.", "default": 35 }, "includeReport": { "title": "Write reports", "type": "boolean", "description": "Write Markdown, CSV, JSON evidence, and run metadata.", "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 } } } } } } } } } }