Skip to content

feat(OpenAI Node): Support custom headers for model requests #17835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

feat(OpenAI Node): Support custom headers for model requests #17835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
7fec452
custom header to azure open ai model
mgosal Jul 30, 2025
1632c64
feat(ai): Add multiple headers to azure openai credentials
idirouhab Aug 13, 2025
ac01498
feat: Use json field
idirouhab Aug 13, 2025
d603480
feat: Use text box to define custom header on Azure OpenAI credentials
idirouhab Aug 13, 2025
3eb17ba
feat: Use text box to define custom header on OpenAI credentials
idirouhab Aug 13, 2025
51bc0e7
back to 1 header secret
mgosal Aug 20, 2025
29f7600
removed header2/3
mgosal Aug 20, 2025
4416710
revert AzureOpenAiApi.credentials.ts
mgosal Aug 20, 2025
f5795e3
revert LmChatAzureOpenAi.node.ts
mgosal Aug 20, 2025
2b21884
cleanup
mgosal Aug 20, 2025
765da14
chore: Add tests
idirouhab Sep 2, 2025
e24826d
chore: Fix OpenAIApi test
idirouhab Sep 2, 2025
24a003c
test: LmChatOpenAi node
idirouhab Sep 2, 2025
cd9bbb0
fix: Update broken test
idirouhab Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/@n8n/nodes-langchain/nodes/llms/LMChatOpenAi/LmChatOpenAi.node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,11 @@ export class LmChatOpenAi implements INodeType {
dispatcher: getProxyAgent(configuration.baseURL ?? 'https://api.openai.com/v1'),
};
}
if (credentials.header) {
configuration.defaultHeaders = {
[credentials.headerName as string]: credentials.headerValue as string,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rule violated: Prefer Typeguards over Type casting

Avoid as type assertions for narrowing; prefer type annotations/guards or non-assertive coercion. Replace the header key/value casts with safe string coercion to comply with the rule.

(Based on your team's feedback about avoiding unnecessary runtime type guards in performance‑critical paths, this fix uses simple string coercion without adding guards or overhead.)

Prompt for AI agents 
Address the following comment on packages/@n8n/nodes-langchain/nodes/llms/LMChatOpenAi/LmChatOpenAi.node.ts at line 363:

<comment>Avoid `as` type assertions for narrowing; prefer type annotations/guards or non-assertive coercion. Replace the header key/value casts with safe string coercion to comply with the rule.

(Based on your team&#39;s feedback about avoiding unnecessary runtime type guards in performance‑critical paths, this fix uses simple string coercion without adding guards or overhead.)</comment>

<file context>
@@ -358,6 +358,11 @@ export class LmChatOpenAi implements INodeType {
 		}
+		if (credentials.header) {
+			configuration.defaultHeaders = {
+				[credentials.headerName as string]: credentials.headerValue as string,
+			};
+		}
</file context>

};
}

// Extra options to send to OpenAI, that are not directly supported by LangChain
const modelKwargs: {
Expand Down
Loading
Loading