# Actor Readme Generator (`apify/actor-readme-generator`) Actor An AI agent that can generate a README for scrapers based on an Apify-approved template. - **URL**: https://apify.com/apify/actor-readme-generator.md - **Developed by:** [Apify](https://apify.com/apify) (Apify) - **Categories:** Developer tools - **Stats:** 142 total users, 17 monthly users, 100.0% runs succeeded, 7 bookmarks - **User rating**: 4.11 out of 5 stars ## Pricing $0.05 / single readme This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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 ### What does the Actor README Generator do? The Actor README generator uses an Apify-approved template to generate a README for your scraper. The Actor currently uses only one template, which is optimized for scrapers, so if your use case is more specific, you may want to try your hand at creating your own prompt. **Important**: the generated README is not final and we can't guarantee it will be correct - you should still go through it and improve it, adjust the links if needed, and add images. ### How to generate your README 1. Input your Actor's title, a brief description of what it does, the site it scrapes, and some example READMEs, if you have some that you'd like to emulate. 2. Provide a sample of your Actor's output in JSON format. 3. Provide your OpenAI API key. ### How does the Actor work? The Actor combines the details from your input with the template and uses this as a prompt for ChatGPT 3.5 Turbo. The generated README is then saved to a key-value store. # Actor input Schema ## `actorTitle` (type: `string`): The title of your actor ## `actorDescription` (type: `string`): What does your actor do? Describe it in a couple of sentences. Give examples if appropriate. ## `targetWebsite` (type: `string`): The website your actor is targeting ## `readmeExamples` (type: `array`): Provide some quality Actor README to base yours on. ## `sampleData` (type: `object`): A sample of your Actor's output in JSON format. ## Actor input object example ```json { "readmeExamples": [ "https://apify.com/misceres/indeed-scraper", "https://apify.com/lukaskrivka/google-maps-with-contact-details", "https://apify.com/apify/facebook-events-scraper" ] } ```` # 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 = { "readmeExamples": [ "https://apify.com/misceres/indeed-scraper", "https://apify.com/lukaskrivka/google-maps-with-contact-details", "https://apify.com/apify/facebook-events-scraper" ] }; // Run the Actor and wait for it to finish const run = await client.actor("apify/actor-readme-generator").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 = { "readmeExamples": [ "https://apify.com/misceres/indeed-scraper", "https://apify.com/lukaskrivka/google-maps-with-contact-details", "https://apify.com/apify/facebook-events-scraper", ] } # Run the Actor and wait for it to finish run = client.actor("apify/actor-readme-generator").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 '{ "readmeExamples": [ "https://apify.com/misceres/indeed-scraper", "https://apify.com/lukaskrivka/google-maps-with-contact-details", "https://apify.com/apify/facebook-events-scraper" ] }' | apify call apify/actor-readme-generator --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=apify/actor-readme-generator", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Actor Readme Generator", "description": "An AI agent that can generate a README for scrapers based on an Apify-approved template.", "version": "0.0", "x-build-id": "I7SPJfBpnt1SQccd3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apify~actor-readme-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apify-actor-readme-generator", "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/apify~actor-readme-generator/runs": { "post": { "operationId": "runs-sync-apify-actor-readme-generator", "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/apify~actor-readme-generator/run-sync": { "post": { "operationId": "run-sync-apify-actor-readme-generator", "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": [ "actorTitle", "actorDescription", "readmeExamples" ], "properties": { "actorTitle": { "title": "Actor title", "type": "string", "description": "The title of your actor" }, "actorDescription": { "title": "Actor description", "type": "string", "description": "What does your actor do? Describe it in a couple of sentences. Give examples if appropriate." }, "targetWebsite": { "title": "Target website", "type": "string", "description": "The website your actor is targeting" }, "readmeExamples": { "title": "Example READMEs", "type": "array", "description": "Provide some quality Actor README to base yours on.", "items": { "type": "string" } }, "sampleData": { "title": "Sample data", "type": "object", "description": "A sample of your Actor's output in JSON format." } } }, "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 } } } } } } } } } } ```