OpenAI Chat Model node#
Use the OpenAI Chat Model node to use OpenAI's chat models with conversational agents.
On this page, you'll find the node parameters for the OpenAI Chat Model node and links to more resources.
Credentials
You can find authentication information for this node here.
Parameter resolution in sub-nodes
Sub-nodes behave differently to other nodes when processing multiple items using an expression.
Most nodes, including root nodes, take any number of items as input, process these items, and output the results. You can use expressions to refer to input items, and the node resolves the expression for each item in turn. For example, given an input of five name values, the expression {{ $json.name }} resolves to each name in turn.
In sub-nodes, the expression always resolves to the first item. For example, given an input of five name values, the expression {{ $json.name }} always resolves to the first name.
Node parameters#
Model#
Select the model to use to generate the completion.
n8n dynamically loads models from OpenAI, and you'll only see the models available to your account.
Built-in Tools#
The OpenAI Responses API provides a range of built-in tools to enrich the model's response:
- Web Search: Allows models to search the web for the latest information before generating a response.
- MCP Servers: Allows models to connect to remote MCP servers. Find out more about using remote MCP servers as tools here.
- File Search: Allow models to search your knowledgebase from previously uploaded files for relevant information before generating a response. Refer to the OpenAI documentation for more information.
- Code Interpreter: Allows models to write and run Python code in a sandboxed environment.
Node options#
Use these options to further refine the node's behavior.
Base URL#
Enter a URL here to override the default URL for the API.
Frequency Penalty#
Use this option to control the chances of the model repeating itself. Higher values reduce the chance of the model repeating itself.
Maximum Number of Tokens#
Enter the maximum number of tokens used, which sets the completion length.
Response Format#
Choose Text or JSON. JSON ensures the model returns valid JSON.
Presence Penalty#
Use this option to control the chances of the model talking about new topics. Higher values increase the chance of the model talking about new topics.
Sampling Temperature#
Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations.
Timeout#
Enter the maximum request time in milliseconds.
Max Retries#
Enter the maximum number of times to retry a request.
Top P#
Use this option to set the probability the completion should use. Use a lower value to ignore less probable options.
Conversation ID#
The conversation that this response belongs to. Input items and output items from this response are automatically added to this conversation after this response completes.
Prompt Cache Key#
Use this key for caching similar requests to optimize cache hit rates.
Safety Identifier#
Apply an identifier to track users who may violate usage policies.
Service Tier#
Select the service tier that fits your needs: Auto, Flex, Default, or Priority.
Metadata#
A set of key-value pairs for storing structured information. You can attach up to 16 pairs to an object, which is useful for adding custom data that can be used for searching by the API or in the dashboard.
Top Logprobs#
Define an integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.
Output Format#
Choose a response format: Text, JSON Schema, or JSON Object. Use of JSON Schema is recommended, if you want to receive data in JSON format.
Prompt#
Configure the prompt filled with a unique ID, its version, and substitutable variables.
Reasoning Effort#
Control the reasoning level of AI results: Low, Medium, or High.
Templates and examples#
Related resources#
Refer to LangChains's OpenAI documentation for more information about the service.
Refer to OpenAI documentation for more information about the parameters.
View n8n's Advanced AI documentation.
Common issues#
For common questions or issues and suggested solutions, refer to Common issues.