# xAI Grok

> GrokLLMService streams chat completions from xAI Grok through its OpenAI-compatible API.

Source: https://polvallverdu.github.io/pipedog/docs/services/llm/grok/



{/* Generated by scripts/generate-providers.ts from data/providers.ts. */}

## Overview [#overview]

xAI's Grok models.

* **`GrokLLMService`**: an `OpenAILLMService` subclass with xAI Grok's base URL and default
  model.

<Cards>
  <Card title="Upstream page" href="https://docs.pipecat.ai/api-reference/server/services/llm/grok">
    Pipecat's documentation for the same service.
  </Card>

  <Card title="Source" href="https://github.com/polvallverdu/pipedog/tree/main/packages/xai/src">
    `packages/xai/src/llm.ts`.
  </Card>

  <Card title="xAI docs" href="https://docs.x.ai/docs/api-reference#chat-completions">
    The chat completions API reference.
  </Card>
</Cards>

## Installation [#installation]

```bash
bun add @pipedog/xai
```

It depends on `@pipedog/openai`, which is installed with it.

```ts
import { GrokLLMService } from "@pipedog/xai/llm";
```

## Prerequisites [#prerequisites]

* An xAI account and an API key from the [xAI console](https://console.x.ai/).
* Pass the key as `apiKey`. It is required, and the service never falls back to
  `OPENAI_API_KEY`. The examples read it from `XAI_API_KEY`.

## GrokLLMService [#grokllmservice]

### Configuration [#configuration]

| Option | Type | Required | Description |
|---|---|---|---|
| `apiKey` | `string` | yes | The API key for accessing Grok's API. |
| `baseUrl` | `string \| null \| undefined` | no | The base URL for Grok API. Defaults to `"https://api.x.ai/v1"`. |
| `settings` | `GrokLLMSettings \| null \| undefined` | no | Runtime-updatable settings; values override the built-in defaults. |
| `name` | `string \| null \| undefined` | no | Custom name; defaults to `ClassName#count`. |
| `taskManager` | `BaseTaskManager \| null \| undefined` | no | Task manager for handling tasks. |
| `enableDirectMode` | `boolean \| undefined` | no | Process frames immediately instead of using internal queues. |
| `metrics` | `FrameProcessorMetrics \| null \| undefined` | no | Optional metrics collector for this processor. |
| `runInParallel` | `boolean \| undefined` | no | Whether to run function calls in parallel or sequentially. Defaults to true. |
| `groupParallelTools` | `boolean \| undefined` | no | Whether to group parallel function calls so the LLM is triggered exactly once after all calls in the batch complete. When false, each function call result triggers the LLM independently as it arrives. Defaults to true. |
| `functionCallTimeoutSecs` | `number \| null \| undefined` | no | Optional timeout in seconds for function calls. A call that runs past it is cancelled: its handler is cancelled (it gets a `CancelledError`), the call is settled as cancelled, and inference runs so the LLM can report that it didn't complete. |
| `fileResolver` | `FileResolver \| null \| undefined` | no | Resolves file URLs in the context that this provider can't fetch itself (see `FileResolver`). Pass one configured with a `fileStorage` to resolve uploaded-file URLs (`new FileResolver({ fileStorage: runnerArgs.fileStorage })` when a runner hosts the bot), and share one instance across services that may consume the same files (e.g. services switched between mid-session) so downloads are reused. Defaults to a resolver that handles `data:` and `http(s)` URLs only. |
| `organization` | `string \| null \| undefined` | no | OpenAI organization ID. |
| `project` | `string \| null \| undefined` | no | OpenAI project ID. |
| `defaultHeaders` | `Record<string, string> \| null \| undefined` | no | Additional HTTP headers. |
| `serviceTier` | `string \| null \| undefined` | no | Service tier to use (e.g., "auto", "flex", "priority"). |
| `retryTimeoutSecs` | `number \| null \| undefined` | no | How long an inference may go without producing output before it is abandoned and re-issued, when `retryOnTimeout` is set. Defaults to 5.0 seconds. |
| `retryOnTimeout` | `boolean \| null \| undefined` | no | Whether to re-issue the request once if the first attempt produces no output within `retryTimeoutSecs`. The retry is unbounded. |

The other options (`organization`, `project`, `defaultHeaders`, `serviceTier`,
`retryOnTimeout`, `retryTimeoutSecs`, function calling) are `OpenAILLMService`'s. See
[OpenAI](https://polvallverdu.github.io/pipedog/docs/services/llm/openai/#configuration).

|               |                                                                                 |
| ------------- | ------------------------------------------------------------------------------- |
| Base URL      | `https://api.x.ai/v1`                                                           |
| Default model | `grok-4.20-non-reasoning`                                                       |
| Models to try | `grok-4.20-non-reasoning`, `grok-4.6`. See the provider's catalog for the rest. |

### Settings [#settings]

Runtime-updatable settings, passed as `settings: new GrokLLMService.Settings({...})`
(`GrokLLMSettings`). They are [OpenAI's settings](https://polvallverdu.github.io/pipedog/docs/services/llm/openai/#settings), with these
defaults:

| Setting           | Type                                                       | Default                     | Description                                                                                                                      |
| ----------------- | ---------------------------------------------------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `model`           | `string`                                                   | `"grok-4.20-non-reasoning"` | Model name.                                                                                                                      |
| `reasoningEffort` | `"none" \| "low" \| "medium" \| "high" \| "xhigh" \| null` | `null`                      | Sent as `reasoning_effort` when set, unless `extra` already has one. The non-reasoning models, including the default, reject it. |

Every other setting keeps OpenAI's default. Unset sampling settings are left out of the request, so
the provider's own defaults apply. `extra` carries provider-specific request fields.

### Usage [#usage]

```ts title="llm.ts"
import { LLMUpdateSettingsFrame } from "@pipedog/core/frames/frames";
import { GrokLLMService } from "@pipedog/xai/llm";

const llm = new GrokLLMService({
  apiKey: process.env.XAI_API_KEY ?? "",
  settings: new GrokLLMService.Settings({
    model: "grok-4.20-non-reasoning",
    systemInstruction: "You are a helpful assistant in a voice conversation.",
    temperature: 0.7,
  }),
});
```

A reasoning model, with its reasoning effort:

```ts
const reasoning = new GrokLLMService({
  apiKey: process.env.XAI_API_KEY ?? "",
  settings: new GrokLLMService.Settings({ model: "grok-4.6", reasoningEffort: "low" }),
});
```

Change settings mid-call with an `LLMUpdateSettingsFrame`. The next completion uses them:

```ts
// Queue it on the worker, or push it from a processor upstream of the service.
const update = new LLMUpdateSettingsFrame({
  delta: new GrokLLMService.Settings({ temperature: 0.2, maxTokens: 300 }),
});
```

### Notes [#notes]

* Runs a completion for each `LLMContextFrame`, between an `LLMFullResponseStartFrame` and an
  `LLMFullResponseEndFrame`, and streams the reply as `LLMTextFrame`s, as
  [`OpenAILLMService`](https://polvallverdu.github.io/pipedog/docs/services/llm/openai.md) does. Function calls, token usage metrics and
  `runInference` work the same way.
* "developer" messages are sent as is: the API supports that role.
* xAI reports reasoning tokens apart from `completion_tokens`, so they are added to the completion count in token usage metrics when the total says so.
* `@pipedog/grok` re-exports `GrokLLMService` from `@pipedog/xai/llm`, as upstream's deprecated `pipecat.services.grok.llm` does. Import from `@pipedog/xai/llm`.
* The same package has xAI's [speech-to-text](https://polvallverdu.github.io/pipedog/docs/services/stt/xai.md) and [text-to-speech](https://polvallverdu.github.io/pipedog/docs/services/tts/xai.md) services, and [Grok Voice Agent](https://polvallverdu.github.io/pipedog/docs/services/s2s/grok.md), the realtime (speech-to-speech) service.

## Runtime notes [#runtime-notes]

| Runtime            | Works | What it needs |
| ------------------ | ----- | ------------- |
| Bun                | ✅ yes | Nothing.      |
| Node.js            | ✅ yes | Nothing.      |
| Deno               | ✅ yes | Nothing.      |
| Cloudflare Workers | ✅ yes | Nothing.      |

Generated from `pipecat.runtimes` and `pipecat.compat` in `packages/xai/package.json`: ✅ means the compat smoke test passes on that runtime.

* The client is the official `openai` JS SDK (through `@pipedog/openai`), which talks through
  `fetch`. It works on Bun, Node, Deno and Cloudflare Workers.
* The deprecated `model` constructor option is not ported. Use `settings`.
* Tested against a local OpenAI-compatible mock server, not against xAI Grok itself.