Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
api_key | str | None | None | The API key to use for authentication, if not provided, the GROK_API_KEY environment variable will be used if available. |
openai_client | AsyncOpenAI | None | None | An existing AsyncOpenAI client to use. If provided, api_key and http_client must be None. |
http_client | httpx.AsyncClient | None | None | An existing httpx.AsyncClient to use for making HTTP requests. |
Functions
__init__
Create a new Grok provider.
Parameters:
api_key(str | None): The API key to use for authentication, if not provided, theGROK_API_KEYenvironment variable will be used if available.openai_client(AsyncOpenAI | None): An existingAsyncOpenAIclient to use. If provided,api_keyandhttp_clientmust beNone.http_client(httpx.AsyncClient | None): An existinghttpx.AsyncClientto use for making HTTP requests.
name
Get the provider name.
Returns:
str: The provider name (‘grok’)
base_url
Get the base URL for the provider API.
Returns:
str: The base URL for the provider API (‘https://api.x.ai/v1’)
client
Get the client for the provider.
Returns:
AsyncOpenAI: The Grok client
model_profile
Get the model profile for the named model, if available.
Parameters:
model_name(str): The name of the model
ModelProfile | None: The model profile for the named model, if available