# KnowledgePort — ClickUp Docs Export (`plenteous_humidifier/knowledgeport-clickup-docs-export`) Actor

Export authorized ClickUp Docs to clean Markdown with hierarchy, rewritten links, ZIP download, warnings, and SHA-256 integrity checks.

- **URL**: https://apify.com/plenteous\_humidifier/knowledgeport-clickup-docs-export.md
- **Developed by:** [Luigy Gabriel](https://apify.com/plenteous_humidifier) (community)
- **Categories:** Automation, Developer tools, Integrations
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.40 / archive created

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

## KnowledgePort — ClickUp Docs Export

Export the ClickUp Docs you are authorized to access into a downloadable ZIP of
clean Markdown. KnowledgePort preserves page hierarchy, rewrites known internal
ClickUp links to local files, records conversion warnings, and generates a
file-by-file SHA-256 integrity manifest.

### Input

- ClickUp personal API token (`pk_...`) or OAuth access token
- optional Workspace ID
- optional Doc ID allowlist for tightly scoped runs
- archive/deleted filters and a maximum Doc limit

The token is a secret input. It is sent only to `api.clickup.com`, never logged,
never written to the dataset, and never included in the archive.

### Output

- `ARCHIVE`: downloadable ZIP with Markdown, metadata, warnings and checksums
- `MANIFEST`: integrity metadata and SHA-256 hashes
- `WARNINGS`: content that may need visual review
- default dataset: one compact run summary

### Commercial model

Use Apify pay-per-event with one `archive-created` event after a successful
archive. Suggested launch experiment: US$0.40 per successful run plus platform
usage, then measure typical API and storage cost before adjusting the event price.

### Boundaries

ClickUp permissions always apply. Rich blocks that the official Docs API cannot
represent exactly may require review. KnowledgePort is an export and retention
tool, not a ClickUp restore engine.

# Actor input Schema

## `apiToken` (type: `string`):

Use a personal pk\_ token for your own Workspace or an OAuth access token for an authorized connection.

## `workspaceId` (type: `string`):

Optional numeric Workspace ID. Defaults to the first Workspace authorized by the token.

## `docIds` (type: `array`):

Optional safety scope. When provided, only these Docs are fetched.

## `maxDocs` (type: `integer`):

Stop after this many Docs to bound runtime and storage use.

## `includeArchived` (type: `boolean`):

Include Docs marked archived when exporting the full Workspace.

## `includeDeleted` (type: `boolean`):

Include deleted Docs still visible through the API.

## Actor input object example

```json
{
  "docIds": [],
  "maxDocs": 10000,
  "includeArchived": false,
  "includeDeleted": false
}
```

# Actor output Schema

## `summary` (type: `string`):

No description

## `archive` (type: `string`):

No description

## `manifest` (type: `string`):

No description

## `warnings` (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("plenteous_humidifier/knowledgeport-clickup-docs-export").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("plenteous_humidifier/knowledgeport-clickup-docs-export").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 plenteous_humidifier/knowledgeport-clickup-docs-export --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=plenteous_humidifier/knowledgeport-clickup-docs-export",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/acts/cxxVM3C0g8Ab03lt4/builds/JgkgOXPehIrbOdh29/openapi.json