ChatGPT Integration with ServiceNow - Latest API Guide:
Overview:
Recently, I was exploring the integration of ChatGPT with ServiceNow and wanted to test out the ChatGPT integration on my Personal Developer Instance (PDI). While the articles and videos I came across contained older API information, I wanted to create a new knowledge article using the latest ChatGPT API to ensure it's beneficial for anyone looking to implement or learn about this integration.
In this article, I will walk through the process of setting up the integration, including the latest API endpoint, HTTP methods, and common troubleshooting steps.
Steps to Integrate ChatGPT with ServiceNow:
- Obtain the Latest ChatGPT API Information: To start, refer to the official documentation for the latest ChatGPT API endpoint and usage details:
- ChatGPT API Reference:
https://platform.openai.com/docs/api-reference/chat - Create a REST Message in ServiceNow:
- Navigate to REST Message under the Application Navigator in ServiceNow.
- Click on New and give the message a name of your choice.
- Set the Endpoint URL to:
- Save the record.
- Configure the HTTP Method:
- Under the HTTP Method related list tab, click on New and give it a name of your choice.
- Select POST as the HTTP method. The POST method sends data to the server and requests a response, typically used when creating or updating resources.
- The Endpoint remains the same as above.
- Set Authorization Header:
- Click on HTTP Request and insert a new row.
- In the Name field, enter Authorization.
- In the Value field, input the following (replacing XXXXXX with your actual API token):
- Bearer XXXXXX
- To get the token, create an account on the ChatGPT API platform, and follow the instructions to generate your API key.
Requirements for Creating a ChatGPT API Key:
- You must have an OpenAI developer platform account.
- Your account should have a credit balance of >$10 (Tier 1 Usage). If the credit balance is insufficient, your key will not work, and you'll need to create a new one.
For more details on creating the API key, refer to this guide:
- Create ChatGPT API Key:
https://documentation.n-able.com/N-central/userguide/Content/Configuration/ScriptSoftwareRepository/... - Set Content-Type and Body:
- Set the Content-Type to application/json.
- Update the body to reflect the latest API changes. Here’s the new body format (note the changes from the previous version):
- {
- "model": "${model}",
- "temperature": ${temp},
- "max_tokens": ${max_token},
- "messages": [
- {
- "role": "user",
- "content": "${text}"
- }
- ]
- }
- Save the record.
- Auto-Generate Variables:
- Click on Auto-generate variables.
- Set the following test values:
- max_token: 1024
- model: gpt-4-1106-preview (this part has changed from the previous version)
- temp: 0.5
- text: Enter any text of your choice, for example:
Who is your favorite person? - Click on Test.
- Test the Integration:
- If you receive an HTTP Status 200 response, the integration is successful.
- If you get a different status code, please troubleshoot the issue.
Common HTTP Status Codes and Their Meanings:
Here are some common HTTP status codes you may encounter and what they mean:
- HTTP Status 200 (OK): The request was successful, and the response contains the requested data.
- Fix: No action needed; the integration is working as expected.
- HTTP Status 400 (Bad Request): The server could not understand the request due to invalid syntax.
- Fix: Double-check the API request body and ensure all required fields are correctly populated.
- HTTP Status 401 (Unauthorized): Authentication failed or the API key is incorrect or expired.
- Fix: Verify the API key is correct and that it's been set properly in the Authorization header.
- HTTP Status 404 (Not Found): The requested resource could not be found on the server.
- Fix: Ensure the endpoint URL is correct and that the API you're calling exists.
- HTTP Status 500 (Internal Server Error): There was a server error while processing the request.
- Fix: Check if the API service is down, or if there’s an issue on the server side. Retry after some time.
- HTTP Status 503 (Service Unavailable): The server is temporarily unable to handle the request, usually due to overload or maintenance.
- Fix: Wait and retry the request after some time.
Conclusion:
Integrating ChatGPT with ServiceNow using the latest API provides powerful capabilities for automating workflows and improving user experiences. Following these steps, you should be able to successfully set up the integration on your PDI or instance.
I hope this article proves useful to anyone looking to implement ChatGPT in their ServiceNow environment. If you encounter any issues or need further clarification, feel free to reach out or leave a comment if I have missed out any information or needs correction.
If you believe the solution provided has adequately addressed your query, could you please **mark it as 'Helpful'** and **'Accept it as a Solution'**? This will help other community members who might have the same question find the answer more easily.
Thank you for your consideration.
Selva
