# Front Knowledge Base (`canadesk/front-knowledge-base`) Actor

Get Categories and Articles from any public Front Knowledge Base. It's fast and costs little.

- **URL**: https://apify.com/canadesk/front-knowledge-base.md
- **Developed by:** [Canadesk Support](https://apify.com/canadesk) (community)
- **Categories:** Automation, Developer tools, SEO tools
- **Stats:** 4 total users, 2 monthly users, 100.0% runs succeeded, 1 bookmarks
- **User rating**: No ratings yet

## Pricing

$5.00/month + usage

To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period. You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#rental-actors

## 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

## Features

- **Get Categories**
- **List Articles List**
- **Get All Articles**

### How it works.

1. Enter the Front KB subdomain to be analyzed.

2. Select a process to run (e.g., Get Categories).

3. Set the crawler options.

4. Run it! 🎉

### Troubleshooting

1. Currently **NO SUPPORT** for sub-categories. All articles must be listed directly under the first parent category.

2. The Maximum of requests per crawl must be higher than the total of articles in the Help Center, or set to 0 (unlimited). Otherwise you will get no results. You can find out how many articles exist by running the process "Get Articles List" first.

3. The error "Error: Resource \[URL] served Content-Type text/plain, but only text/html, text/xml, application/xhtml+xml, application/xml, application/json are allowed. Skipping resource." likely means the Help Center you entered does not exist.

### Support

Always use a proxy!

Open a new issue or contact support.

Cheers!

# Actor input Schema

## `subdomain` (type: `string`):

E.g., property-genius for https://property-genius.frontkb.com/.

## `locale` (type: `string`):

E.g., en for https://property-genius.frontkb.com/en/.

## `process` (type: `string`):

Process to run.

## `max` (type: `integer`):

Must be higher than the total of articles. Set to 0 for unlimited.

## `timeout` (type: `integer`):

Request will give up after the specified duration.

## `retries` (type: `integer`):

Request will be retried in case an error occurs.

## `proxy` (type: `object`):

Select proxies to be used by your crawler.

## Actor input object example

```json
{
  "subdomain": "front",
  "locale": "en",
  "process": "gc",
  "max": 0,
  "timeout": 30,
  "retries": 0,
  "proxy": {
    "useApifyProxy": true
  }
}
```

# 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 = {
    "subdomain": "front",
    "locale": "en",
    "proxy": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("canadesk/front-knowledge-base").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 = {
    "subdomain": "front",
    "locale": "en",
    "proxy": { "useApifyProxy": True },
}

# Run the Actor and wait for it to finish
run = client.actor("canadesk/front-knowledge-base").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 '{
  "subdomain": "front",
  "locale": "en",
  "proxy": {
    "useApifyProxy": true
  }
}' |
apify call canadesk/front-knowledge-base --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,canadesk/front-knowledge-base"
        }
    }
}

```

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/OwkvVS9gv6uaQguHx/builds/SBLEylMRHrs278MNb/openapi.json