# Knowledgebase TOC Builder (`junipr/knowledgebase-toc-builder`) Actor

Build a structured table of contents from knowledge base pages, crawled article inventories, headings, breadcrumbs, categories, sections, and article URLs.

- **URL**: https://apify.com/junipr/knowledgebase-toc-builder.md
- **Developed by:** [junipr](https://apify.com/junipr) (community)
- **Categories:** SEO tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $4.90 / 1,000 page auditeds

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

## Knowledgebase TOC Builder

### Store Positioning

**Store title:** Knowledgebase TOC Builder

**Short description:** Build a structured table of contents from knowledge base pages, crawled article inventories, headings, breadcrumbs, categories, sections, and article URLs.

**SEO title:** Knowledgebase TOC Builder — technical SEO, web, and domain audit

**SEO description:** Build a structured table of contents from knowledge base pages, crawled article inventories, headings, breadcrumbs, categories, sections, and article URLs. Use it to find crawlability, indexability, security, metadata, and page-quality issues with evidence-backed rows and audit reports.

**Categories:** SEO\_TOOLS

**Keywords:** knowledgebase, toc, builder, structured data, web/domain audit

### Pay-Per-Event Pricing

This actor uses pay-per-event pricing. Event prices include Apify platform usage; users are not expected to pay a separate platform-usage pass-through charge for the configured pricing model.

- Tier: W1 — Web/domain audit
- Primary event: `page-audited` at $0.00490 base
- Default max charge: $10.00
- Store discounts: FREE/BRONZE base, SILVER discounted, GOLD deepest approved discount

Event set:

- `actor-start`: base $0.00500, GOLD $0.00400. Knowledgebase Toc Builder: charged when actor start is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `page-audited`: base $0.00490, GOLD $0.00392. Knowledgebase Toc Builder: charged when page audited is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `record-extracted`: base $0.00372, GOLD $0.00298. Knowledgebase Toc Builder: charged when record extracted is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `finding-emitted`: base $0.00372, GOLD $0.00298. Knowledgebase Toc Builder: charged when finding emitted is completed. The price includes Apify platform usage; no separate usage pass-through is intended.
- `audit-report-generated`: base $0.05000, GOLD $0.04000. Knowledgebase Toc Builder: charged when audit report generated is completed. The price includes Apify platform usage; no separate usage pass-through is intended.

The actor accepts `actor-start` before work, accepts the primary event before each dataset row, and accepts the configured report event before writing report files. If `maxChargeUsd` or the live PPE limit blocks a charge, the corresponding row or report is not written.

### Public Task Concepts

- Build a Knowledgebase TOC stakeholder brief from source rows
- Prioritize Knowledgebase TOC findings with evidence and confidence
- Summarize Knowledgebase TOC metrics into recommended actions
- Prepare a Knowledgebase TOC source table with uncertainty notes
- Export Knowledgebase TOC decision rows for review

Build a structured table of contents from knowledge base pages, crawled article inventories, headings, breadcrumbs, categories, sections, and article URLs.

### What it does

- Accept article URLs, sitemap rows, crawler output JSON/CSV, raw HTML, or structured article lists.
- Extract headings, anchors, breadcrumbs, category hints, section hints, URL paths, and article titles.
- Build a hierarchical TOC with parent/child nodes, sort order, depth, slug/anchor references, and confidence scores.
- Detect orphan pages, duplicate titles, missing headings, shallow articles, and inconsistent hierarchy.
- Generate Markdown, JSON, and CSV TOC outputs.

### What it does not do

- No article rewriting, content generation, private portal crawling unless content is supplied, or editorial decision-making without review.
- No guarantee inferred hierarchy matches official information architecture.

### Input fields

Primary inputs from the locked actor spec: `articleUrls`, `articleRows`, `rawHtmlInputs`, `sitemapUrls`, `titleSelectors`, `headingSelectors`, `breadcrumbSelectors`, `tocMode`, `maxDepth`, `inferHierarchyFromUrls`, `includeHeadingAnchors`, `detectOrphans`, `timeoutMs`. `maxChargeUsd` keeps runs capped during production use.

### Output fields

Dataset rows include: `nodeId`, `parentNodeId`, `sourceUrl`, `nodeType`, `nodeTitle`, `nodeSlug`, `depth`, `orderIndex`, `headingText`, `headingLevel`, `anchor`, `breadcrumbPath`, `inferredCategory`, `confidence`, `warning`.

### Starter example

Use `examples/input.tiny.json` as a small starter input. Keep the first run capped and review the dataset before increasing limits.

### Public task examples

- Run Knowledgebase TOC Builder on supplied sample data: Run Knowledgebase TOC Builder on supplied sample data using a small bounded input.
- Generate a Knowledgebase TOC Builder QA report: Generate a Knowledgebase TOC Builder QA report using a small bounded input.
- Find invalid rows with Knowledgebase TOC Builder: Find invalid rows with Knowledgebase TOC Builder using a small bounded input.
- Create a capped local endpoint readiness check for Knowledgebase TOC Builder: Create a capped local endpoint readiness check for Knowledgebase TOC Builder using a small bounded input.
- Prepare Knowledgebase TOC Builder output for downstream automation: Prepare Knowledgebase TOC Builder output for downstream automation using a small bounded input.

### Public source provenance

The starter input builds a bounded table of contents from the public GitHub Docs article at `https://docs.github.com/en/get-started/start-your-journey/about-github-and-git`.

### Reports

- `knowledgebase-toc.md`
- `knowledgebase-toc.json`
- `knowledgebase-toc.csv`
- `toc-gap-report.json`
- `orphan-article-report.csv`

### Limitations and safe use

Start with supplied-input runs, then enable live endpoints only with tight caps, domain allowlists, and no secrets in public examples.

# Actor input Schema

## `articleUrls` (type: `array`):

Public article URLs to fetch or inspect for Knowledgebase TOC Builder.

## `articleRows` (type: `array`):

Supplied rows for Knowledgebase TOC Builder to process directly.

## `rawHtmlInputs` (type: `object`):

Optional map of URL-to-HTML content to analyze without fetching live pages.

## `sitemapUrls` (type: `array`):

Sitemap URLs to inspect for target pages and crawl candidates.

## `titleSelectors` (type: `array`):

Selectors used to locate title in supplied or fetched HTML.

## `headingSelectors` (type: `array`):

Selectors used to locate heading in supplied or fetched HTML.

## `breadcrumbSelectors` (type: `array`):

Selectors used to locate breadcrumb in supplied or fetched HTML.

## `tocMode` (type: `string`):

TOC Mode controlling how Knowledgebase TOC Builder processes the supplied inputs.

## `maxDepth` (type: `number`):

Maximum depth to process in one run; keep defaults low for safe first runs.

## `inferHierarchyFromUrls` (type: `boolean`):

Public infer hierarchy from URLs to fetch or inspect for Knowledgebase TOC Builder.

## `includeHeadingAnchors` (type: `boolean`):

Include heading anchors in output rows or reports when available.

## `detectOrphans` (type: `boolean`):

Detect Orphans controls Knowledgebase TOC Builder processing for the supplied inputs; keep values conservative for first runs.

## `timeoutMs` (type: `number`):

Maximum time in milliseconds allowed for the Knowledgebase TOC Builder operation before it is treated as timed out.

## `maxChargeUsd` (type: `number`):

Maximum estimated PPE charge allowed for the run before the actor stops gracefully.

## Actor input object example

```json
{
  "articleUrls": [
    "https://docs.github.com/en/get-started/start-your-journey/about-github-and-git"
  ],
  "articleRows": [],
  "rawHtmlInputs": {},
  "sitemapUrls": [],
  "titleSelectors": [
    "h1"
  ],
  "headingSelectors": [
    "h2",
    "h3"
  ],
  "breadcrumbSelectors": [],
  "tocMode": "breadcrumb",
  "maxDepth": 4,
  "inferHierarchyFromUrls": true,
  "includeHeadingAnchors": true,
  "detectOrphans": true,
  "timeoutMs": 15000,
  "maxChargeUsd": 1
}
```

# 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("junipr/knowledgebase-toc-builder").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("junipr/knowledgebase-toc-builder").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 junipr/knowledgebase-toc-builder --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,junipr/knowledgebase-toc-builder"
        }
    }
}

```

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/4xGGw9A3YWbWDWp1S/builds/rgnC7KkbUyt3HRl3L/openapi.json