ClickHelp Server API

Name: ClickHelp Server API
Brand: ClickHelp Server API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentProductivityCollaborationbasic16 EndpointsREST

For Agents

Read and write technical documentation in ClickHelp portals: list projects, create or update topics, fetch publications, and search content across a knowledge base.

Install Jentic One Beta

Connect the ClickHelp Server API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ClickHelp Server API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with ClickHelp Server API.

Create and update documentation topics inside a ClickHelp project

Publish topic snapshots and retrieve publication metadata for release tracking

Run full-text search across topics, publications, and glossary entries

GET STARTED

Start building with ClickHelp Server API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for ClickHelp Server API, keeping it validated and agent-ready. The ClickHelp Server API gives programmatic access to a cloud-based technical writing and documentation platform, exposing projects, topics, publications, glossary terms, users, and full-text search. Authentication is HTTP Basic with an API key against a tenant-specific portal subdomain. It is suited to documentation teams that need to automate authoring workflows, sync content from external systems, or build agents that read and update help-center content.

Use Cases

Patterns agents use ClickHelp Server API for, with concrete tasks.

★ Automated Documentation Sync from Source

Documentation teams that author in markdown, AsciiDoc, or DITA in a Git repository can push content into ClickHelp on every merge by calling the topics endpoints. The agent walks the project tree, reconciles topics against /projects/{projectId}/topics, and creates or updates each one to keep the published portal in lockstep with the source repo. Typical end-to-end sync for a 200-topic project completes in minutes rather than the hours of manual import.

List all topics under projectId 'product-docs', diff against the local /docs folder, and PUT updated topic bodies for any file whose hash has changed since the last sync.

Help-Center Search Bot

Customer-support and internal-tools teams can build a chatbot that answers product questions by querying the ClickHelp /search endpoint and returning the top topic matches with snippets and links. Because search runs against the live portal, answers stay current without re-indexing. The same flow can power a Slack slash command or an in-app help widget.

Call GET /search with q='reset password' and return the top three topic titles and URLs as a Slack message.

Release Publication Tracking

Release managers can monitor which documentation versions are live by polling /publications and /publications/{publicationId}. The agent records which topics are included in each publication, generates a changelog from the diff between two publications, and posts the result to the release ticket. This removes the manual step of cross-checking the portal before sign-off.

List the last two publications, fetch their topic lists, and generate a markdown diff of added, removed, and updated topics.

AI Agent Documentation Assistant via Jentic

Agent builders integrating documentation tooling can register the ClickHelp Server API through Jentic and let an agent search topics, create drafts, and update content with no manual SDK setup. Jentic isolates the Basic Auth credential server-side, so the agent works against the portal without ever holding the password. Setup time drops from an afternoon of HTTP wiring to a single search-load-execute call.

Search Jentic for 'create a topic in clickhelp', load the operation schema, and execute it with projectId 'onboarding' and a generated topic body.

Key Endpoints

16 endpoints — jentic publishes the only available openapi specification for clickhelp server api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/projects

List documentation projects

POST

/projects/{projectId}/topics

Create a new topic in a project

PUT

/projects/{projectId}/topics/{topicId}

Update a topic's content

GET

/search

Search content across the portal

GET

/publications

List published documentation versions

GET

/glossary

List glossary terms

GET

/projects

List documentation projects

POST

/projects/{projectId}/topics

Create a new topic in a project

PUT

/projects/{projectId}/topics/{topicId}

Update a topic's content

GET

/search

Search content across the portal

GET

/publications

List published documentation versions

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

ClickHelp Basic Auth credentials are stored encrypted in the Jentic vault. Agents receive a scoped execution token — the username and API key never enter the agent's prompt or memory.

Intent-based discovery

Agents search Jentic by intent (for example, 'create a topic in clickhelp' or 'search documentation content') and Jentic returns the matching ClickHelp operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct ClickHelp integration: half a day to wire Basic Auth, error handling, and topic body serialisation. Through Jentic: under 30 minutes — search, load schema, execute.

FAQs

Specific to using ClickHelp Server API through Jentic.

Why is there no official OpenAPI spec for ClickHelp Server API?

ClickHelp does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call ClickHelp Server API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the ClickHelp Server API use?

The API uses HTTP Basic Auth, with a ClickHelp username and an API key passed as the password. When called through Jentic, the credential is held in the Jentic vault and never enters the agent's context — the agent receives a scoped execution token instead of the raw key.

Can I create and update topics with the ClickHelp Server API?

Yes. POST /projects/{projectId}/topics creates a new topic and PUT /projects/{projectId}/topics/{topicId} updates an existing one. Both accept the topic body and metadata, so an agent can keep portal content synced from an external source.

How do I search documentation content with the ClickHelp Server API?

Call GET /search with a q query parameter. The endpoint returns matching topics, publications, and glossary entries from across the portal. Through Jentic, search for 'search clickhelp content' to load the operation schema and execute it.

What are the rate limits for the ClickHelp Server API?

ClickHelp does not publish hard rate limits in the spec. Limits are enforced per portal and depend on the subscription tier. Build clients to handle 429 responses with exponential backoff and contact ClickHelp support for tier-specific quotas.

How do I publish a topic update through Jentic?

Run pip install jentic, then search for 'update a clickhelp topic', load the PUT /projects/{projectId}/topics/{topicId} schema, and execute with the project id, topic id, and updated body. Jentic handles the Basic Auth header construction and returns the parsed response.