xAI

透過 Mastra 的模型路由器存取 10 個 xAI 模型。系統會自動使用 XAI_API_KEY 環境變數進行驗證。

詳情請參閱xAI 文件。

.env

XAI_API_KEY=your-api-key

src/mastra/agents/my-agent.ts

import { Agent } from '@mastra/core/agent'

const agent = new Agent({
  id: 'my-agent',
  name: 'My Agent',
  instructions: 'You are a helpful assistant',
  model: 'xai/grok-4.20-0309-non-reasoning',
})

// Generate a response
const response = await agent.generate('Hello!')

// Stream a response
const stream = await agent.stream('Tell me a story')
for await (const chunk of stream) {
  console.log(chunk)
}

模型

10 available models

Model	Context	Tools	Reasoning	Image	Audio	Video	Input $/1M	Output $/1M
xai/grok-4.20-0309-non-reasoning	1.0M						$1	$3
xai/grok-4.20-0309-reasoning	1.0M						$1	$3
xai/grok-4.20-multi-agent-0309	1.0M						$1	$3
xai/grok-4.3	1.0M						$1	$3
xai/grok-4.5	500K						$2	$6
xai/grok-build-0.1	256K						$1	$2
xai/grok-imagine-image	8K						—	—
xai/grok-imagine-image-quality	8K						—	—
xai/grok-imagine-video	1K						—	—
xai/grok-imagine-video-1.5	1K						—	—

進階設定

自訂標頭

src/mastra/agents/my-agent.ts

const agent = new Agent({
  id: 'custom-agent',
  name: 'custom-agent',
  model: {
    id: 'xai/grok-4.20-0309-non-reasoning',
    apiKey: process.env.XAI_API_KEY,
    headers: {
      'X-Custom-Header': 'value',
    },
  },
})

動態選擇模型

src/mastra/agents/my-agent.ts

const agent = new Agent({
  id: 'dynamic-agent',
  name: 'Dynamic Agent',
  model: ({ requestContext }) => {
    const useAdvanced = requestContext.task === 'complex'
    return useAdvanced ? 'xai/grok-imagine-video-1.5' : 'xai/grok-4.20-0309-non-reasoning'
  },
})

Provider 選項

xAI 透過 providerOptions 參數支援以下 Provider 專屬選項：

const response = await agent.generate('Hello!', {
  providerOptions: {
    xai: {
      // See available options in the table below
    },
  },
})

可用選項

reasoningEffort?:

"none" | "low" | "medium" | "high" | undefined

logprobs?:

boolean | undefined

topLogprobs?:

number | undefined

parallel_function_calling?:

boolean | undefined

searchParameters?:

{ mode: "off" | "auto" | "on"; returnCitations?: boolean | undefined; fromDate?: string | undefined; toDate?: string | undefined; maxSearchResults?: number | undefined; sources?: ({ ...; } | ... 2 more ... | { ...; })[] | undefined; } | undefined

直接安裝 Provider

此 Provider 亦可直接安裝為獨立套件，用來取代 Mastra 模型路由器字串。詳情請參閱套件文件。

npm

npm install @ai-sdk/xai

pnpm

pnpm add @ai-sdk/xai

Yarn

yarn add @ai-sdk/xai

Bun

bun add @ai-sdk/xai

有關此 Provider 的詳細文件，請參閱 AI SDK xAI Provider 文件。