xAI

Accédez à 10 modèles xAI via le routeur de modèles de Mastra. L’authentification est gérée automatiquement à l’aide de la variable d’environnement XAI_API_KEY.

Pour en savoir plus, consultez la documentation 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);
}

Modèles

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

Configuration avancée

En-têtes personnalisés

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"
    }
  }
});

Sélection dynamique du modèle

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";
  }
});

Options du Provider

xAI prend en charge les options propres au Provider suivantes via le paramètre providerOptions :

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

Options disponibles

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

Installation directe du Provider

Ce Provider peut aussi être installé directement comme package autonome, utilisable à la place de la chaîne du routeur de modèles Mastra. Consultez la documentation du package pour plus de détails.

npm

npm install @ai-sdk/xai

pnpm

pnpm add @ai-sdk/xai

Yarn

yarn add @ai-sdk/xai

Bun

bun add @ai-sdk/xai

Pour une documentation détaillée propre au Provider, consultez la documentation du Provider AI SDK xAI provider.