Actor Readme Quality Linter
Pricing
from $9.80 / 1,000 target auditeds
Go to Apify Store
Actor Readme Quality Linter
Lint Apify actor READMEs for clarity, examples, pricing explanation, limitations, and Store conversion quality.
Actor Readme Quality Linter
Pricing
from $9.80 / 1,000 target auditeds
Lint Apify actor READMEs for clarity, examples, pricing explanation, limitations, and Store conversion quality.
You can access the Actor Readme Quality Linter programmatically from your own 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.
{ "openapi": "3.0.1", "info": { "version": "1.0", "x-build-id": "E7EJdRAqgdTDj9Znt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~actor-readme-quality-linter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-actor-readme-quality-linter", "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/junipr~actor-readme-quality-linter/runs": { "post": { "operationId": "runs-sync-junipr-actor-readme-quality-linter", "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/junipr~actor-readme-quality-linter/run-sync": { "post": { "operationId": "run-sync-junipr-actor-readme-quality-linter", "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", "properties": { "records": { "title": "Records To Check", "type": "array", "description": "Records, snapshots, or source observations to process. Defaults to two capped built-in records.", "items": { "type": "object" }, "default": [ { "sourceId": "readme-strong", "sourceUrl": "README.md", "title": "Strong actor README", "description": "README includes input configuration, output format, pricing, FAQ, troubleshooting, limitations, and safety notes.", "entityName": "sample-actor", "category": "readme", "keywords": [ "pricing", "output" ], "metadata": { "readmeMarkdown": "## What does this actor do?\\n## Input Configuration\\n## Output Format\\n### Example output\\n## Pricing\\n## FAQ\\n## Troubleshooting\\n## Limitations" } }, { "sourceId": "readme-thin", "sourceUrl": "README.md", "title": "Thin actor README", "description": "README only says run this actor. It has no pricing or output example.", "entityName": "thin-actor", "category": "readme", "keywords": [], "metadata": { "readmeMarkdown": "# Thin Actor\\nRun this actor." } } ] }, "urls": { "title": "URLs To Fetch", "type": "array", "description": "Optional URLs reserved for live fetching when Fetch URLs is true.", "items": { "type": "string" }, "default": [] }, "fetchUrls": { "title": "Fetch URLs", "type": "boolean", "description": "Fetch sourceUrl text over HTTP. Keep false when records already contain the text to analyze.", "default": false }, "watchTerms": { "title": "Watch Terms", "type": "array", "description": "Keywords or topics used to flag relevant records.", "items": { "type": "string" }, "default": [ "pricing", "input", "output", "limitations" ] }, "includeReport": { "title": "Include Report Artifacts", "type": "boolean", "description": "Write JSON and Markdown report artifacts to the key-value store.", "default": true }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum records to process in one run.", "default": 2 }, "maxTextBytes": { "title": "Max Text Bytes", "minimum": 100, "maximum": 2000000, "type": "integer", "description": "Maximum searchable text bytes per record.", "default": 500000 }, "dryRun": { "title": "Dry Run", "type": "boolean", "description": "Validate input and write a dry-run summary without PPE charges or dataset output.", "default": false }, "debug": { "title": "Debug Logs", "type": "boolean", "description": "Enable debug logging.", "default": false } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Actor Readme Quality Linter from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: