xAI

Use xAI Grok models with Kern agents.

xAI is a platform for providing endpoints for Large Language models. See their list of models here.

We recommend experimenting to find the best-suited model for your use-case. The grok-3 model is good for most use-cases.

Authentication

Set your XAI_API_KEY environment variable. You can get one from xAI here.

1export XAI_API_KEY=sk-***

1setx XAI_API_KEY sk-***

Example

Use xAI with your Agent:

1from kern.agent import Agent
2from kern.models.xai import xAI
3
4agent = Agent(
5    model=xAI(id="grok-3"),
6    markdown=True
7)
8
9agent.print_response("Share a 2 sentence horror story.")

Live Search

xAI models support live search capabilities that can access real-time information:

1from kern.agent import Agent
2from kern.models.xai import xAI
3
4agent = Agent(
5    model=xAI(
6        id="grok-3",
7        search_parameters={
8            "mode": "on",
9            "max_search_results": 20,
10            "return_citations": True,
11        },
12    ),
13    markdown=True,
14)
15
16agent.print_response("What's the latest news about AI developments?")

Note View more examples here.

Params

Parameter	Type	Default	Description
`id`	`str`	`"grok-beta"`	The id of the xAI model to use
`name`	`str`	`"xAI"`	The name of the model
`provider`	`str`	`"xAI"`	The provider of the model
`api_key`	`Optional[str]`	`None`	The API key for xAI (defaults to XAI_API_KEY env var)
`base_url`	`str`	`"https://api.x.ai/v1"`	The base URL for the xAI API

xAI also supports the params of OpenAI.