Files
openclaw/extensions/openai/provider-contract-api.ts
Peter Steinberger b1c2ed7d47 fix(openai): keep setup auth choices consistent (#124729)
* fix(openai): centralize setup auth metadata

* refactor(openai): overlay auth hooks in place
2026-08-16 12:31:02 -07:00

73 lines
2.3 KiB
TypeScript

// Openai API module exposes the plugin public contract.
import type { ProviderPlugin } from "openclaw/plugin-sdk/provider-model-shared";
const noopAuth = async () => ({ profiles: [] });
const OPENAI_API_KEY_LABEL = "OpenAI API Key";
const OPENAI_CHATGPT_LOGIN_LABEL = "ChatGPT Login";
const OPENAI_CHATGPT_LOGIN_HINT = "Sign in with your ChatGPT or Codex subscription";
const OPENAI_CHATGPT_DEVICE_PAIRING_LABEL = "ChatGPT Device Pairing";
const OPENAI_CHATGPT_DEVICE_PAIRING_HINT =
"Pair your ChatGPT account in browser with a device code";
const OPENAI_ACCOUNT_WIZARD_GROUP = {
groupId: "openai",
groupLabel: "OpenAI",
groupHint: "ChatGPT/Codex sign-in or API key",
} as const;
export function createOpenAIProvider(): ProviderPlugin {
return {
id: "openai",
label: "OpenAI",
hookAliases: ["azure-openai", "azure-openai-responses"],
docsPath: "/providers/models",
envVars: ["OPENAI_API_KEY"],
auth: [
{
id: "oauth",
kind: "oauth",
label: OPENAI_CHATGPT_LOGIN_LABEL,
hint: OPENAI_CHATGPT_LOGIN_HINT,
run: noopAuth,
wizard: {
choiceId: "openai",
choiceLabel: OPENAI_CHATGPT_LOGIN_LABEL,
choiceHint: OPENAI_CHATGPT_LOGIN_HINT,
assistantPriority: -40,
onboardingFeatured: true,
...OPENAI_ACCOUNT_WIZARD_GROUP,
},
},
{
id: "device-code",
kind: "device_code",
label: OPENAI_CHATGPT_DEVICE_PAIRING_LABEL,
hint: OPENAI_CHATGPT_DEVICE_PAIRING_HINT,
run: noopAuth,
wizard: {
choiceId: "openai-device-code",
choiceLabel: OPENAI_CHATGPT_DEVICE_PAIRING_LABEL,
choiceHint: OPENAI_CHATGPT_DEVICE_PAIRING_HINT,
assistantPriority: -10,
assistantVisibility: "manual-only",
...OPENAI_ACCOUNT_WIZARD_GROUP,
},
},
{
id: "api-key",
kind: "api_key",
label: OPENAI_API_KEY_LABEL,
hint: "Use your OpenAI API key directly",
run: noopAuth,
wizard: {
choiceId: "openai-api-key",
choiceLabel: OPENAI_API_KEY_LABEL,
choiceHint: "Use your OpenAI API key directly",
assistantPriority: 5,
onboardingFeatured: true,
...OPENAI_ACCOUNT_WIZARD_GROUP,
},
},
],
};
}