{ "openapi": "3.0.1", "info": { "title": "Windows Installer Builder for Actors", "description": "Turns a Node.js actor's source code (.zip) into a Windows installer that runs the actor as a Windows service, managed from a local web console at https://localhost.", "version": "0.1", "x-build-id": "QDMYrUJWc5OeatfcZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dtrungtin~windows-installer-builder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dtrungtin-windows-installer-builder", "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/dtrungtin~windows-installer-builder/runs": { "post": { "operationId": "runs-sync-dtrungtin-windows-installer-builder", "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/dtrungtin~windows-installer-builder/run-sync": { "post": { "operationId": "run-sync-dtrungtin-windows-installer-builder", "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": [ "sourceZip" ], "properties": { "sourceZip": { "title": "Actor source code (.zip)", "type": "string", "description": "The actor's source code as a .zip file, such as the one you download from the actor's Source tab in Apify Console, or the URL of one (for example a GitHub archive). Only Node.js actors (JavaScript or TypeScript) are supported." }, "appName": { "title": "Application name", "type": "string", "description": "Name shown in the installer, in Apps & features and as the service's display name. Defaults to the title in .actor/actor.json." }, "version": { "title": "Version", "pattern": "^\\d+(\\.\\d+){0,3}$", "type": "string", "description": "Installer version, for example 1.2.0. Defaults to the version in .actor/actor.json. Use a higher number for each release so upgrades are easy to tell apart." }, "serviceName": { "title": "Service name", "pattern": "^[A-Za-z][A-Za-z0-9_-]{0,39}$", "type": "string", "description": "Windows service name. It also names the data folder in C:\\ProgramData and identifies the installation for upgrades, so keep it the same across versions. Defaults to the actor name in PascalCase, for example SimpleBookingScraper." }, "defaultPort": { "title": "Default HTTPS port", "minimum": 1, "maximum": 65535, "type": "integer", "description": "Port the installer suggests for the web console. With 443 the console is at https://localhost. The person installing can change it, and upgrades keep the port already in use.", "default": 443 }, "publisher": { "title": "Publisher", "type": "string", "description": "Publisher shown in Apps & features and in the installer's file properties." }, "nodeVersion": { "title": "Node.js version", "pattern": "^\\d+(\\.\\d+\\.\\d+)?$", "type": "string", "description": "Node.js version to bundle, as a major version (24) or an exact one (24.14.1). By default the builder uses the major version from the actor's Dockerfile, raised to the oldest supported LTS version when that one is end-of-life or too old for the actor's packages." }, "startCommand": { "title": "Start command", "type": "string", "description": "How to start the actor, in the form \"node \", for example \"node dist/main.js\". By default the builder reads it from the Dockerfile's CMD and the scripts in package.json." } } }, "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 } } } } } } } } } }