Files
openclaw/extensions/xai/openclaw.plugin.json
Peter SteinbergerandGitHub c7e7ac2728 refactor: remove expired plugin compatibility surfaces (#111451)
* docs(secrets): remove retired web credential paths

* refactor(web): remove retired provider compatibility paths

* refactor(providers): delete retired compatibility routes

* refactor(secrets): remove retired credential aliases

* refactor(plugin-sdk): delete retired compatibility surfaces

* docs(plugin-sdk): remove retired migration guidance

* chore(plugin-sdk): refresh rebased surface budgets

* chore(plugin-sdk): refresh API removal baseline

* refactor(compat): migrate retired internal callers

* chore(plugin-sdk): refresh current-main baselines

* test(config): migrate plugin-owned secret assertions

* test(gateway): narrow plugin secret refs

* fix(plugin-sdk): preserve private boundary type identity

* chore(compat): remove stale sweep references

* chore(lint): lower max-lines budget

* refactor(secrets): remove unused web helper

* build(plugin-sdk): drop removed compat entries

* chore(plugin-sdk): refresh rebased API baseline

* chore(plugin-sdk): use Linux API baseline hash

* fix(plugin-sdk): preserve private bundled build entries

* fix(plugin-sdk): package private runtime facades

* fix(plugins): preserve external credential contracts
2026-07-19 11:04:48 -07:00

307 lines
8.8 KiB
JSON

{
"id": "xai",
"activation": {
"onStartup": false
},
"enabledByDefault": true,
"providers": ["xai"],
"providerAuthAliases": {
"x-ai": "xai"
},
"providerCatalogEntry": "./provider-discovery.ts",
"modelIdNormalization": {
"providers": {
"xai": {
"aliases": {
"grok-4.3-latest": "grok-4.3",
"grok-4.5-latest": "grok-4.5",
"grok-build-latest": "grok-4.5"
}
}
}
},
"providerEndpoints": [
{
"endpointClass": "xai-native",
"hosts": ["api.x.ai"]
}
],
"providerRequest": {
"providers": {
"xai": {
"family": "xai"
}
}
},
"modelCatalog": {
"suppressions": [
{
"provider": "xai",
"model": "grok-4.20-multi-agent-0309",
"reason": "OpenClaw does not currently support xAI multi-agent models; choose another xAI model. See https://docs.openclaw.ai/providers/xai."
},
{
"provider": "xai",
"model": "grok-4.20-multi-agent",
"reason": "OpenClaw does not currently support xAI multi-agent models; choose another xAI model. See https://docs.openclaw.ai/providers/xai."
},
{
"provider": "xai",
"model": "grok-4.20-multi-agent-latest",
"reason": "OpenClaw does not currently support xAI multi-agent models; choose another xAI model. See https://docs.openclaw.ai/providers/xai."
},
{
"provider": "xai",
"model": "grok-4.20-multi-agent-beta-latest",
"reason": "OpenClaw does not currently support xAI multi-agent models; choose another xAI model. See https://docs.openclaw.ai/providers/xai."
},
{
"provider": "xai",
"model": "grok-4.20-multi-agent-experimental-beta-0304",
"reason": "OpenClaw does not currently support xAI multi-agent models; choose another xAI model. See https://docs.openclaw.ai/providers/xai."
},
{
"provider": "xai",
"model": "grok-4.20-multi-agent-experimental-beta-latest",
"reason": "OpenClaw does not currently support xAI multi-agent models; choose another xAI model. See https://docs.openclaw.ai/providers/xai."
},
{
"provider": "xai",
"model": "grok-4.20-multi-agent-beta-0309",
"reason": "OpenClaw does not currently support xAI multi-agent models; choose another xAI model. See https://docs.openclaw.ai/providers/xai."
}
]
},
"syntheticAuthRefs": ["xai"],
"setup": {
"providers": [
{
"id": "xai",
"envVars": ["XAI_API_KEY"]
}
]
},
"providerAuthChoices": [
{
"provider": "xai",
"method": "api-key",
"choiceId": "xai-api-key",
"appGuidedSecret": true,
"choiceLabel": "xAI API key",
"groupId": "xai",
"groupLabel": "xAI (Grok)",
"groupHint": "API key or OAuth",
"onboardingFeatured": true,
"optionKey": "xaiApiKey",
"cliFlag": "--xai-api-key",
"cliOption": "--xai-api-key <key>",
"cliDescription": "xAI API key"
},
{
"provider": "xai",
"method": "oauth",
"choiceId": "xai-oauth",
"appGuidedAuth": "device-code",
"choiceLabel": "xAI OAuth",
"choiceHint": "Remote-friendly browser sign-in without a localhost callback",
"groupId": "xai",
"groupLabel": "xAI (Grok)",
"groupHint": "API key or OAuth",
"onboardingFeatured": true
},
{
"provider": "xai",
"method": "device-code",
"choiceId": "xai-device-code",
"appGuidedAuth": "device-code",
"choiceLabel": "xAI device code",
"choiceHint": "Compatibility alias for xAI OAuth device-code sign-in",
"assistantVisibility": "manual-only",
"groupId": "xai",
"groupLabel": "xAI (Grok)",
"groupHint": "API key or OAuth"
}
],
"uiHints": {
"webSearch.apiKey": {
"label": "Grok Search API Key",
"help": "Optional xAI API key for Grok web search; xAI OAuth or XAI_API_KEY can satisfy it.",
"sensitive": true
},
"webSearch.model": {
"label": "Grok Search Model",
"help": "Grok model override for web search."
},
"webSearch.baseUrl": {
"label": "Grok Search Base URL",
"help": "Optional xAI Responses API base URL for Grok web_search and x_search fallbacks."
},
"webSearch.inlineCitations": {
"label": "Inline Citations",
"help": "Include inline markdown citations in Grok responses."
},
"codeExecution.enabled": {
"label": "Enable Code Execution",
"help": "Expose code_execution on active xAI models; true opts in when the active provider is known non-xAI, false disables, and missing provider fails closed. Requires xAI auth; xAI bills $5/1,000 calls plus model tokens."
},
"xSearch.enabled": {
"label": "Enable X Search",
"help": "Expose x_search on active xAI models; true opts in when the active provider is known non-xAI, false disables, and missing provider fails closed. Requires xAI auth; xAI bills $5/1,000 calls plus model tokens."
},
"xSearch.model": {
"label": "X Search Model",
"help": "xAI model override for x_search."
},
"xSearch.baseUrl": {
"label": "X Search Base URL",
"help": "Optional xAI Responses API base URL for x_search requests."
},
"xSearch.inlineCitations": {
"label": "X Search Inline Citations",
"help": "Keep inline markdown citations from xAI in x_search responses when available."
},
"xSearch.maxTurns": {
"label": "X Search Max Turns",
"help": "Optional max internal tool turns xAI may use per x_search request."
},
"xSearch.timeoutSeconds": {
"label": "X Search Timeout",
"help": "Timeout in seconds for x_search requests."
},
"xSearch.cacheTtlMinutes": {
"label": "X Search Cache TTL",
"help": "Cache TTL in minutes for x_search results."
},
"codeExecution.model": {
"label": "Code Execution Model",
"help": "xAI model override for code_execution."
},
"codeExecution.maxTurns": {
"label": "Code Execution Max Turns",
"help": "Optional max internal tool turns xAI may use for code_execution."
},
"codeExecution.timeoutSeconds": {
"label": "Code Execution Timeout",
"help": "Timeout in seconds for code_execution requests."
}
},
"contracts": {
"webSearchProviders": ["grok"],
"videoGenerationProviders": ["xai"],
"mediaUnderstandingProviders": ["xai"],
"speechProviders": ["xai"],
"realtimeTranscriptionProviders": ["xai"],
"realtimeVoiceProviders": ["xai"],
"imageGenerationProviders": ["xai"],
"tools": ["code_execution", "x_search"]
},
"mediaUnderstandingProviderMetadata": {
"xai": {
"capabilities": ["audio"],
"autoPriority": {
"audio": 25
}
}
},
"toolMetadata": {
"code_execution": {
"authSignals": [
{
"provider": "xai"
}
],
"configSignals": [
{
"rootPath": "plugins.entries.xai.config",
"overlayPath": "webSearch",
"required": ["apiKey"]
}
]
},
"x_search": {
"replaySafe": true,
"authSignals": [
{
"provider": "xai"
}
],
"configSignals": [
{
"rootPath": "plugins.entries.xai.config",
"overlayPath": "webSearch",
"required": ["apiKey"]
}
]
}
},
"configSchema": {
"type": "object",
"additionalProperties": false,
"properties": {
"webSearch": {
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": ["string", "object"]
},
"model": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"inlineCitations": {
"type": "boolean"
}
}
},
"xSearch": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"model": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"inlineCitations": {
"type": "boolean"
},
"maxTurns": {
"type": "number"
},
"timeoutSeconds": {
"type": "number"
},
"cacheTtlMinutes": {
"type": "number"
}
}
},
"codeExecution": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"model": {
"type": "string"
},
"maxTurns": {
"type": "number"
},
"timeoutSeconds": {
"type": "number"
}
}
}
}
}
}