{ "openapi": "3.0.1", "info": { "title": "Apify Portfolio Expansion Planner", "description": "Rank user-supplied candidate niches by public Store opportunity and textual adjacency to a user-supplied portfolio. Public Store API only for candidates, no portfolio fetching.", "version": "0.1", "x-build-id": "a7k7Udl0hN6UlS5ry" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zinin~apify-portfolio-expansion-planner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zinin-apify-portfolio-expansion-planner", "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~apify-portfolio-expansion-planner/runs": { "post": { "operationId": "runs-sync-zinin-apify-portfolio-expansion-planner", "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~apify-portfolio-expansion-planner/run-sync": { "post": { "operationId": "run-sync-zinin-apify-portfolio-expansion-planner", "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": [ "schemaVersion", "requestId", "portfolioActors", "candidateQueries" ], "properties": { "schemaVersion": { "title": "Schema version", "enum": [ "1.0" ], "type": "string", "description": "Contract version.", "default": "1.0" }, "requestId": { "title": "Request ID", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string", "description": "Idempotency key." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum nested expansions.", "default": 10 }, "freshnessMinutes": { "title": "Freshness minutes", "minimum": 0, "maximum": 10080, "type": "integer", "description": "Maximum cache age.", "default": 60 }, "detailLevel": { "title": "Detail level", "enum": [ "compact", "evidence" ], "type": "string", "description": "Output detail mode.", "default": "compact" }, "portfolioActors": { "title": "Portfolio actors", "minItems": 1, "maxItems": 50, "type": "array", "description": "Existing portfolio used for adjacency scoring.", "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "title": "Actor ID", "type": "string", "pattern": "^(?!.*[\\u0000-\\u001F\\u007F])(?!.*[A-Za-z][A-Za-z0-9+.-]{1,31}:(//|[^\\s]+)).*$", "description": "Stable Actor identifier.", "minLength": 1, "maxLength": 64 }, "name": { "title": "Actor name", "type": "string", "pattern": "^(?!.*[\\u0000-\\u001F\\u007F])(?!.*[A-Za-z][A-Za-z0-9+.-]{1,31}:(//|[^\\s]+)).*$", "description": "Actor name.", "minLength": 1, "maxLength": 120 }, "title": { "title": "Actor title", "type": "string", "nullable": true, "pattern": "^(?!.*[\\u0000-\\u001F\\u007F])(?!.*[A-Za-z][A-Za-z0-9+.-]{1,31}:(//|[^\\s]+)).*$", "description": "Optional Actor title.", "maxLength": 120 }, "description": { "title": "Actor description", "type": "string", "nullable": true, "pattern": "^(?!.*[\\u0000-\\u001F\\u007F])(?!.*[A-Za-z][A-Za-z0-9+.-]{1,31}:(//|[^\\s]+)).*$", "description": "Optional Actor description.", "maxLength": 1000 }, "categories": { "title": "Categories", "type": "array", "description": "Optional Actor categories.", "minItems": 0, "maxItems": 5, "uniqueItems": true, "items": { "type": "string", "pattern": "^(?!.*[\\u0000-\\u001F\\u007F])(?!.*[A-Za-z][A-Za-z0-9+.-]{1,31}:(//|[^\\s]+)).*$", "minLength": 1, "maxLength": 40 } } }, "required": [ "id", "name", "categories" ] } }, "candidateQueries": { "title": "Candidate queries", "minItems": 1, "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Candidate niches to evaluate for portfolio expansion.", "items": { "type": "string", "pattern": "^(?!.*[\\u0000-\\u001F\\u007F])(?!.*[A-Za-z][A-Za-z0-9+.-]{1,31}:(//|[^\\s]+)).*$", "minLength": 2, "maxLength": 80 } } } }, "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 } } } } } } } } } }