# 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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# 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(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).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": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,jacksu/public-help-center-answerability-agent"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/mUdQEZKoSFMo8P0c4/builds/MMeHnLmlJ458JWvBf/openapi.json