OpenAI SDK
The OpenAI Node.js SDK is the official SDK for working with LLMs provided by OpenAI as well as other OpenAI compatible models from other providers in Node.js.
Prerequisites
In order to use the AI Gateway with any OpenAI SDK powered app you will need to complete these steps first:
-
Create a new provider in the AI Gateway for OpenAI
-
Create a new app to use specifically with the OpenAI SDK and assign it to the team you created
-
Copy the API URL and API Key shown at the top of the app page
Configure the OpenAI SDK
To route all OpenAI SDK requests through Zuplo instead of directly to the OpenAI
API, you must set the API baseUrl in the SDK configuration.
The app page in the Zuplo Portal shows each app's API URL. It ends in the app's
ID, so append /v1 to it to get the base URL for your API client.
Additionally, change the value of apiKey to the API key of the app you have
configured in Zuplo
Always name the model as providerName/model, where providerName is the
provider name configured in your gateway. The gateway needs the prefix to know
which provider to route to, and a request with no model, or a model without that
prefix, gets a 400. Adding the
Model Filtering
policy restricts an app to certain models, and an allow list also supplies a
default so requests may omit the model.
Code
When configured in this way, the SDK will switch from using the default OpenAI APIs to using Zuplo's AI Gateway for all requests.
Supported Endpoints
The AI Gateway supports all major OpenAI API endpoints through the universal API:
- Chat Completions (
/v1/chat/completions) - For conversational AI interactions - Embeddings (
/v1/embeddings) - For generating vector embeddings - Responses (
/v1/responses) - For OpenAI models that support the responses endpoint (such as GPT-5 and other compatible models)
Using the Responses Endpoint
For models that support the /v1/responses endpoint, you can use the OpenAI
SDK's responses API:
Code
The responses endpoint is automatically routed through the AI Gateway, providing the same monitoring, cost controls, and security features as other endpoints.