# Actor README Generator Agent (`jkuzz/actor-readme-generator-agent`) Actor

Generates a README for an Apify Actor using an AI Agent. You only need to provide the actor id to generate a readable and SEO optimized README for the Actor. The generation process utilizes Apify's Official README Guide. This Agent is open source (link in readme).

- **URL**: https://apify.com/jkuzz/actor-readme-generator-agent.md
- **Developed by:** [Jan Kuželík](https://apify.com/jkuzz) (community)
- **Categories:** AI, Open source, Agents
- **Stats:** 21 total users, 0 monthly users, 100.0% runs succeeded, 5 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per event

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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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

[![Actor README Generator Agent](https://apify.com/actor-badge?actor=jkuzz/actor-readme-generator-agent)](https://apify.com/jkuzz/actor-readme-generator-agent)

## Actor README Generator Agent

This is an open source Apify Actor agent. You can find the source code at https://github.com/Jkuzz/actor-readme-generator

### Introduction and Features

The Actor README Generator is designed to automate the generation of structured README files for Apify Actors. It simplifies the process of creating well-organized and SEO-optimized documentation for your actor, ensuring that all critical information is included.

#### Key Functionalities:

- Generates README files based on Actor input schema.
- Provides pricing information based on usage scenarios.
- Supports various input models, including OpenAI's gpt-4o and gpt-4o-mini.
- Enables debugging for easier troubleshooting.

#### Pricing Model:

The pricing model for the AI Actor README Generator is based on a pay-per-event system. Here are the key pricing details:

| Event Title                                 | Description                                                 | Price (USD) |
| ------------------------------------------- | ----------------------------------------------------------- | ----------- |
| Actor start per 1 GB                        | Flat fee for starting an Actor run for each 1 GB of memory. | $0.005      |
| Price per 100 OpenAI tokens for gpt-4o      | Flat fee for each 100 gpt-4o tokens used.                   | $0.001      |
| Price per 100 OpenAI tokens for gpt-4o-mini | Flat fee for each 100 gpt-4o-mini tokens used.              | $0.00006    |

### How to Use Actor README Generator

#### Step-by-step Guide:

1. Input the Actor ID and select your desired OpenAI model (gpt-4o or gpt-4o-mini).
2. Optionally enable debug mode for detailed output during execution.
3. Run the Actor to generate a structured README file.

#### Example of Input

```json
{
    "actorId": "JOHAgNsmklA9ZBl7Y",
    "modelName": "gpt-4o-mini",
    "debug": false
}
```

#### Expected Output

The output will be a structured README in Markdown format, including details such as:

- Actor functionalities
- Pricing model
- Input and output examples
- FAQs and support information

### FAQ

#### What is the pricing for using this Actor?

This Actor follows a pay-per-event pricing model, where fees are incurred based on memory usage and OpenAI token consumption.

#### Can I use this Actor without coding experience?

Yes, the Actor is designed to be user-friendly and requires no coding knowledge to operate effectively.

#### How can I seek support if I encounter issues?

For support, you can refer to the [official documentation](https://apify.com) or reach out through the support channels provided on the Apify platform.

# Actor input Schema

## `actorId` (type: `string`):

Apify id of the actor to generate the README for. All necessary information will be fetched from the Actor automatically.

## `modelName` (type: `string`):

The OpenAI model to use. Currently supported models are gpt-4o and gpt-4o-mini.

## `debug` (type: `boolean`):

If enabled, the Actor will run in debug mode and produce more output.

## Actor input object example

```json
{
  "actorId": "JOHAgNsmklA9ZBl7Y",
  "modelName": "gpt-4o-mini",
  "debug": false
}
```

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "actorId": "JOHAgNsmklA9ZBl7Y",
    "modelName": "gpt-4o-mini"
};

// Run the Actor and wait for it to finish
const run = await client.actor("jkuzz/actor-readme-generator-agent").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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "actorId": "JOHAgNsmklA9ZBl7Y",
    "modelName": "gpt-4o-mini",
}

# Run the Actor and wait for it to finish
run = client.actor("jkuzz/actor-readme-generator-agent").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "actorId": "JOHAgNsmklA9ZBl7Y",
  "modelName": "gpt-4o-mini"
}' |
apify call jkuzz/actor-readme-generator-agent --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,jkuzz/actor-readme-generator-agent"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/JOHAgNsmklA9ZBl7Y/builds/JAuydEmjpq0qdvy5z/openapi.json