Skip to main content
xAI is a platform for providing endpoints for Large Language models.

​
Authentication

Set your XAI_API_KEY environment variable. You can get one from xAI here. 
export XAI_API_KEY=sk-***

​
Example

Use xAI with your Agent: 

from phi.agent import Agent, RunResponse
from phi.model.xai import xAI

agent = Agent(
    model=xAI(id="grok-beta"),
    markdown=True
)

# Get the response in a variable
# run: RunResponse = agent.run("Share a 2 sentence horror story.")
# print(run.content)

# Print the response in the terminal
agent.print_response("Share a 2 sentence horror story.")

​
Params

For more information, please refer to the xAI docs as well.

​
Params

ParameterTypeDefaultDescription
idstr"grok-beta"The specific model ID used for generating responses.
namestr"xAI"The name identifier for the xAI agent.
providerstr"xAI"The provider of the model, combining "xAI" with the model ID.
api_keyOptional[str]-The API key for authenticating requests to the xAI service. Retrieved from the environment variable XAI_API_KEY.
base_urlstr"https://api.xai.xyz/v1"The base URL for making API requests to the xAI service.
xAI also supports the params of OpenAI.