# ChatXAI

> **Class** in `@langchain/xai`

📖 [View in docs](https://reference.langchain.com/javascript/langchain-xai/ChatXAI)

xAI chat model integration.

The xAI API is compatible to the OpenAI API with some limitations.

Setup:
Install `@langchain/xai` and set an environment variable named `XAI_API_KEY`.

```bash
npm install @langchain/xai
export XAI_API_KEY="your-api-key"
```

## [Constructor args](https://api.js.langchain.com/classes/_langchain_xai.ChatXAI.html#constructor)

## [Runtime args](https://api.js.langchain.com/interfaces/_langchain_xai.ChatXAICallOptions.html)

Runtime args can be passed as the second argument to any of the base runnable methods `.invoke`. `.stream`, `.batch`, etc.
They can also be passed via `.withConfig`, or the second arg in `.bindTools`, like shown in the examples below:

```typescript
// When calling `.withConfig`, call options should be passed via the first argument
const llmWithArgsBound = llm.withConfig({
  stop: ["\n"],
  tools: [...],
});

// When calling `.bindTools`, call options should be passed via the second argument
const llmWithTools = llm.bindTools(
  [...],
  {
    tool_choice: "auto",
  }
);
```

## Examples

<details open>
<summary><strong>Instantiate</strong></summary>

```typescript
import { ChatXAI } from '@langchain/xai';

const llm = new ChatXAI({
  model: "grok-3-fast",
  temperature: 0,
  // other params...
});
```
</details>

<br />

<details>
<summary><strong>Invoking</strong></summary>

```typescript
const input = `Translate "I love programming" into French.`;

// Models also accept a list of chat messages or a formatted prompt
const result = await llm.invoke(input);
console.log(result);
```

```txt
AIMessage {
  "content": "The French translation of \"I love programming\" is \"J'aime programmer\". In this sentence, \"J'aime\" is the first person singular conjugation of the French verb \"aimer\" which means \"to love\", and \"programmer\" is the French infinitive for \"to program\". I hope this helps! Let me know if you have any other questions.",
  "additional_kwargs": {},
  "response_metadata": {
    "tokenUsage": {
      "completionTokens": 82,
      "promptTokens": 20,
      "totalTokens": 102
    },
    "finish_reason": "stop"
  },
  "tool_calls": [],
  "invalid_tool_calls": []
}
```
</details>

<br />

<details>
<summary><strong>Streaming Chunks</strong></summary>

```typescript
for await (const chunk of await llm.stream(input)) {
  console.log(chunk);
}
```

```txt
AIMessageChunk {
  "content": "",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": null
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
AIMessageChunk {
  "content": "The",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": null
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
AIMessageChunk {
  "content": " French",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": null
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
AIMessageChunk {
  "content": " translation",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": null
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
AIMessageChunk {
  "content": " of",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": null
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
AIMessageChunk {
  "content": " \"",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": null
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
AIMessageChunk {
  "content": "I",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": null
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
AIMessageChunk {
  "content": " love",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": null
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
...
AIMessageChunk {
  "content": ".",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": null
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
AIMessageChunk {
  "content": "",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": "stop"
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
```
</details>

<br />

<details>
<summary><strong>Aggregate Streamed Chunks</strong></summary>

```typescript
import { AIMessageChunk } from '@langchain/core/messages';
import { concat } from '@langchain/core/utils/stream';

const stream = await llm.stream(input);
let full: AIMessageChunk | undefined;
for await (const chunk of stream) {
  full = !full ? chunk : concat(full, chunk);
}
console.log(full);
```

```txt
AIMessageChunk {
  "content": "The French translation of \"I love programming\" is \"J'aime programmer\". In this sentence, \"J'aime\" is the first person singular conjugation of the French verb \"aimer\" which means \"to love\", and \"programmer\" is the French infinitive for \"to program\". I hope this helps! Let me know if you have any other questions.",
  "additional_kwargs": {},
  "response_metadata": {
    "finishReason": "stop"
  },
  "tool_calls": [],
  "tool_call_chunks": [],
  "invalid_tool_calls": []
}
```
</details>

<br />

<details>
<summary><strong>Bind tools</strong></summary>

```typescript
import { z } from 'zod';

const llmForToolCalling = new ChatXAI({
  model: "grok-3-fast",
  temperature: 0,
  // other params...
});

const GetWeather = {
  name: "GetWeather",
  description: "Get the current weather in a given location",
  schema: z.object({
    location: z.string().describe("The city and state, e.g. San Francisco, CA")
  }),
}

const GetPopulation = {
  name: "GetPopulation",
  description: "Get the current population in a given location",
  schema: z.object({
    location: z.string().describe("The city and state, e.g. San Francisco, CA")
  }),
}

const llmWithTools = llmForToolCalling.bindTools([GetWeather, GetPopulation]);
const aiMsg = await llmWithTools.invoke(
  "Which city is hotter today and which is bigger: LA or NY?"
);
console.log(aiMsg.tool_calls);
```

```txt
[
  {
    name: 'GetWeather',
    args: { location: 'Los Angeles, CA' },
    type: 'tool_call',
    id: 'call_cd34'
  },
  {
    name: 'GetWeather',
    args: { location: 'New York, NY' },
    type: 'tool_call',
    id: 'call_68rf'
  },
  {
    name: 'GetPopulation',
    args: { location: 'Los Angeles, CA' },
    type: 'tool_call',
    id: 'call_f81z'
  },
  {
    name: 'GetPopulation',
    args: { location: 'New York, NY' },
    type: 'tool_call',
    id: 'call_8byt'
  }
]
```
</details>

<br />

<details>
<summary><strong>Structured Output</strong></summary>

```typescript
import { z } from 'zod';

const Joke = z.object({
  setup: z.string().describe("The setup of the joke"),
  punchline: z.string().describe("The punchline to the joke"),
  rating: z.number().optional().describe("How funny the joke is, from 1 to 10")
}).describe('Joke to tell user.');

const structuredLlm = llmForToolCalling.withStructuredOutput(Joke, { name: "Joke" });
const jokeResult = await structuredLlm.invoke("Tell me a joke about cats");
console.log(jokeResult);
```

```txt
{
  setup: "Why don't cats play poker in the wild?",
  punchline: 'Because there are too many cheetahs.'
}
```
</details>

<br />

<details>
<summary><strong>Server Tool Calling (Live Search)</strong></summary>

xAI supports server-side tools that are executed by the API rather than
requiring client-side execution. The `live_search` tool enables the model
to search the web for real-time information.

```typescript
// Method 1: Using the built-in live_search tool
const llm = new ChatXAI({
  model: "grok-3-fast",
  temperature: 0,
});

const llmWithSearch = llm.bindTools([{ type: "live_search" }]);
const result = await llmWithSearch.invoke("What happened in tech news today?");
console.log(result.content);
// The model will search the web and include real-time information in its response
```

```typescript
// Method 2: Using searchParameters for more control
const llm = new ChatXAI({
  model: "grok-3-fast",
  searchParameters: {
    mode: "auto", // "auto" | "on" | "off"
    max_search_results: 5,
    from_date: "2024-01-01", // ISO date string
    return_citations: true,
  }
});

const result = await llm.invoke("What are the latest AI developments?");
```

```typescript
// Method 3: Override search parameters per request
const result = await llm.invoke("Find recent news about SpaceX", {
  searchParameters: {
    mode: "on",
    max_search_results: 10,
    sources: [
      { type: "web", allowed_websites: ["spacex.com", "nasa.gov"] },
    ],
  }
});
```
</details>

<br />

## Signature

```javascript
class ChatXAI
```

## Extends

- `ChatOpenAICompletions<ChatXAICallOptions>`

## Constructors

- [`constructor()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/constructor)

## Properties

- `__includeRawResponse`
- `apiKey`
- `audio`
- `cache`
- `callbacks`
- `caller`
- `defaultOptions`
- `disableStreaming`
- `frequencyPenalty`
- `lc_kwargs`
- `lc_namespace`
- `lc_runnable`
- `lc_serializable`
- `logitBias`
- `logprobs`
- `maxTokens`
- `metadata`
- `modalities`
- `model`
- `modelKwargs`
- `n`
- `name`
- `organization`
- `outputVersion`
- `ParsedCallOptions`
- `presencePenalty`
- `promptCacheKey`
- `promptCacheRetention`
- `reasoning`
- `searchParameters`
- `service_tier`
- `stop`
- `stopSequences`
- `streaming`
- `streamUsage`
- `supportsStrictToolCalling`
- `tags`
- `temperature`
- `timeout`
- `topLogprobs`
- `topP`
- `user`
- `verbose`
- `verbosity`
- `zdrEnabled`
- `callKeys`
- `lc_aliases`
- `lc_attributes`
- `lc_id`
- `lc_secrets`
- `lc_serializable_keys`
- `profile`
- `streamEventProvider`

## Methods

- [`_addVersion()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_addVersion)
- [`_batchWithConfig()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_batchWithConfig)
- [`_callWithConfig()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_callWithConfig)
- [`_combineCallOptions()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_combineCallOptions)
- [`_convertChatOpenAIToolToCompletionsTool()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_convertChatOpenAIToolToCompletionsTool)
- [`_convertCompletionsDeltaToBaseMessageChunk()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_convertCompletionsDeltaToBaseMessageChunk)
- [`_convertCompletionsMessageToBaseMessage()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_convertCompletionsMessageToBaseMessage)
- [`_filterInvocationParamsForTracing()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_filterInvocationParamsForTracing)
- [`_generate()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_generate)
- [`_generateCached()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_generateCached)
- [`_getEffectiveSearchParameters()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_getEffectiveSearchParameters)
- [`_getOptionsList()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_getOptionsList)
- [`_getSerializedCacheKeyParametersForCall()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_getSerializedCacheKeyParametersForCall)
- [`_hasBuiltInTools()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_hasBuiltInTools)
- [`_llmType()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_llmType)
- [`_modelType()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_modelType)
- [`_separateRunnableConfigFromCallOptions()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_separateRunnableConfigFromCallOptions)
- [`_separateRunnableConfigFromCallOptionsCompat()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_separateRunnableConfigFromCallOptionsCompat)
- [`_streamChatModelEvents()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_streamChatModelEvents)
- [`_streamIterator()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_streamIterator)
- [`_streamLog()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_streamLog)
- [`_streamResponseChunks()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_streamResponseChunks)
- [`_transformStreamWithConfig()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_transformStreamWithConfig)
- [`assign()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/assign)
- [`asTool()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/asTool)
- [`batch()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/batch)
- [`bindTools()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/bindTools)
- [`completionWithRetry()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/completionWithRetry)
- [`formatStructuredToolToXAI()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/formatStructuredToolToXAI)
- [`generate()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/generate)
- [`generatePrompt()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/generatePrompt)
- [`getGraph()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/getGraph)
- [`getLsParams()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/getLsParams)
- [`getLsParamsWithDefaults()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/getLsParamsWithDefaults)
- [`getName()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/getName)
- [`getNumTokens()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/getNumTokens)
- [`getNumTokensFromMessages()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/getNumTokensFromMessages)
- [`identifyingParams()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/identifyingParams)
- [`invoke()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/invoke)
- [`moderateContent()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/moderateContent)
- [`pick()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/pick)
- [`pipe()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/pipe)
- [`serialize()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/serialize)
- [`stream()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/stream)
- [`streamEvents()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/streamEvents)
- [`streamLog()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/streamLog)
- [`streamV2()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/streamV2)
- [`toJSON()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/toJSON)
- [`toJSONNotImplemented()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/toJSONNotImplemented)
- [`transform()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/transform)
- [`withConfig()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/withConfig)
- [`withFallbacks()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/withFallbacks)
- [`withListeners()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/withListeners)
- [`withRetry()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/withRetry)
- [`withStructuredOutput()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/withStructuredOutput)
- [`_convertInputToPromptValue()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/_convertInputToPromptValue)
- [`deserialize()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/deserialize)
- [`isRunnable()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/isRunnable)
- [`lc_name()`](https://reference.langchain.com/javascript/langchain-xai/ChatXAI/lc_name)

---

[View source on GitHub](https://github.com/langchain-ai/langchainjs/blob/f51f338cf4dd3ba188b048b3bfa8134e9b9a64cf/libs/providers/langchain-xai/src/chat_models/completions.ts#L603)