canonical: https://jentic.com/apis/clickhelp.com/clickhelp

# ClickHelp Server API

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.

## For AI agents

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

## Scope

Does not handle ticketing, customer support cases, or live chat - use for documentation portal management only.

## Capabilities

- 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
- Manage glossary terms used to standardise terminology across help content
- List portal users to drive review and assignment workflows
- Sync external markdown or DITA content into ClickHelp projects on a schedule

## Use cases

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

Example prompt: 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.

Example prompt: 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.

Example prompt: 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.

Example prompt: 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

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

## Key resources

- **Projects** — Top-level documentation containers. Supports list, get, create, update, and delete.
- **Topics** — Individual articles within a project. Supports full CRUD under `/projects/{projectId}/topics.`
- **Publications** — Read-only published snapshots of project content available at /publications.
- **Search** — Full-text search across portal content via GET /search.
- **Users** — Portal user directory available at GET /users.
- **Glossary** — Project glossary terms available at GET /glossary.

## Why Jentic

- **Setup:** Wiring the ClickHelp Server API by hand means setting up Basic auth, resolving your own {portal}.clickhelp.co host, and mapping calls across projects, topics, search, and publications yourself. Through Jentic you install once, import the ClickHelp Server API from the API Directory, store the username and API key once, and your agent calls it.
- **Permission scoping:** ClickHelp puts the project id in the URL path (`/projects/{projectId}/topics`, `/projects/{projectId}/topics/{topicId}`), so a rule can pin your agent to one documentation project and its topics. You choose the operations it may call, so topic updates are not included unless you add them.
- **Credential handling:** Your ClickHelp username and API key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a topic in ClickHelp' or 'search documentation content', and Jentic returns the matching ClickHelp operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Zendesk API** — Help-center and ticketing platform with a documentation API for guide articles.
- **Freshdesk API** — Customer support platform with knowledge-base solution articles.
- **Zoho API** — Business suite that often holds the customer or product context referenced in docs.

## FAQ

### 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 with Jentic One, the self-hosted execution layer.

### 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 your Jentic One instance 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.

### Can I limit what my agent is allowed to do with the ClickHelp Server API?

Yes. Because you run Jentic One yourself, your own rules decide which ClickHelp operations and credentials the agent may use. ClickHelp puts the project id in the URL path, such as `/projects/{projectId}/topics`, so a rule can pin the agent to a single documentation project and its topics. You also choose which operations it may call, so write actions like PUT `/projects/{projectId}/topics/{topicId}` stay unavailable unless you grant them, leaving the agent read-only on GET /search and GET /publications by default.