Actor README Generator Agent
This Actor is paid per event
Actor README Generator Agent
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 applications by using the Apify API. You can 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.
1# Set API token
2API_TOKEN=<YOUR_API_TOKEN>
3
4# Prepare Actor input
5cat > input.json << 'EOF'
6{
7 "actorId": "JOHAgNsmklA9ZBl7Y",
8 "modelName": "gpt-4o-mini"
9}
10EOF
11
12# Run the Actor using an HTTP API
13# See the full API reference at https://docs.apify.com/api/v2
14curl "https://api.apify.com/v2/acts/jkuzz~actor-readme-generator-agent/runs?token=$API_TOKEN" \
15 -X POST \
16 -d @input.json \
17 -H 'Content-Type: application/json'Actor README Generator Agent API
Below, you can find a list of relevant HTTP API endpoints for calling the Actor README Generator Agent Actor. For this, you’ll need an Apify account. Replace <YOUR_API_TOKEN> in the URLs with your Apify API token, which you can find under Integrations in Apify Console. For details, see the API reference.
Run Actor
https://api.apify.com/v2/acts/jkuzz~actor-readme-generator-agent/runs?token=<YOUR_API_TOKEN>Note: By adding the method=POST query parameter, this API endpoint can be called using a GET request and thus used in third-party webhooks. Please refer to our Run Actor API documentation.
Run Actor synchronously and get dataset items
https://api.apify.com/v2/acts/jkuzz~actor-readme-generator-agent/run-sync-get-dataset-items?token=<YOUR_API_TOKEN>Note: This endpoint supports both POST and GET request methods. However, only the POST method allows you to pass input data. For more information, please refer to our Run Actor synchronously and get dataset items API documentation.
Get Actor
https://api.apify.com/v2/acts/jkuzz~actor-readme-generator-agent?token=<YOUR_API_TOKEN>For more information, please refer to our Get Actor API documentation.
Actors can be used to scrape web pages, extract data, or automate browser tasks. Use the Actor README Generator Agent API programmatically via the Apify API.
You can choose from:
You can start Actor README Generator Agent with the Apify API by sending an HTTP POST request to the Run Actorendpoint. An Actor’s input and its content type can be passed as a payload of the POST request, and additional options can be specified using URL query parameters. The Actor README Generator Agent is identified within the API by its ID, which is the creator’s username and the name of the Actor.
When the Actor README Generator Agent run finishes you can list the data from its default dataset(storage) via the API or you can preview the data directly on Apify Console.
Jan KuželíkActor Metrics
1 monthly user
-
3 bookmarks
92% runs succeeded
Created in Feb 2025
Modified 15 hours ago
