ClickHelp
AI-powered all-in-one documentation tool.
Integrate the ClickHelp API with the OpenAI (ChatGPT) API
Setup the ClickHelp API trigger to run a workflow which integrates with the OpenAI (ChatGPT) API. Pipedream's integration platform allows you to integrate ClickHelp and OpenAI (ChatGPT) remarkably fast. Free for developers.
Popular Ways to Connect ClickHelp with OpenAI (ChatGPT)#
Popular ClickHelp and OpenAI (ChatGPT) Triggers#
Emit new event when a topic is created. See the documentation
Emit new event when a new file is created in OpenAI. See the documentation
Emit new event when a new fine-tuning job is created in OpenAI. See the documentation
Emit new event every time a run changes its status. See the documentation
Popular ClickHelp and OpenAI (ChatGPT) Actions#
Generates a backup of the specified project. This action ensures you have a safe copy of your project in case of any unpredicted data loss. See the documentation
The Chat API, using the gpt-3.5-turbo or gpt-4 model. See docs here
Creates a new publication from the designated project. This action allows you to share your content with others in various formats. See the documentation
Produces a new topic in the existing project. A useful action for starting a new chapter or section within your project. See the documentation
Overview of ClickHelp#
The ClickHelp API allows technical writers to automate and interact with the ClickHelp documentation platform programmatically. With this API, Pipedream users can create, update, retrieve, and manage documentation projects, topics, and users within ClickHelp. It opens up opportunities to streamline documentation workflows, integrate with content management systems, and trigger notifications based on documentation changes or reviews.
Connect ClickHelp#
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
clickhelp: {
type: "app",
app: "clickhelp",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://${this.clickhelp.$auth.portal_domain}/api/v1/users`,
auth: {
username: `${this.clickhelp.$auth.email}`,
password: `${this.clickhelp.$auth.api_key}`,
},
})
},
})
Overview of OpenAI (ChatGPT)#
OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:
Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:
Connect OpenAI (ChatGPT)#
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
openai: {
type: "app",
app: "openai",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://api.openai.com/v1/models`,
headers: {
Authorization: `Bearer ${this.openai.$auth.api_key}`,
},
})
},
})