快速开始
构建提供商插件
本指南介绍如何构建一个提供商插件,为 OpenClaw 添加模型提供商 (LLM)。完成后,你将拥有一个带有模型目录、API key 认证和动态模型解析的提供商。
演练
包和清单
第 1 步:包和清单
{"name": "@myorg/openclaw-acme-ai","version": "1.0.0","type": "module","openclaw": { "extensions": ["./index.ts"], "providers": ["acme-ai"], "compat": { "pluginApi": ">=2026.3.24-beta.2", "minGatewayVersion": "2026.3.24-beta.2" }, "build": { "openclawVersion": "2026.3.24-beta.2", "pluginSdkVersion": "2026.3.24-beta.2" }}}{"id": "acme-ai","name": "Acme AI","description": "Acme AI model provider","providers": ["acme-ai"],"modelSupport": { "modelPrefixes": ["acme-"]},"providerAuthEnvVars": { "acme-ai": ["ACME_AI_API_KEY"]},"providerAuthAliases": { "acme-ai-coding": "acme-ai"},"providerAuthChoices": [ { "provider": "acme-ai", "method": "api-key", "choiceId": "acme-ai-api-key", "choiceLabel": "Acme AI API key", "groupId": "acme-ai", "groupLabel": "Acme AI", "cliFlag": "--acme-ai-api-key", "cliOption": "--acme-ai-api-key <key>", "cliDescription": "Acme AI API key" }],"configSchema": { "type": "object", "additionalProperties": false}}该清单声明了 providerAuthEnvVars,因此 OpenClaw 可以在不加载你的插件运行时的情况下
检测凭证。当某个提供商变体应复用另一个提供商 ID 的认证时,请添加 providerAuthAliases。
modelSupport 是可选的,它让 OpenClaw 能够在运行时钩子存在之前,
根据 acme-large 这样的简写模型 ID 自动加载你的提供商插件。如果你在
ClawHub 上发布该提供商,则 package.json 中必须包含这些 openclaw.compat 和
openclaw.build 字段。
注册提供商
一个最小文本提供商需要 id、label、auth 和 catalog。
catalog 是由提供商拥有的运行时/配置钩子;它可以调用实时
供应商 API,并返回 models.providers 条目。
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth"; export default definePluginEntry({ id: "acme-ai", name: "Acme AI", description: "Acme AI model provider", register(api) { api.registerProvider({ id: "acme-ai", label: "Acme AI", docsPath: "/providers/acme-ai", envVars: ["ACME_AI_API_KEY"], auth: [ createProviderApiKeyAuthMethod({ providerId: "acme-ai", methodId: "api-key", label: "Acme AI API key", hint: "API key from your Acme AI dashboard", optionKey: "acmeAiApiKey", flagName: "--acme-ai-api-key", envVar: "ACME_AI_API_KEY", promptMessage: "Enter your Acme AI API key", defaultModel: "acme-ai/acme-large", }), ], catalog: { order: "simple", run: async (ctx) => { const apiKey = ctx.resolveProviderApiKey("acme-ai").apiKey; if (!apiKey) return null; return { provider: { baseUrl: "https://api.acme-ai.com/v1", apiKey, api: "openai-completions", models: [ { id: "acme-large", name: "Acme Large", reasoning: true, input: ["text", "image"], cost: { input: 3, output: 15, cacheRead: 0.3, cacheWrite: 3.75 }, contextWindow: 200000, maxTokens: 32768, }, { id: "acme-small", name: "Acme Small", reasoning: false, input: ["text"], cost: { input: 1, output: 5, cacheRead: 0.1, cacheWrite: 1.25 }, contextWindow: 128000, maxTokens: 8192, }, ], }, }; }, }, }); api.registerModelCatalogProvider({ provider: "acme-ai", kinds: ["text"], liveCatalog: async (ctx) => { const apiKey = ctx.resolveProviderApiKey("acme-ai").apiKey; if (!apiKey) return null; return [ { kind: "text", provider: "acme-ai", model: "acme-large", label: "Acme Large", source: "live", }, ]; }, }); },});registerModelCatalogProvider 是用于列表/帮助/选择器 UI 的较新控制平面目录接口。
请将它用于文本、图像生成、视频生成和音乐生成行。把供应商端点调用和
响应映射保留在插件中;OpenClaw 负责共享的行形状、来源标签和帮助渲染。
这就是一个可工作的提供商。用户现在可以运行
openclaw onboard --acme-ai-api-key <key>,并选择
acme-ai/acme-large 作为他们的模型。
如果上游提供商使用的控制标记与 OpenClaw 不同,请添加一个 小型双向文本转换,而不是替换流路径:
api.registerTextTransforms({ input: [ { from: /red basket/g, to: "blue basket" }, { from: /paper ticket/g, to: "digital ticket" }, { from: /left shelf/g, to: "right shelf" }, ], output: [ { from: /blue basket/g, to: "red basket" }, { from: /digital ticket/g, to: "paper ticket" }, { from: /right shelf/g, to: "left shelf" }, ],});input 会在传输前重写最终系统提示词和文本消息内容。
output 会在 OpenClaw 解析自己的控制标记或进行渠道投递前,
重写助手文本增量和最终文本。
对于只注册一个带 API-key 认证且由单一目录支持运行时的内置提供商,
优先使用更窄的 defineSingleProviderPluginEntry(...) 辅助函数:
import { defineSingleProviderPluginEntry } from "openclaw/plugin-sdk/provider-entry"; export default defineSingleProviderPluginEntry({ id: "acme-ai", name: "Acme AI", description: "Acme AI model provider", provider: { label: "Acme AI", docsPath: "/providers/acme-ai", auth: [ { methodId: "api-key", label: "Acme AI API key", hint: "API key from your Acme AI dashboard", optionKey: "acmeAiApiKey", flagName: "--acme-ai-api-key", envVar: "ACME_AI_API_KEY", promptMessage: "Enter your Acme AI API key", defaultModel: "acme-ai/acme-large", }, ], catalog: { buildProvider: () => ({ api: "openai-completions", baseUrl: "https://api.acme-ai.com/v1", models: [{ id: "acme-large", name: "Acme Large" }], }), buildStaticProvider: () => ({ api: "openai-completions", baseUrl: "https://api.acme-ai.com/v1", models: [{ id: "acme-large", name: "Acme Large" }], }), }, },});buildProvider 是当 OpenClaw 能够解析真实提供商认证时使用的实时目录路径。
它可以执行提供商特定的发现。仅将 buildStaticProvider 用于在配置认证之前
可以安全显示的离线行;它不得要求凭证或发起网络请求。
OpenClaw 的 models list --all 显示目前只对内置提供商插件执行静态目录,
并使用空配置、空环境,以及无智能体/工作区路径。
如果你的认证流程还需要在新手引导期间修补 models.providers.*、别名和
智能体默认模型,请使用 openclaw/plugin-sdk/provider-onboard 中的预设辅助函数。
最窄的辅助函数是 createDefaultModelPresetAppliers(...)、
createDefaultModelsPresetAppliers(...) 和
createModelCatalogPresetAppliers(...)。
当提供商的原生端点在常规 openai-completions 传输上支持流式用量块时,
请优先使用 openclaw/plugin-sdk/provider-catalog-shared 中的共享目录辅助函数,
而不是硬编码提供商 ID 检查。supportsNativeStreamingUsageCompat(...) 和
applyProviderNativeStreamingUsageCompat(...) 会根据端点能力映射检测支持情况,
因此原生 Moonshot/DashScope 风格端点即使使用自定义提供商 ID 的插件,
仍然可以选择启用。
添加动态模型解析
如果你的提供商接受任意模型 ID(例如代理或路由器),
请添加 resolveDynamicModel:
api.registerProvider({ // ... id, label, auth, catalog from above resolveDynamicModel: (ctx) => ({ id: ctx.modelId, name: ctx.modelId, provider: "acme-ai", api: "openai-completions", baseUrl: "https://api.acme-ai.com/v1", reasoning: false, input: ["text"], cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 }, contextWindow: 128000, maxTokens: 8192, }),});如果解析需要网络调用,请使用 prepareDynamicModel 进行异步预热 -
它完成后会再次运行 resolveDynamicModel。
添加运行时钩子(按需)
大多数提供商只需要 catalog + resolveDynamicModel。请随着提供商需求
逐步添加钩子。
共享辅助构建器现在覆盖了最常见的重放/工具兼容系列, 因此插件通常不需要逐个手动连接每个钩子:
import { buildProviderReplayFamilyHooks } from "openclaw/plugin-sdk/provider-model-shared";import { buildProviderStreamFamilyHooks } from "openclaw/plugin-sdk/provider-stream";import { buildProviderToolCompatFamilyHooks } from "openclaw/plugin-sdk/provider-tools"; const GOOGLE_FAMILY_HOOKS = { ...buildProviderReplayFamilyHooks({ family: "google-gemini" }), ...buildProviderStreamFamilyHooks("google-thinking"), ...buildProviderToolCompatFamilyHooks("gemini"),}; api.registerProvider({ id: "acme-gemini-compatible", // ... ...GOOGLE_FAMILY_HOOKS,});当前可用的重放系列:
| 系列 | 接入内容 | 内置示例 |
|---|---|---|
openai-compatible |
面向 OpenAI 兼容传输协议的共享 OpenAI 风格重放策略,包括工具调用 ID 清理、assistant 优先顺序修复,以及在传输协议需要时进行通用 Gemini 轮次验证 | moonshot, ollama, xai, zai |
anthropic-by-model |
根据 modelId 选择的 Claude 感知重放策略,因此只有当解析出的模型确实是 Claude ID 时,Anthropic 消息传输协议才会获得 Claude 专属 thinking-block 清理 |
amazon-bedrock, anthropic-vertex |
google-gemini |
原生 Gemini 重放策略,加上引导重放清理和带标签的推理输出模式 | google, google-gemini-cli |
passthrough-gemini |
通过 OpenAI 兼容代理传输协议运行的 Gemini 模型的 Gemini thought-signature 清理;不会启用原生 Gemini 重放验证或引导重写 | openrouter, kilocode, opencode, opencode-go |
hybrid-anthropic-openai |
适用于在一个插件中混合 Anthropic 消息和 OpenAI 兼容模型表面的提供商的混合策略;可选的仅限 Claude 的 thinking-block 丢弃仍限定在 Anthropic 侧 | minimax |
当前可用的流系列:
| 系列 | 接入内容 | 内置示例 |
|---|---|---|
google-thinking |
共享流路径上的 Gemini thinking 载荷规范化 | google, google-gemini-cli |
kilocode-thinking |
共享代理流路径上的 Kilo 推理包装器,kilo/auto 和不受支持的代理推理 ID 会跳过注入式 thinking |
kilocode |
moonshot-thinking |
根据配置 + /think 级别映射 Moonshot 二进制原生 thinking 载荷 |
moonshot |
minimax-fast-mode |
共享流路径上的 MiniMax fast-mode 模型重写 | minimax, minimax-portal |
openai-responses-defaults |
共享的原生 OpenAI/Codex Responses 包装器:归因标头、/fast/serviceTier、文本详细程度、原生 Codex Web 搜索、推理兼容载荷整形,以及 Responses 上下文管理 |
openai, openai-codex |
openrouter-thinking |
面向代理路由的 OpenRouter 推理包装器,集中处理不受支持模型/auto 跳过 |
openrouter |
tool-stream-default-on |
面向 Z.AI 等提供商的默认开启 tool_stream 包装器,除非显式禁用,否则启用工具流式传输 |
zai |
为系列构建器提供支持的 SDK 接缝
每个系列构建器都由同一包导出的更低层级公共辅助函数组成。当提供商需要偏离通用模式时,你可以使用这些辅助函数:
openclaw/plugin-sdk/provider-model-shared-ProviderReplayFamily、buildProviderReplayFamilyHooks(...),以及原始重放构建器(buildOpenAICompatibleReplayPolicy、buildAnthropicReplayPolicyForModel、buildGoogleGeminiReplayPolicy、buildHybridAnthropicOrOpenAIReplayPolicy)。还导出 Gemini 重放辅助函数(sanitizeGoogleGeminiReplayHistory、resolveTaggedReasoningOutputMode)和端点/模型辅助函数(resolveProviderEndpoint、normalizeProviderId、normalizeGooglePreviewModelId)。openclaw/plugin-sdk/provider-stream-ProviderStreamFamily、buildProviderStreamFamilyHooks(...)、composeProviderStreamWrappers(...),以及共享 OpenAI/Codex 包装器(createOpenAIAttributionHeadersWrapper、createOpenAIFastModeWrapper、createOpenAIServiceTierWrapper、createOpenAIResponsesContextManagementWrapper、createCodexNativeWebSearchWrapper)、DeepSeek V4 OpenAI 兼容包装器(createDeepSeekV4OpenAICompatibleThinkingWrapper)、Anthropic Messages thinking 预填清理(createAnthropicThinkingPrefillPayloadWrapper),以及共享代理/提供商包装器(createOpenRouterWrapper、createToolStreamWrapper、createMinimaxFastModeWrapper)。openclaw/plugin-sdk/provider-tools-ProviderToolCompatFamily、buildProviderToolCompatFamilyHooks("gemini"),以及底层 Gemini schema 辅助函数(normalizeGeminiToolSchemas、inspectGeminiToolSchemas)。
有些流辅助函数会有意保持在提供商本地。@openclaw/anthropic-provider 将 wrapAnthropicProviderStream、resolveAnthropicBetas、resolveAnthropicFastMode、resolveAnthropicServiceTier,以及更低层级的 Anthropic 包装器构建器保留在自己的公共 api.ts / contract-api.ts 接缝中,因为它们编码了 Claude OAuth beta 处理和 context1m 门控。xAI 插件同样将原生 xAI Responses 整形保留在自己的 wrapStreamFn 中(/fast 别名、默认 tool_stream、不受支持的 strict-tool 清理、xAI 专属推理载荷移除)。
同样的包根模式也支持 @openclaw/openai-provider(提供商构建器、默认模型辅助函数、实时提供商构建器)和 @openclaw/openrouter-provider(提供商构建器以及新手引导/配置辅助函数)。
令牌交换
对于需要在每次推理调用前进行令牌交换的提供商:
prepareRuntimeAuth: async (ctx) => { const exchanged = await exchangeToken(ctx.apiKey); return { apiKey: exchanged.token, baseUrl: exchanged.baseUrl, expiresAt: exchanged.expiresAt, };},自定义标头
对于需要自定义请求标头或正文修改的提供商:
// wrapStreamFn returns a StreamFn derived from ctx.streamFnwrapStreamFn: (ctx) => { if (!ctx.streamFn) return undefined; const inner = ctx.streamFn; return async (params) => { params.headers = { ...params.headers, "X-Acme-Version": "2", }; return inner(params); };},原生传输身份
对于需要在通用 HTTP 或 WebSocket 传输协议上使用原生请求/会话标头或元数据的提供商:
resolveTransportTurnState: (ctx) => ({ headers: { "x-request-id": ctx.turnId, }, metadata: { session_id: ctx.sessionId ?? "", turn_id: ctx.turnId, },}),resolveWebSocketSessionPolicy: (ctx) => ({ headers: { "x-session-id": ctx.sessionId ?? "", }, degradeCooldownMs: 60_000,}),用量和计费
对于公开用量/计费数据的提供商:
resolveUsageAuth: async (ctx) => { const auth = await ctx.resolveOAuthToken(); return auth ? { token: auth.token } : null;},fetchUsageSnapshot: async (ctx) => { return await fetchAcmeUsage(ctx.token, ctx.timeoutMs);},所有可用的提供商钩子
OpenClaw 按以下顺序调用钩子。大多数提供商只使用 2-3 个:
OpenClaw 不再调用的仅兼容提供商字段,例如
ProviderPlugin.capabilities 和 suppressBuiltInModel,未在此列出。
| # | 钩子 | 使用时机 |
|---|---|---|
| 1 | catalog |
模型目录或基础 URL 默认值 |
| 2 | applyConfigDefaults |
配置物化期间由提供商拥有的全局默认值 |
| 3 | normalizeModelId |
查找前清理旧版/预览模型 ID 别名 |
| 4 | normalizeTransport |
通用模型组装前清理提供商系列 api / baseUrl |
| 5 | normalizeConfig |
规范化 models.providers.<id> 配置 |
| 6 | applyNativeStreamingUsageCompat |
面向配置提供商的原生流式用量兼容重写 |
| 7 | resolveConfigApiKey |
提供商拥有的环境标记凭证解析 |
| 8 | resolveSyntheticAuth |
本地/自托管或配置支持的合成凭证 |
| 9 | shouldDeferSyntheticProfileAuth |
将合成的已存储配置文件占位符降低到环境/配置凭证之后 |
| 10 | resolveDynamicModel |
接受任意上游模型 ID |
| 11 | prepareDynamicModel |
解析前异步获取元数据 |
| 12 | normalizeResolvedModel |
运行器前的传输协议重写 |
| 13 | contributeResolvedModelCompat |
位于另一种兼容传输协议背后的供应商模型的兼容标志 |
| 14 | normalizeToolSchemas |
注册前由提供商拥有的工具 schema 清理 |
| 15 | inspectToolSchemas |
提供商拥有的工具 schema 诊断 |
| 16 | resolveReasoningOutputMode |
带标签与原生推理输出契约 |
| 17 | prepareExtraParams |
默认请求参数 |
| 18 | createStreamFn |
完全自定义的 StreamFn 传输协议 |
| 19 | wrapStreamFn |
正常流路径上的自定义标头/正文包装器 |
| 20 | resolveTransportTurnState |
原生逐轮标头/元数据 |
| 21 | resolveWebSocketSessionPolicy |
原生 WS 会话标头/冷却时间 |
| 22 | formatApiKey |
自定义运行时令牌形态 |
| 23 | refreshOAuth |
自定义 OAuth 刷新 |
| 24 | buildAuthDoctorHint |
凭证修复指引 |
| 25 | matchesContextOverflowError |
提供商拥有的溢出检测 |
| 26 | classifyFailoverReason |
提供商拥有的速率限制/过载分类 |
| 27 | isCacheTtlEligible |
提示缓存 TTL 门控 |
| 28 | buildMissingAuthMessage |
自定义缺失凭证提示 |
| 29 | augmentModelCatalog |
合成的前向兼容行 |
| 30 | resolveThinkingProfile |
模型专属 /think 选项集 |
| 31 | isBinaryThinking |
二进制 thinking 开/关兼容性 |
| 32 | supportsXHighThinking |
xhigh 推理支持兼容性 |
| 33 | resolveDefaultThinkingLevel |
默认 /think 策略兼容性 |
| 34 | isModernModelRef |
实时/冒烟模型匹配 |
| 35 | prepareRuntimeAuth |
推理前的令牌交换 |
| 36 | resolveUsageAuth |
自定义用量凭证解析 |
| 37 | fetchUsageSnapshot |
自定义用量端点 |
| 38 | createEmbeddingProvider |
提供商拥有的记忆/搜索嵌入适配器 |
| 39 | buildReplayPolicy |
自定义转录重放/压缩策略 |
| 40 | sanitizeReplayHistory |
通用清理后的提供商特定重放重写 |
| 41 | validateReplayTurns |
嵌入式运行器前的严格重放轮次验证 |
| 42 | onModelSelected |
选择后的回调(例如 telemetry) |
运行时回退说明:
normalizeConfig首先检查匹配的提供商,然后检查其他具备钩子能力的提供商插件,直到某个插件实际更改配置。如果没有提供商钩子重写受支持的 Google 系列配置条目,仍会应用内置的 Google 配置规范化器。resolveConfigApiKey在公开时使用提供商钩子。内置amazon-bedrock路径在这里也有内置的 AWS 环境标记解析器,尽管 Bedrock 运行时凭证本身仍使用 AWS SDK 默认链。resolveSystemPromptContribution允许提供商为一个模型系列注入缓存感知的系统提示指引。当行为属于某个提供商/模型系列并且应保留稳定/动态缓存拆分时,优先使用它而不是before_prompt_build。
有关详细描述和真实示例,请参阅 内部机制:提供商运行时钩子。
添加额外能力(可选)
步骤 5:添加额外能力
提供商插件可以在文本推理之外,同时注册语音、实时转录、实时 语音、媒体理解、图像生成、视频生成、Web 获取 和 Web 搜索。OpenClaw 将其归类为 混合能力插件 - 这是公司插件的推荐模式 (每个厂商一个插件)。请参阅 内部机制:能力所有权。
在 register(api) 内与你现有的
api.registerProvider(...) 调用一起注册每项能力。只选择你需要的标签页:
Speech (TTS)
import { assertOkOrThrowProviderError, postJsonRequest,} from "openclaw/plugin-sdk/provider-http"; api.registerSpeechProvider({ id: "acme-ai", label: "Acme Speech", isConfigured: ({ config }) => Boolean(config.messages?.tts), synthesize: async (req) => { const { response, release } = await postJsonRequest({ url: "https://api.example.com/v1/speech", headers: new Headers({ "Content-Type": "application/json" }), body: { text: req.text }, timeoutMs: req.timeoutMs, fetchFn: fetch, auditContext: "acme speech", }); try { await assertOkOrThrowProviderError(response, "Acme Speech API error"); return { audioBuffer: Buffer.from(await response.arrayBuffer()), outputFormat: "mp3", fileExtension: ".mp3", voiceCompatible: false, }; } finally { await release(); } },});对提供商 HTTP 失败使用 assertOkOrThrowProviderError(...),这样
插件可以共享受限的错误正文读取、JSON 错误解析和
请求 ID 后缀。
Realtime transcription
优先使用 createRealtimeTranscriptionWebSocketSession(...) - 这个共享
辅助工具会处理代理捕获、重连退避、关闭刷新、ready
握手、音频排队和关闭事件诊断。你的插件
只需映射上游事件。
api.registerRealtimeTranscriptionProvider({ id: "acme-ai", label: "Acme Realtime Transcription", isConfigured: () => true, createSession: (req) => { const apiKey = String(req.providerConfig.apiKey ?? ""); return createRealtimeTranscriptionWebSocketSession({ providerId: "acme-ai", callbacks: req, url: "wss://api.example.com/v1/realtime-transcription", headers: { Authorization: `Bearer ${apiKey}` }, onMessage: (event, transport) => { if (event.type === "session.created") { transport.sendJson({ type: "session.update" }); transport.markReady(); return; } if (event.type === "transcript.final") { req.onTranscript?.(event.text); } }, sendAudio: (audio, transport) => { transport.sendJson({ type: "audio.append", audio: audio.toString("base64"), }); }, onClose: (transport) => { transport.sendJson({ type: "audio.end" }); }, }); },});通过 POST 提交 multipart 音频的批量 STT 提供商应使用
openclaw/plugin-sdk/provider-http 中的
buildAudioTranscriptionFormData(...)。该辅助工具会规范化上传
文件名,包括需要 M4A 风格文件名才能兼容
转录 API 的 AAC 上传。
Realtime voice
api.registerRealtimeVoiceProvider({ id: "acme-ai", label: "Acme Realtime Voice", capabilities: { transports: ["gateway-relay"], inputAudioFormats: [{ encoding: "pcm16", sampleRateHz: 24000, channels: 1 }], outputAudioFormats: [{ encoding: "pcm16", sampleRateHz: 24000, channels: 1 }], supportsBargeIn: true, supportsToolCalls: true, }, isConfigured: ({ providerConfig }) => Boolean(providerConfig.apiKey), createBridge: (req) => ({ // Set this only if the provider accepts multiple tool responses for // one call, for example an immediate "working" response followed by // the final result. supportsToolResultContinuation: false, connect: async () => {}, sendAudio: () => {}, setMediaTimestamp: () => {}, handleBargeIn: () => {}, submitToolResult: () => {}, acknowledgeMark: () => {}, close: () => {}, isConnected: () => true, }),});声明 capabilities,以便 talk.catalog 可以向浏览器和原生 Talk
客户端公开有效模式、传输协议、音频格式和功能标志。
当某个传输协议可以检测到真人正在打断助手播放,且提供商支持
截断或清除正在播放的音频响应时,实现 handleBargeIn。
Media understanding
api.registerMediaUnderstandingProvider({ id: "acme-ai", capabilities: ["image", "audio"], describeImage: async (req) => ({ text: "A photo of..." }), transcribeAudio: async (req) => ({ text: "Transcript..." }),});Image and video generation
视频能力使用感知模式的结构:generate、
imageToVideo 和 videoToVideo。像
maxInputImages / maxInputVideos / maxDurationSeconds 这样的扁平聚合字段
不足以清晰地声明转换模式支持或禁用的模式。
音乐生成也遵循相同模式,使用显式的 generate /
edit 块。
api.registerImageGenerationProvider({ id: "acme-ai", label: "Acme Images", generate: async (req) => ({ /* image result */ }),}); api.registerVideoGenerationProvider({ id: "acme-ai", label: "Acme Video", capabilities: { generate: { maxVideos: 1, maxDurationSeconds: 10, supportsResolution: true }, imageToVideo: { enabled: true, maxVideos: 1, maxInputImages: 1, maxInputImagesByModel: { "acme/reference-to-video": 9 }, maxDurationSeconds: 5, }, videoToVideo: { enabled: false }, }, generateVideo: async (req) => ({ videos: [] }),});Web fetch and search
api.registerWebFetchProvider({ id: "acme-ai-fetch", label: "Acme Fetch", hint: "Fetch pages through Acme's rendering backend.", envVars: ["ACME_FETCH_API_KEY"], placeholder: "acme-...", signupUrl: "https://acme.example.com/fetch", credentialPath: "plugins.entries.acme.config.webFetch.apiKey", getCredentialValue: (fetchConfig) => fetchConfig?.acme?.apiKey, setCredentialValue: (fetchConfigTarget, value) => { const acme = (fetchConfigTarget.acme ??= {}); acme.apiKey = value; }, createTool: () => ({ description: "Fetch a page through Acme Fetch.", parameters: {}, execute: async (args) => ({ content: [] }), }),}); api.registerWebSearchProvider({ id: "acme-ai-search", label: "Acme Search", search: async (req) => ({ content: [] }),});Test
步骤 6:测试
import { describe, it, expect } from "vitest";// Export your provider config object from index.ts or a dedicated fileimport { acmeProvider } from "./provider.js"; describe("acme-ai provider", () => { it("resolves dynamic models", () => { const model = acmeProvider.resolveDynamicModel!({ modelId: "acme-beta-v3", } as any); expect(model.id).toBe("acme-beta-v3"); expect(model.provider).toBe("acme-ai"); }); it("returns catalog when key is available", async () => { const result = await acmeProvider.catalog!.run({ resolveProviderApiKey: () => ({ apiKey: "test-key" }), } as any); expect(result?.provider?.models).toHaveLength(2); }); it("returns null catalog when no key", async () => { const result = await acmeProvider.catalog!.run({ resolveProviderApiKey: () => ({ apiKey: undefined }), } as any); expect(result).toBeNull(); });});发布到 ClawHub
提供商插件的发布方式与任何其他外部代码插件相同:
clawhub package publish your-org/your-plugin --dry-runclawhub package publish your-org/your-plugin不要在这里使用旧的仅技能发布别名;插件包应使用
clawhub package publish。
文件结构
<bundled-plugin-root>/acme-ai/├── package.json # openclaw.providers metadata├── openclaw.plugin.json # Manifest with provider auth metadata├── index.ts # definePluginEntry + registerProvider└── src/ ├── provider.test.ts # Tests └── usage.ts # Usage endpoint (optional)Catalog 顺序参考
catalog.order 控制你的 catalog 相对于内置
提供商的合并时机:
| 顺序 | 时机 | 使用场景 |
|---|---|---|
simple |
第一轮 | 普通 API key 提供商 |
profile |
simple 之后 | 受 auth profile 限制的提供商 |
paired |
profile 之后 | 合成多个相关条目 |
late |
最后一轮 | 覆盖现有提供商(冲突时胜出) |