{ "openapi": "3.0.1", "info": { "title": "Apify Store README Optimizer", "description": "Fetches public Apify Store Actor READMEs and generates cleaner, review-ready optimization drafts with stronger structure, use cases, examples, troubleshooting, and API-safe snippets.", "version": "0.1", "x-build-id": "nw5hcqeoGGIWYcAza" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/trovevault~apify-store-readme-optimizer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-trovevault-apify-store-readme-optimizer", "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/trovevault~apify-store-readme-optimizer/runs": { "post": { "operationId": "runs-sync-trovevault-apify-store-readme-optimizer", "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/trovevault~apify-store-readme-optimizer/run-sync": { "post": { "operationId": "run-sync-trovevault-apify-store-readme-optimizer", "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", "required": [ "actorIds" ], "properties": { "actorIds": { "title": "Actor IDs or Store URLs", "type": "array", "description": "One or more public Apify Actor identifiers. Accepted formats: username/actor-name, username~actor-name, https://apify.com/username/actor-name, or a public Actor ID. The actor fetches the public Store Markdown and optimizes it for review.", "items": { "type": "string" } }, "maxCharacters": { "title": "Max Characters", "minimum": 3000, "maximum": 20000, "type": "integer", "description": "Maximum character budget for each optimized README. Use 9900 for Trove Vault launch-ready drafts, or a lower value when you want shorter Store copy.", "default": 9900 }, "llmProvider": { "title": "LLM Provider", "enum": [ "none", "openai", "anthropic", "openrouter" ], "type": "string", "description": "Optional second-pass LLM rewrite provider. Choose None to use the deterministic optimizer only. When a provider is selected, the actor sends the source README and deterministic draft to that provider using your API key.", "default": "none" }, "llmApiKey": { "title": "LLM API Key", "type": "string", "description": "API key for the selected LLM provider. Leave blank when LLM Provider is None. The key is used only for the provider request and is never saved to the dataset or key-value store." }, "llmModel": { "title": "LLM Model", "type": "string", "description": "Model name for the selected provider. Defaults are used when left blank: gpt-4o-mini for OpenAI, claude-3-5-haiku-latest for Anthropic, and openai/gpt-4o-mini for OpenRouter." }, "llmTemperature": { "title": "LLM Temperature", "minimum": 0, "maximum": 1, "type": "number", "description": "Creativity level for the optional LLM rewrite. Lower values keep the output closer to the source README.", "default": 0.2 }, "llmInstructions": { "title": "Extra LLM Instructions", "type": "string", "description": "Optional extra style or business instructions for the LLM rewrite. Example: Keep the tone direct, avoid hype, preserve all public output fields, and target e-commerce operators." }, "includeOriginalReadme": { "title": "Include Original README", "type": "boolean", "description": "When enabled, the original README body is included in the dataset item. It is always saved to the key-value store for review.", "default": false }, "saveMarkdownFiles": { "title": "Save Markdown Files", "type": "boolean", "description": "Save original and optimized Markdown files to the default key-value store. Recommended for review workflows.", "default": true } } }, "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 } } } } } } } } } }