xai

Documentation

Overview

Package xai wraps xAI's (Grok) OpenAI-compatible API.

NewChat returns xAI's provider-local Chat, backed by the shared OpenAI Chat Completions protocol.

Current Grok models support text, image input, structured outputs, reasoning effort, and custom function calling through the Chat Completions surface. xAI's server-side Web Search, X Search, code execution, and collections tools belong to its Responses API surface and are not represented as Core custom functions by this adapter.

See https://docs.x.ai/ for the full API reference.

Index

• Constants
• type Chat
  • func NewChat(config ChatConfig) (*Chat, error)
• type ChatConfig
  • func (c ChatConfig) Validate() error

Constants

const (
	OpenAIRequestExtensionKey     = "xai/openai_request"
	OpenAIResponseExtensionKey    = "xai/openai_response"
	OpenAIStreamChunkExtensionKey = "xai/openai_stream_chunk"
)

const (
	Provider = "xAI"

	BaseURL = "https://api.x.ai/v1"
)

const (
	ModelGrok45      = "grok-4.5"
	ModelGrok43      = "grok-4.3"
	ModelGrokBuild01 = "grok-build-0.1"
	ModelGrok4       = "grok-4"
)

See https://docs.x.ai/developers/models for the current catalog.

Types

type Chat

type Chat = openai.ChatCompletions

Chat implements xAI's chat endpoint.

func NewChat

func NewChat(config ChatConfig) (*Chat, error)

type ChatConfig

type ChatConfig struct {
	APIKey         string
	DefaultOptions corechat.Options
	BaseURL        string
	HTTPClient     *http.Client
}

func (ChatConfig) Validate

func (c ChatConfig) Validate() error