{ "openapi": "3.0.1", "info": { "title": "ActorWebApp", "description": "Turn a compatible Apify Actor into a branded web app with a simple input form, run status, Dataset results, exports, and shareable Standby URL. Give customers and teammates an easier way to use your Actor without exposing your API token.", "version": "0.0", "x-build-id": "BBGhKZXIBPmjIN6VN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solutionssmart~ActorWebApp/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solutionssmart-ActorWebApp", "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/solutionssmart~ActorWebApp/runs": { "post": { "operationId": "runs-sync-solutionssmart-ActorWebApp", "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/solutionssmart~ActorWebApp/run-sync": { "post": { "operationId": "run-sync-solutionssmart-ActorWebApp", "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": [ "actorId" ], "properties": { "actorId": { "title": "Target Actor ID", "pattern": "^[a-zA-Z0-9][\\w-]{1,63}[\\/~][a-zA-Z0-9][\\w-]{1,79}$", "type": "string", "description": "Actor in username/actor-name format.", "default": "solutionssmart/brand-dna" }, "title": { "title": "App title", "type": "string", "description": "Optional title shown to end users." }, "description": { "title": "App description", "type": "string", "description": "Optional short explanation of the app." }, "branding": { "title": "Branding", "type": "object", "description": "Control the app identity, accent color, theme, and Apify field visibility.", "properties": { "logoUrl": { "title": "Logo URL", "type": "string", "description": "Optional HTTPS image URL shown in the app header.", "editor": "textfield", "pattern": "^(?:|https:\\/\\/[^\\s]+)$", "default": "" }, "accentColor": { "title": "Accent color", "type": "string", "description": "Six-digit hexadecimal color used for actions and highlights.", "editor": "textfield", "pattern": "^#[0-9a-fA-F]{6}$", "default": "#19724c" }, "theme": { "title": "Theme", "type": "string", "description": "Choose the visual style of the generated app.", "editor": "select", "enum": [ "light", "dark", "warm" ], "enumTitles": [ "Light", "Dark", "Warm" ], "default": "light" }, "hideApifyTechnicalFields": { "title": "Hide Apify technical fields", "type": "boolean", "description": "Hide common platform and runtime fields from the generated form.", "editor": "checkbox", "default": true } }, "default": { "logoUrl": "", "accentColor": "#19724c", "theme": "light", "hideApifyTechnicalFields": true } }, "input": { "title": "Input display", "type": "object", "description": "Choose how much of the target Actor input schema is shown to end users.", "properties": { "showAdvancedFields": { "title": "Show advanced fields", "type": "boolean", "description": "Show optional fields that are commonly used for advanced runs.", "editor": "checkbox", "default": true } }, "default": { "showAdvancedFields": true } }, "output": { "title": "Output display", "type": "object", "description": "Choose which result views and exports are available after a run.", "properties": { "showTable": { "title": "Show results table", "type": "boolean", "description": "Display a preview of the target Actor's default Dataset.", "editor": "checkbox", "default": true }, "allowCsv": { "title": "Allow CSV export", "type": "boolean", "description": "Add a CSV download action for the target Dataset.", "editor": "checkbox", "default": true }, "allowJson": { "title": "Allow JSON export", "type": "boolean", "description": "Add a JSON download action for the target Dataset.", "editor": "checkbox", "default": true }, "maxPreviewRows": { "title": "Maximum preview rows", "type": "integer", "description": "Number of Dataset rows shown in the table, from 1 to 500.", "editor": "number", "minimum": 1, "maximum": 500, "default": 100 } }, "default": { "showTable": true, "allowCsv": true, "allowJson": true, "maxPreviewRows": 100 } } } }, "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 } } } } } } } } } }