ClickHelp
Search ClickHelp topics, summarize help content and apply selected topic revisions.
Search your ClickHelp portal and read topics from projects or publications. AI can answer a documentation question with topic links or revise a specific topic’s title and body from supplied instructions.
What your agent can do in ClickHelp
Actions grouped by task. Each group lists the actions it calls.
Documentation reading
Find projects and publications, search content and read topics.
- List Projects
- Get Project
- List Topics
- Get Topic
- Search Portal
Topic editing
Create topics or update selected title, body and workflow fields.
- Create Topic
- Update Topic
Tasks to hand your agent
Fill in the brackets, and connect any second app a task names.
Answer a question from portal topics
Find relevant help content and cite the topics used.
Search ClickHelp for [question] within projects [IDs, or all] and language [language]. Read the matching topics in Markdown and answer using their content. Include topic titles and links, distinguish project or publication sources, and list unanswered points.
Revise one help topic
Apply final title or body changes to an exact documentation topic.
Read ClickHelp topic [topic ID] in project [project ID]. Draft revisions for [instructions], then apply final title [title] and final HTML body [body]. Preserve other fields and report the updated topic link and recorded workflow status.
Actions7
Every action the ClickHelp connector offers, by name and id.
- List Projects
list_projectsList ClickHelp projects and publications available to the connected user. - Get Project
get_projectGet one ClickHelp project or publication by id. - List Topics
list_topicsList or search topics within one ClickHelp project or publication. - Get Topic
get_topicGet one ClickHelp topic, optionally compiling its content as HTML or Markdown. - Create Topic
create_topicCreate a topic in a ClickHelp project using HTML body content and topic metadata. - Update Topic
update_topicUpdate selected content or metadata fields on a ClickHelp topic. - Search Portal
search_portalSearch full text across ClickHelp projects and publications available to the user.
How ClickHelp signs in
- Sign-in method
- API keyConnect with a ClickHelp Contributor login, API key and HTTPS portal address.
- You need
- The contributor must have access to the target project or publication and permission for any intended edits.
- Notes
- Editing a topic does not itself publish a new documentation release.
Questions about the ClickHelp connector
Connectors used with ClickHelp
Apps that tasks with ClickHelp also call.
