> Discover all available pages from the documentation index: https://mastra.zisheng.pro/llms.txt

# ![xAI 标志](https://models.dev/logos/xai.svg)xAI

通过 Mastra 的模型路由器访问 10 个 xAI 模型。系统会自动使用 `XAI_API_KEY` 环境变量完成身份验证。

更多信息请参阅[xAI 文档](https://docs.x.ai/docs/models)。

```bash
XAI_API_KEY=your-api-key
```

```typescript
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)
}
```

## 模型

| 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      |       |           |       |       |       | —          | —           |

## 高级配置

### 自定义请求头

```typescript
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',
    },
  },
})
```

### 动态选择模型

```typescript
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 特有选项：

```typescript
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 安装为独立 package，用它代替 Mastra 模型路由字符串。详情请参阅[package 文档](https://www.npmjs.com/package/@ai-sdk/xai)。

**npm**:

```bash
npm install @ai-sdk/xai
```

**pnpm**:

```bash
pnpm add @ai-sdk/xai
```

**Yarn**:

```bash
yarn add @ai-sdk/xai
```

**Bun**:

```bash
bun add @ai-sdk/xai
```

有关此 Provider 的详细说明，请参阅 [AI SDK xAI Provider 文档](https://ai-sdk.dev/providers/ai-sdk-providers/xai)。