mcpField
X
xai-grok

xai-grok

github.com/alphaonedev开发46 次安装
代码仓库

关于 xai-grok

xai-grok 面向开发者,帮助通过兼容 OpenAI 的 API 接入 xAI Grok。它涵盖 api.x.ai/v1 上的聊天补全、嵌入、流式响应和模型选择。

主要功能

  1. 01聊天补全与流式响应
  2. 02访问嵌入端点
  3. 03使用 grok-3 和 grok-3-mini
  4. 04设置 JSON 请求参数
  5. 05通过 Bearer API 密钥认证

适用场景

  1. 01用 Grok 构建聊天机器人
  2. 02生成代码或文本
  3. 03执行推理任务
  4. 04用模型响应分析数据

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/alphaonedev/openclaw-graph --skill xai-grok

安装后在 Claude Code 中输入/xai-grok确认已加载。

详细介绍

xai-grok

用途

此技能可与 xAI Grok API 交互。该 API 是一项兼容 OpenAI 的服务,适用于快速 AI 推理任务。开发者可通过 api.x.ai/v1 使用 grok-3 和 grok-3-mini 等模型,将先进的 AI 能力集成到文本生成、推理等场景中。

适用场景

当应用需要自然语言处理,例如聊天机器人、代码生成或数据分析,并且需要快速 AI 推理时,可使用此技能。如果你已经在使用兼容 OpenAI 的工具,并希望借助 xAI 的专用模型获得更快的响应,尤其是在实时客户支持或动态内容创建等受实时性约束的场景中,可优先选择此 API。

主要功能

  • 访问 api.x.ai/v1 上的聊天补全、嵌入和模型流式传输端点。
  • 支持 "grok-3" 等通用推理模型,以及适用于轻量级高速任务的 "grok-3-mini"。
  • 处理 JSON 请求负载,支持 temperature(0.0-2.0)、max tokens(最多 4096)和停止序列等参数。
  • 提供类似 OpenAI 的响应,包括包含文本和用量统计的 choices 数组。
  • 通过 Authorization 标头中的 API 密钥进行身份验证,格式为 "Bearer $XAI_API_KEY"。

使用模式

要使用此技能,请在环境中设置 API 密钥(例如,export XAI_API_KEY=your_key),然后向 api.x.ai/v1 发送 HTTP 请求。请求应采用 POST 调用,并使用 JSON 请求正文。进行聊天交互时,请指定模型和 messages 数组。务必在代码循环中检查错误。如果在脚本中使用,请针对速率限制处理重试。对于异步模式,可使用 Webhook,或轮询响应 ID。

常用命令/API

  • 聊天补全端点:POST https://api.x.ai/v1/chat/completions
    • 必需标头:Authorization: Bearer $XAI_API_KEY、Content-Type: application/json
    • 正文示例:{"model": "grok-3", "messages": [{"role": "user", "content": "Explain quantum computing"}]}
    • CLI 命令:curl -X POST -H "Authorization: Bearer $XAI_API_KEY" -H "Content-Type: application/json" -d '{"model":"grok-3","messages":[{"role":"user","content":"Summarize this text"}]}' https://api.x.ai/v1/chat/completions
  • 模型信息端点:GET https://api.x.ai/v1/models
    • 查询参数:无必需参数;返回 grok-3 和 grok-3-mini 等可用模型。
    • CLI 命令:curl -H "Authorization: Bearer $XAI_API_KEY" https://api.x.ai/v1/models
  • 常见请求标志:添加 "temperature": 0.7 以提高创造性,或添加 "max_tokens": 150 以限制输出长度。
  • 配置格式:将设置存储在 JSON 文件中,例如,{"api_key": "$XAI_API_KEY", "default_model": "grok-3-mini"},并在代码中加载。

集成说明

在运行前,将 $XAI_API_KEY 设置为环境变量即可集成。在 Python 中,使用 requests 库:import os; api_key = os.environ.get('XAI_API_KEY')。对于 Node.js,使用带标头的 fetch。避免将密钥硬编码;请使用安全密钥库。如果通过代理转发请求,请确保允许 HTTPS 流量直通。先用简单脚本进行测试,并通过检查响应标头中的 X-RateLimit-Remaining 处理速率限制。对于嵌入,请在代码库中将 xAI 模型映射为 OpenAI 格式。

错误处理

检查 HTTP 状态码:401 表示 API 密钥无效(使用正确的 $XAI_API_KEY 重试);429 表示触发速率限制(实施指数退避,例如等待 5 秒后重试)。解析 JSON 错误,检查是否包含 "context_length_exceeded" 等消息,并据此截断输入。在代码中使用 try-except 块封装请求:try: response = requests.post(url, headers=headers, json=data) except requests.exceptions.RequestException as e: log_error(e) and raise。对于模型特定错误,请在发送前验证输入,例如确保 messages 数组非空。

具体使用示例

  1. 生成文本摘要:使用此方法可快速总结内容。代码片段: import requests; os.environ['XAI_API_KEY'] = 'your_key'; response = requests.post('https://api.x.ai/v1/chat/completions', headers={'Authorization': 'Bearer ' + os.environ['XAI_API_KEY']], json={'model': 'grok-3-mini', 'messages': [{'role': 'user', 'content': 'Summarize AI ethics'}]}); print(response.json()['choices'][0]['message']['content'])
  2. 执行推理任务:查询并解决问题。代码片段: import requests; response = requests.post('https://api.x.ai/v1/chat/completions', headers={'Authorization': 'Bearer $XAI_API_KEY'}, json={'model': 'grok-3', 'messages': [{'role': 'user', 'content': 'Solve: What is 15% of 200?'}], 'temperature': 0.2}); print(response.json()['choices'][0]['message']['content'])

图关系

  • 所属集群:ai-apis
  • 标签:ai-apis、xai
  • 通过嵌入提示相关联:xai-grok(链接到 ai-apis 集群)

评论

支持 Markdown