Actor README Generator Agent avatar

Actor README Generator Agent

Try for free

This Actor is paid per event

Go to Store
Actor README Generator Agent

Actor README Generator Agent

jkuzz/actor-readme-generator-agent
Try for free

This Actor is paid per event

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).

You can access the Actor README Generator Agent programmatically from your own JavaScript applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.

1import { ApifyClient } from 'apify-client';
2
3// Initialize the ApifyClient with your Apify API token
4// Replace the '<YOUR_API_TOKEN>' with your token
5const client = new ApifyClient({
6    token: '<YOUR_API_TOKEN>',
7});
8
9// Prepare Actor input
10const input = {
11    "actorId": "JOHAgNsmklA9ZBl7Y",
12    "modelName": "gpt-4o-mini"
13};
14
15// Run the Actor and wait for it to finish
16const run = await client.actor("jkuzz/actor-readme-generator-agent").call(input);
17
18// Fetch and print Actor results from the run's dataset (if any)
19console.log('Results from dataset');
20console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
21const { items } = await client.dataset(run.defaultDatasetId).listItems();
22items.forEach((item) => {
23    console.dir(item);
24});
25
26// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

Actor README Generator Agent API in JavaScript

The Apify API client for JavaScript is the official library that allows you to use Actor README Generator Agent API in JavaScript or TypeScript, providing convenience functions and automatic retries on errors.

Install the apify-client

npm install apify-client

Other API clients include:

Developer
Maintained by Community

Actor Metrics

  • 1 monthly user

  • 3 bookmarks

  • 92% runs succeeded

  • Created in Feb 2025

  • Modified 15 hours ago