As artificial intelligence continues to revolutionize how we interact with technology, integrating AI-powered tools such as OpenAI’s ChatGPT into applications has become increasingly popular. ChatGPT is an advanced language model capable of generating human-like text, answering questions, and performing tasks based on the provided input. With Node.js, developers can build scalable applications that integrate the ChatGPT API efficiently.
In this blog, we will explore how to integrate OpenAI’s ChatGPT API using Node.js, what you need to get started, and the different ways of integrating ChatGPT for various use cases. We’ll also delve into the pros and cons of each approach and provide code examples for both.
Node.js, known for its event-driven, non-blocking architecture, is a perfect fit for building scalable networked applications. By integrating OpenAI’s ChatGPT API with Node.js developers can create applications that offer intelligent conversational capabilities, including chatbots, virtual assistants, and content generation tools. This integration allows Node.js applications to communicate with OpenAI’s language models, making it possible to harness their power in real-time.
To begin, you’ll need an OpenAI API key, a Node.js environment set up, and a basic understanding of how to make API calls. Once set up, you can integrate the OpenAI API into your application to handle various tasks, from answering simple queries to generating complex responses based on context.
Before diving into the code, let’s go over what you’ll need to get started:
▪️OpenAI API Key: Sign up at OpenAI’s official website and get an API key. This key will allow you to authenticate and access the ChatGPT API.
▪️Creating an Assistant (Optional): Although it is not strictly necessary, you may want to create an assistant through OpenAI’s platform. This can help you build more customized, context-aware interactions. The assistant maintains memory and context, which is useful for personalized conversations.
▪️Database Setup: If you choose to maintain context in your application (such as storing conversation threads and assistant IDs), you’ll need a database to keep track of these details.
The Assistant API provides a more sophisticated approach by maintaining conversation threads and context automatically. This is particularly useful for complex, multi-turn conversations.
Setting Up the Controller
import * as openAiService from "../services/openAiService.js";
export const createAiChat = async (req, res) => {
try {
const { userId, message, content, role } = req?.body;
if (!userId || !message || !content || !role) {
return res
.status(400)
.json({ error: "userId, message and content are required" });
}
const threadId = openAiService.getOrcreateThread(userId);
if (!threadId) {
return res.status(400).json({ error: "Failed to create thread" });
}
const messageCreated = openAiService.createMessages(
threadId,
role,
content
);
if (!messageCreated) {
return res.status(400).json({ error: "Failed to create message" });
}
const assistantId = process.env.ASSISTANT_ID;
const openAiRes = openAiService?.runThread(threadId, assistantId);
// Set up streaming response
res.setHeader("Content-Type", "text/event-stream");
res.setHeader("Cache-Control", "no-cache");
res.setHeader("Connection", "keep-alive");
res.flushHeaders();
openAiRes.on("data", (chunk) => {
console.log("data", chunk.toString());
res.write(`data: ${chunk.toString()}\n\n`);
});
openAiRes.on("end", () => {
res.write("data: [DONE]\n\n");
res.end();
});
openAiRes.on("error", (error) => {
console.error("Error streaming response:", error);
res.end();
});
} catch (err) {
console.error("Error in createAiChat:", err);
res.status(500).json({ error: err.message });
}
};Thread Management
export const getOrcreateThread = async (userId) => {
let threadId = await getThreadForUser(userId);
if (threadId) {
return { threadId };
}
const threadObj = openAi?.beta?.threads?.create();
threadId = threadObj?.id;
if (!threadId) {
return null;
}
await saveThreadForUser(userId, threadId);
return { threadId };
};Creating Messages
export const createMessages = async (threadId, role, content) => {
const threadMessages = await openAi?.beta?.threads?.messages?.create(
threadId,
{
role,
content,
}
);
if (!threadMessages) {
return false;
}
return true;
};Running the Assistant
export const runThread = async (threadId, assistantId) => {
const run = await openAi.beta.threads.runs.create(threadId, {
assistantId,
stream: true,
temperature: 0,
});
return run;
};Additional Helper Functions
export const getHistory = async (userId) => {
try {
const threadId = await getThreadForUser(userId);
if (!threadId) {
return [];
}
const messages = await openAi.beta.threads.messages.list(threadId);
return messages.data;
} catch (error) {
console.error("Error getting history:", error);
throw error;
}
};
export const getAssistantId = async () => {
// Return or create an assistant ID
return process.env.ASSISTANT_ID || createNewAssistant();
};In this example, we:
▪️Retrieve the thread ID from the database if it exists, or create a thread, maintaining the conversation’s context.
▪️Send the conversation to OpenAI’s Assistant API using the stored context.
▪️Update the database with the new thread ID for future reference.
In contrast to the assistant-based method, the chat completion-based method does not require context management or a pre-configured assistant. It provides real-time responses based on the messages provided, which can be ideal for chatbots and applications where each interaction is independent.
Detailed Code for Chat Completion-Based Integration:
Import axios from 'axios'
const apiKey = 'your_openai_api_key';
async function getChatResponse(messages) {
try {
const response = await axios.post(
'https://api.openai.com/v1/chat/completions',
{
model: 'gpt-4',
messages: messages,
max_tokens: 150,
},
{
headers: {
'Authorization': `Bearer ${apiKey}`,
'Content-Type': 'application/json',
},
}
);
return response.data.choices[0].message.content.trim();
} catch (error) {
console.error('Error:', error);
return 'An error occurred.';
}
}
// Example usage
const messages = [
{ role: 'system', content: 'You are a helpful assistant.' },
{ role: 'user', content: 'Hello, how can I assist you today?' },
];
getChatResponse(messages)
.then(response => console.log(response));In this method, we:
▪️Provide a series of messages (from the user and the system).
▪️OpenAI responds with a completion based on the provided context.
▪️Assistant-Based Integration: This method is ideal when you need to maintain context across multiple interactions. It’s perfect for virtual assistants, chatbots, or any application where the conversation history is important.
▪️Chat Completion-Based Integration: This method is best for situations where each user interaction is independent, such as a one-time question-answer format or where no memory of past interactions is required.
▪️Maintains Context: The conversation history is saved, allowing for more intelligent and context-aware responses.
▪️Customizable Behavior: You can fine-tune the assistant’s personality, tone, and knowledge base.
▪️Persistent Memory: Ideal for ongoing interactions, where the assistant “remembers” past conversations.
▪️Simplicity: It’s quicker to implement and doesn’t require setting up an assistant or managing thread IDs.
▪️Flexibility: Best for short, single-session interactions without the need for memory.
▪️Real-Time Responses: Great for applications that require immediate answers without the overhead of context management.
Integrating OpenAI’s ChatGPT API with Node.js opens up a world of possibilities for building intelligent conversational systems. Depending on your use case, you can choose between the assistant-based or chat completion-based integration method. The assistant-based method offers a more sophisticated solution with context management, making it ideal for virtual assistants and long-running conversations. On the other hand, the chat completion-based method offers simplicity and flexibility for straightforward interactions.
By understanding the strengths of each method, you can choose the right approach for your application and create powerful, AI-driven experiences.
A Deep Dive into Modern Clinical Workflows with AI Agents & CDS Hooks
Register Now
The team at Mindbowser was highly professional, patient, and collaborative throughout our engagement. They struck the right balance between offering guidance and taking direction, which made the development process smooth. Although our project wasn’t related to healthcare, we clearly benefited...
Founder, Texas Ranch Security
Mindbowser played a crucial role in helping us bring everything together into a unified, cohesive product. Their commitment to industry-standard coding practices made an enormous difference, allowing developers to seamlessly transition in and out of the project without any confusion....
CEO, MarketsAI
I'm thrilled to be partnering with Mindbowser on our journey with TravelRite. The collaboration has been exceptional, and I’m truly grateful for the dedication and expertise the team has brought to the development process. Their commitment to our mission is...
Founder & CEO, TravelRite
The Mindbowser team's professionalism consistently impressed me. Their commitment to quality shone through in every aspect of the project. They truly went the extra mile, ensuring they understood our needs perfectly and were always willing to invest the time to...
CTO, New Day Therapeutics
I collaborated with Mindbowser for several years on a complex SaaS platform project. They took over a partially completed project and successfully transformed it into a fully functional and robust platform. Throughout the entire process, the quality of their work...
President, E.B. Carlson
Mindbowser and team are professional, talented and very responsive. They got us through a challenging situation with our IOT product successfully. They will be our go to dev team going forward.
Founder, Cascada
Amazing team to work with. Very responsive and very skilled in both front and backend engineering. Looking forward to our next project together.
Co-Founder, Emerge
The team is great to work with. Very professional, on task, and efficient.
Founder, PeriopMD
I can not express enough how pleased we are with the whole team. From the first call and meeting, they took our vision and ran with it. Communication was easy and everyone was flexible to our schedule. I’m excited to...
Founder, Seeke
We had very close go live timeline and Mindbowser team got us live a month before.
CEO, BuyNow WorldWide
If you want a team of great developers, I recommend them for the next project.
Founder, Teach Reach
Mindbowser built both iOS and Android apps for Mindworks, that have stood the test of time. 5 years later they still function quite beautifully. Their team always met their objectives and I'm very happy with the end result. Thank you!
Founder, Mindworks
Mindbowser has delivered a much better quality product than our previous tech vendors. Our product is stable and passed Well Architected Framework Review from AWS.
CEO, PurpleAnt
I am happy to share that we got USD 10k in cloud credits courtesy of our friends at Mindbowser. Thank you Pravin and Ayush, this means a lot to us.
CTO, Shortlist
Mindbowser is one of the reasons that our app is successful. These guys have been a great team.
Founder & CEO, MangoMirror
Kudos for all your hard work and diligence on the Telehealth platform project. You made it possible.
CEO, ThriveHealth
Mindbowser helped us build an awesome iOS app to bring balance to people’s lives.
CEO, SMILINGMIND
They were a very responsive team! Extremely easy to communicate and work with!
Founder & CEO, TotTech
We’ve had very little-to-no hiccups at all—it’s been a really pleasurable experience.
Co-Founder, TEAM8s
Mindbowser was very helpful with explaining the development process and started quickly on the project.
Executive Director of Product Development, Innovation Lab
The greatest benefit we got from Mindbowser is the expertise. Their team has developed apps in all different industries with all types of social proofs.
Co-Founder, Vesica
Mindbowser is professional, efficient and thorough.
Consultant, XPRIZE
Very committed, they create beautiful apps and are very benevolent. They have brilliant Ideas.
Founder, S.T.A.R.S of Wellness
Mindbowser was great; they listened to us a lot and helped us hone in on the actual idea of the app. They had put together fantastic wireframes for us.
Co-Founder, Flat Earth
Ayush was responsive and paired me with the best team member possible, to complete my complex vision and project. Could not be happier.
Founder, Child Life On Call
The team from Mindbowser stayed on task, asked the right questions, and completed the required tasks in a timely fashion! Strong work team!
CEO, SDOH2Health LLC
Mindbowser was easy to work with and hit the ground running, immediately feeling like part of our team.
CEO, Stealth Startup
Mindbowser was an excellent partner in developing my fitness app. They were patient, attentive, & understood my business needs. The end product exceeded my expectations. Thrilled to share it globally.
Owner, Phalanx
Mindbowser's expertise in tech, process & mobile development made them our choice for our app. The team was dedicated to the process & delivered high-quality features on time. They also gave valuable industry advice. Highly recommend them for app development...
Co-Founder, Fox&Fork
