Actor README Generator Agent

An open-source Apify Actor that automatically generates structured README files for other Actors. It creates well-organized, SEO-optimized documentation based on an Actor's input schema and usage details.

Source code: https://github.com/Jkuzz/actor-readme-generator

Key Features

• Automated README Generation: Creates comprehensive README files from an Actor's input schema.
• Pricing Integration: Includes calculated pricing information based on different usage scenarios.
• Model Support: Works with OpenAI's gpt-4o and gpt-4o-mini models.
• Debug Mode: Optional debug flag for detailed output during execution.
• Structured Output: Produces Markdown files with standard sections like features, usage examples, and FAQs.

Pricing Model

This Actor uses a pay-per-event pricing model:

How to Use

1. Provide the target Actor's ID.
2. Select your preferred OpenAI model (gpt-4o or gpt-4o-mini).
3. (Optional) Set debug to true for verbose output.
4. Run the Actor. It will fetch the target Actor's schema and generate a complete README.

Input/Output

Input Schema:

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

Expected Output:
The Actor outputs a structured Markdown README file. It typically includes:
* Actor overview and functionalities
* Detailed pricing model
* Input and output examples
* Step-by-step usage guide
* FAQ and support information

FAQ

What is the pricing for using this Actor?
You pay per run based on memory allocation and OpenAI token consumption for the selected model, as shown in the pricing table.

Do I need coding experience to use this Actor?
No, it's designed to be run directly via the Apify platform with just a few input parameters.

Where can I get support?
Refer to the official Apify documentation or use the support channels on the Apify platform.