Knowledgebase TOC Builder
Pricing
from $4.90 / 1,000 page auditeds
Build a structured table of contents from knowledge base pages, crawled article inventories, headings, breadcrumbs, categories, sections, and article URLs.
You can access the Knowledgebase TOC Builder 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 API & Integrations in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "1.0", "x-build-id": "rgnC7KkbUyt3HRl3L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~knowledgebase-toc-builder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-knowledgebase-toc-builder", "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~knowledgebase-toc-builder/runs": { "post": { "operationId": "runs-sync-junipr-knowledgebase-toc-builder", "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~knowledgebase-toc-builder/run-sync": { "post": { "operationId": "run-sync-junipr-knowledgebase-toc-builder", "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": { "articleUrls": { "title": "Article URLs", "type": "array", "description": "Public article URLs to fetch or inspect for Knowledgebase TOC Builder.", "items": { "type": "string" }, "default": [ "https://docs.github.com/en/get-started/start-your-journey/about-github-and-git" ] }, "articleRows": { "title": "Article Rows", "type": "array", "description": "Supplied rows for Knowledgebase TOC Builder to process directly.", "items": { "type": "object", "additionalProperties": true }, "default": [] }, "rawHtmlInputs": { "title": "Raw HTML Inputs", "type": "object", "description": "Optional map of URL-to-HTML content to analyze without fetching live pages.", "default": {}, "additionalProperties": true }, "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Sitemap URLs to inspect for target pages and crawl candidates.", "items": { "type": "string" }, "default": [] }, "titleSelectors": { "title": "Title Selectors", "type": "array", "description": "Selectors used to locate title in supplied or fetched HTML.", "items": { "type": "string" }, "default": [ "h1" ] }, "headingSelectors": { "title": "Heading Selectors", "type": "array", "description": "Selectors used to locate heading in supplied or fetched HTML.", "items": { "type": "string" }, "default": [ "h2", "h3" ] }, "breadcrumbSelectors": { "title": "Breadcrumb Selectors", "type": "array", "description": "Selectors used to locate breadcrumb in supplied or fetched HTML.", "items": { "type": "object", "additionalProperties": true }, "default": [] }, "tocMode": { "title": "TOC Mode", "type": "string", "description": "TOC Mode controlling how Knowledgebase TOC Builder processes the supplied inputs.", "default": "breadcrumb" }, "maxDepth": { "title": "Max Depth", "type": "number", "description": "Maximum depth to process in one run; keep defaults low for safe first runs.", "default": 4 }, "inferHierarchyFromUrls": { "title": "Infer Hierarchy From URLs", "type": "boolean", "description": "Public infer hierarchy from URLs to fetch or inspect for Knowledgebase TOC Builder.", "default": true }, "includeHeadingAnchors": { "title": "Include Heading Anchors", "type": "boolean", "description": "Include heading anchors in output rows or reports when available.", "default": true }, "detectOrphans": { "title": "Detect Orphans", "type": "boolean", "description": "Detect Orphans controls Knowledgebase TOC Builder processing for the supplied inputs; keep values conservative for first runs.", "default": true }, "timeoutMs": { "title": "Timeout ms", "type": "number", "description": "Maximum time in milliseconds allowed for the Knowledgebase TOC Builder operation before it is treated as timed out.", "default": 15000 }, "maxChargeUsd": { "title": "Max Charge USD", "type": "number", "description": "Maximum estimated PPE charge allowed for the run before the actor stops gracefully.", "default": 1 } } }, "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 Knowledgebase TOC Builder 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: