# Output schema demo (`gip/output-schema-demo`) Actor Demonstrates all output schema options - **URL**: https://securitybyobscurity.apify.com/gip/output-schema-demo.md - **Developed by:** [Jaroslav Hejlek](https://securitybyobscurity.apify.com/gip) (community) - **Categories:** Developer tools - **Stats:** 3 total users, 2 monthly users, 0.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ### Empty TypeScript template Start a new [web scraping](https://apify.com/web-scraping) project quickly and easily in TypeScript (Node.js) with our empty project template. It provides a basic structure for the Actor with [Apify SDK](https://docs.apify.com/sdk/js/) and allows you to easily add your own functionality. ### Included features - **[Apify SDK](https://docs.apify.com/sdk/js/)** - a toolkit for building [Actors](https://apify.com/actors) - **[Crawlee](https://crawlee.dev/)** - web scraping and browser automation library ### How it works Insert your own code between `await Actor.init()` and `await Actor.exit()`. If you would like to use the [Crawlee](https://crawlee.dev/) library simply uncomment its import `import { CheerioCrawler } from '@crawlee/cheerio';`. ### Input The Actor produces its output (key-value files and datasets) immediately, then keeps running so you can open the live view. Two optional fields control its lifecycle: | Field | Type | Default | Description | | --- | --- | --- | --- | | `liveViewDelaySecs` | integer (seconds) | `0` | How long to wait after the run starts before the live view becomes available. `0` starts it right away. | | `maxRunTimeSecs` | integer (seconds) | `0` | Total run-time cap, measured from run start (the live-view delay counts towards it). The Actor stops itself once reached. `0` runs indefinitely until you press **Stop** in the live view or abort the run. | Both default to `0`, which preserves the original behavior: the live view starts immediately and the run lives on until you stop it manually. ### Resources - [TypeScript vs. JavaScript: which to use for web scraping?](https://blog.apify.com/typescript-vs-javascript-crawler/) - [Node.js tutorials](https://docs.apify.com/academy/node-js) in Academy - [Video guide on getting scraped data using Apify API](https://www.youtube.com/watch?v=ViYYDHSBAKM) - [Integration with Airbyte](https://apify.com/integrations), Make, Zapier, Google Drive, and other apps - A short guide on how to build web scrapers using code templates: [web scraper template](https://www.youtube.com/watch?v=u-i-Korzf8w) ### Getting started For complete information [see this article](https://docs.apify.com/platform/actors/development#build-actor-locally). To run the Actor use the following command: ```bash apify run ```` ### Deploy to Apify #### Connect Git repository to Apify If you've created a Git repository for the project, you can easily connect to Apify: 1. Go to [Actor creation page](https://console.apify.com/actors/new) 2. Click on **Link Git Repository** button #### Push project on your local machine to Apify You can also deploy the project on your local machine to Apify without the need for the Git repository. 1. Log in to Apify. You will need to provide your [Apify API Token](https://console.apify.com/account/integrations) to complete this action. ```bash apify login ``` 2. Deploy your Actor. This command will deploy and build the Actor on the Apify Platform. You can find your newly created Actor under [Actors -> My Actors](https://console.apify.com/actors?tab=my). ```bash apify push ``` ### Documentation reference To learn more about Apify and Actors, take a look at the following resources: - [Apify SDK for JavaScript documentation](https://docs.apify.com/sdk/js) - [Apify SDK for Python documentation](https://docs.apify.com/sdk/python) - [Apify Platform documentation](https://docs.apify.com/platform) - [Join our developer community on Discord](https://discord.com/invite/jyEM2PRvMU) # Actor input Schema ## `liveViewDelaySecs` (type: `integer`): How many seconds to wait after the run starts before the live view becomes available. The Actor still produces its output (key-value files and datasets) immediately — only the live view is delayed. Set to 0 to start the live view right away. ## `maxRunTimeSecs` (type: `integer`): Maximum total run time in seconds, measured from the start of the run (the live view delay counts towards it). When the limit is reached, the Actor stops itself. Set to 0 (default) to run indefinitely until you press Stop in the live view or abort the run. ## Actor input object example ```json { "liveViewDelaySecs": 0, "maxRunTimeSecs": 0 } ``` # Actor output Schema ## `liveView` (type: `string`): No description ## `plans` (type: `string`): No description ## `ideas` (type: `string`): No description ## `plan_files` (type: `string`): No description ## `screenshots` (type: `string`): No description ## `allFiles` (type: `string`): No description ## `sampleJson` (type: `string`): No description ## `sampleMarkdown` (type: `string`): No description ## `sampleHtml` (type: `string`): No description ## `sampleText` (type: `string`): No description ## `samplePng` (type: `string`): No description ## `sampleJpeg` (type: `string`): No description ## `sampleArchive` (type: `string`): No description ## `externalLink` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("gip/output-schema-demo").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("gip/output-schema-demo").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call gip/output-schema-demo --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=gip/output-schema-demo", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Output schema demo", "description": "Demonstrates all output schema options", "version": "0.0", "x-build-id": "m7I5h47Xl6UfQtPYP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gip~output-schema-demo/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gip-output-schema-demo", "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/gip~output-schema-demo/runs": { "post": { "operationId": "runs-sync-gip-output-schema-demo", "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/gip~output-schema-demo/run-sync": { "post": { "operationId": "run-sync-gip-output-schema-demo", "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": { "liveViewDelaySecs": { "title": "Live view start delay (seconds)", "minimum": 0, "type": "integer", "description": "How many seconds to wait after the run starts before the live view becomes available. The Actor still produces its output (key-value files and datasets) immediately — only the live view is delayed. Set to 0 to start the live view right away.", "default": 0 }, "maxRunTimeSecs": { "title": "Auto-stop timeout (seconds)", "minimum": 0, "type": "integer", "description": "Maximum total run time in seconds, measured from the start of the run (the live view delay counts towards it). When the limit is reached, the Actor stops itself. Set to 0 (default) to run indefinitely until you press Stop in the live view or abort the run.", "default": 0 } } }, "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 } } } } } } } } } } ```