xai-auth

用途

xai-auth 是一份关于 xAI Grok API 认证与配置的指南，适用于配置 xAI API 访问、设置 API 密钥，或排查认证问题时参考。

主要能力

提供获取 API 密钥的步骤：前往 console.x.ai，使用 X（Twitter）账号登录，进入 "API Keys" 区域，点击 "Create API Key"，复制并保存以 xai- 开头的密钥。
支持三种认证方式：环境变量（推荐）、直接传入密钥、使用 xai-sdk。
说明 xAI API 与 OpenAI SDK 完全兼容，只需修改 base_url 为 https://api.x.ai/v1。
提供免费额度说明：每月 150 美元免费额度，需在 console.x.ai 的 Settings → Data Sharing 中启用数据共享选项。
列出计费参考：Grok 4.1 Fast 输入 $0.20/1M tokens、输出 $0.50/1M tokens；X Search / Web Search $5/1,000 次调用；Code Execution $5/1,000 次调用。
提供配置文件示例（.env.xai）。
提供常见错误对照表与 Python 异常处理示例。
提供安全最佳实践与速率限制参考。
列出主要端点。

使用方式

获取 API 密钥：前往 console.x.ai，使用 X（Twitter）账号登录，进入 "API Keys" 区域，点击 "Create API Key"，复制并保存以 xai- 开头的密钥。
设置环境变量：在 .bashrc、.zshrc 或 .env 中添加 export XAI_API_KEY="xai-your-key-here"。
测试连接：使用 curl 请求 https://api.x.ai/v1/models，并在请求头中携带 Authorization: Bearer $XAI_API_KEY。

认证方式示例：

方式一：环境变量（推荐）

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.getenv("XAI_API_KEY"),
    base_url="https://api.x.ai/v1"
)

方式二：直接传入密钥

from openai import OpenAI

client = OpenAI(
    api_key="xai-your-key-here",
    base_url="https://api.x.ai/v1"
)

方式三：使用 xai-sdk

from xai_sdk import Client

client = Client(api_key=os.getenv("XAI_API_KEY"))

API 兼容性示例：

from openai import OpenAI

client = OpenAI(
    api_key=os.getenv("XAI_API_KEY"),
    base_url="https://api.x.ai/v1"  # 唯一区别
)

response = client.chat.completions.create(
    model="grok-3-fast",  # 使用 Grok 模型
    messages=[{"role": "user", "content": "Hello!"}]
)

配置文件示例（.env.xai）：

# xAI API Configuration
XAI_API_KEY=xai-your-key-here
XAI_BASE_URL=https://api.x.ai/v1
XAI_DEFAULT_MODEL=grok-3-fast

错误处理示例：

from openai import OpenAI, APIError, RateLimitError

client = OpenAI(
    api_key=os.getenv("XAI_API_KEY"),
    base_url="https://api.x.ai/v1"
)

try:
    response = client.chat.completions.create(
        model="grok-3-fast",
        messages=[{"role": "user", "content": "Hello"}]
    )
except RateLimitError:
    print("Rate limit hit, waiting...")
    time.sleep(60)
except APIError as e:
    print(f"API error: {e}")

适用场景

需要接入 xAI Grok 模型进行开发的场景。
配置 xAI API 访问、设置 API 密钥。
排查认证问题、配额问题与速率限制问题。
需要了解免费额度、计费方式与端点信息的场景。

限制与注意事项

免费额度需启用数据共享选项方可获得。
速率限制因模型而异：Grok 4.1 Fast 为 60 请求/分钟、100,000 tokens/分钟；Grok 4 为 30 请求/分钟、50,000 tokens/分钟；Grok 3 Mini 为 100 请求/分钟、200,000 tokens/分钟。
常见错误包括：no credits（账户无额度，需添加额度或启用免费层）、invalid_api_key（密钥错误或过期，需在 console.x.ai 重新生成）、rate_limit_exceeded（请求过多，需实现退避、降低频率）、model_not_found（模型名称无效，需检查可用模型）。
安全最佳实践：切勿将 API 密钥提交到 git；使用环境变量而非硬编码；通过 console.x.ai 定期轮换密钥；为开发/生产环境使用不同密钥；将 .env、.env.、**/secrets. 添加到 .gitignore。
主要端点：https://api.x.ai/v1/chat/completions（聊天补全）、https://api.x.ai/v1/models（列出可用模型）、https://api.x.ai/v1/responses（Agent Tools API）。
相关技能：xai-models（模型选择指南）、xai-x-search（Twitter/X 搜索）、xai-sentiment（情感分析）。

技能介绍

用途

主要能力

使用方式

适用场景

限制与注意事项