# Public Help Center & FAQ Answerability Snapshot Agent (`jacksu/public-help-center-answerability-agent`) Actor Analyze public help centers, FAQ pages, docs pages, and support pages for self-service answerability evidence, risks, missing fields, and change status. - **URL**: https://apify.com/jacksu/public-help-center-answerability-agent.md - **Developed by:** [jack su](https://apify.com/jacksu) (community) - **Categories:** Developer tools, Business, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $5.00 / 1,000 useful help center answerability results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Public Help Center & FAQ Answerability Snapshot Agent Turn a public help center, FAQ, docs, or support page into a compact answerability snapshot for AI agents, support teams, SEO reviewers, and customer-success workflows. The Actor fetches only the supplied public page, parses visible HTML, and reports whether users or AI agents can self-serve answers from the page. ### What It Detects - FAQ or question-style headings. - Topic/category navigation hints. - Help center type such as FAQ, docs, support, knowledge base, or help center. - Search input presence. - Contact or ticket escalation paths. - Last-updated, version, modified, or visible freshness hints. - Optional focus-topic matches. - Risk labels, missing fields, diagnostics, evidence URLs, and a stable `helpCenterHash`. ### Safety Boundary - Public HTTP/HTTPS pages only. - No browser rendering, login, cookies, form submission, private APIs, or whole-site crawling. - Rejects credentials, path parameters, query strings, fragments, localhost, `.local`, private/non-global IPs, sensitive account paths, and token-like path segments. - HTML/text response size is capped at 3 MB, including gzip decompression. - Discovered links are sanitized and not fetched. ### Pricing Intent Pricing model: `PAY_PER_EVENT` - `apify-actor-start`: minimum run-start event. - `useful-help-center-answerability-result`: charged only for useful public help-center snapshots that are new or changed. Error, unsupported URL, unchanged, focus-miss, low-evidence, and low-completeness records should not charge the useful event. Do not configure `apify-default-dataset-item`. ### Example Input ```json { "urls": ["https://help.apify.com/"], "focusTopics": ["billing", "API"], "requestTimeoutSecs": 20 } ```` ### Example Output Shape ```json { "status": "ok", "normalizedUrl": "https://example.com/help", "title": "Acme Help Center", "helpCenterType": "help-center", "answerabilityScore": 0.9, "faqQuestionHints": [{"question": "How do I reset my password?"}], "topicCategoryHints": [{"text": "Billing and plans", "topic": "billing"}], "searchInputDetected": true, "contactEscalationLinks": [{"text": "Contact support", "url": "https://example.com/support/contact"}], "freshnessHints": [{"text": "Last updated June 10, 2026"}], "matchedFocusTopics": ["billing"], "changeStatus": "new", "billableEventName": "useful-help-center-answerability-result" } ``` # Actor input Schema ## `urls` (type: `array`): Public HTTP/HTTPS help center, FAQ, docs, or support page URLs. Query parameters, fragments, credentials, path params, private-network hosts, and token-like account paths are rejected. ## `focusTopics` (type: `array`): Optional product, policy, or workflow topics to match in visible help-center text. If supplied, useful-result charging requires at least one match. ## `previousSnapshots` (type: `array`): Optional previous records from this Actor. If the stable helpCenterHash is unchanged, the result is written without charging the useful event. ## `requestTimeoutSecs` (type: `integer`): Maximum time in seconds to wait for each public page response. ## Actor input object example ```json { "urls": [ "https://help.apify.com/" ], "focusTopics": [], "previousSnapshots": [], "requestTimeoutSecs": 20 } ``` # Actor output Schema ## `datasetId` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("jacksu/public-help-center-answerability-agent").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("jacksu/public-help-center-answerability-agent").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call jacksu/public-help-center-answerability-agent --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=jacksu/public-help-center-answerability-agent", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Public Help Center & FAQ Answerability Snapshot Agent", "description": "Analyze public help centers, FAQ pages, docs pages, and support pages for self-service answerability evidence, risks, missing fields, and change status.", "version": "0.1", "x-build-id": "MMeHnLmlJ458JWvBf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jacksu~public-help-center-answerability-agent/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jacksu-public-help-center-answerability-agent", "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/jacksu~public-help-center-answerability-agent/runs": { "post": { "operationId": "runs-sync-jacksu-public-help-center-answerability-agent", "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/jacksu~public-help-center-answerability-agent/run-sync": { "post": { "operationId": "run-sync-jacksu-public-help-center-answerability-agent", "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": [ "urls" ], "properties": { "urls": { "title": "Help center URLs", "minItems": 1, "maxItems": 20, "type": "array", "description": "Public HTTP/HTTPS help center, FAQ, docs, or support page URLs. Query parameters, fragments, credentials, path params, private-network hosts, and token-like account paths are rejected.", "items": { "type": "string" }, "default": [ "https://help.apify.com/" ] }, "focusTopics": { "title": "Focus topics", "maxItems": 20, "type": "array", "description": "Optional product, policy, or workflow topics to match in visible help-center text. If supplied, useful-result charging requires at least one match.", "items": { "type": "string" }, "default": [] }, "previousSnapshots": { "title": "Previous help center snapshots", "type": "array", "description": "Optional previous records from this Actor. If the stable helpCenterHash is unchanged, the result is written without charging the useful event.", "items": { "type": "object" }, "default": [] }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 60, "type": "integer", "description": "Maximum time in seconds to wait for each public page response.", "default": 20 } } }, "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 } } } } } } } } } } ```