xAI API

什么是 xAI API？

xAI API 是面向开发者的接口，可从您的应用代码中使用 xAI 的 Grok 模型。其核心功能是接收提示（某些模型还支持图像），并返回生成的响应，您可直接显示、处理或结构化用于下游应用。

快速入门将带您完成端到端流程：创建 xAI 账号并充值、生成 API 密钥、安装 SDK，并使用支持的端点和示例向 Grok 模型发送首个请求。

主要特性

• 通过环境变量进行 API 密钥认证：使用 XAI_API_KEY 配置代码，xAI SDK 会自动读取。
• 常见语言的 SDK 支持：安装 Python 或 JavaScript 的 xAI SDK，即可调用 Grok 模型，无需编写原始 HTTP 请求。
• 聊天式文本生成：发送系统消息和用户消息，采样模型输出以生成文本响应。
• Responses 端点兼容：使用 API 密钥直接调用 https://api.x.ai/v1/responses 进行模型推理。
• 多模态输入（文本 + 图像）：对于支持的模型，可在单个请求中附带图像 URL 和文本。
• 结构化输出（支持的模型）：某些模型允许强制指定输出 schema，以控制生成结果的结构。

如何使用 xAI API

1. 创建 xAI 账号：在 accounts.x.ai 注册，然后充值以使用 API。
2. 创建 API 密钥：在 xAI 控制台的 API Keys 部分生成。
3. 设置 XAI_API_KEY：通过终端导出或添加到 .env 文件：
   • export XAI_API_KEY="your_api_key"
   • XAI_API_KEY=your_api_key
4. 安装 SDK：根据语言选择：
   • Python: pip install xai-sdk
   • JavaScript: npm install ai @ai-sdk/xai zod
5. 发送请求：向 Grok 模型发送请求（示例使用 grok-4.20-reasoning 处理文本，grok-4 处理图像+文本）。可使用 SDK 示例或直接 responses HTTP 请求。

使用场景

• 构建 Grok 聊天界面：创建应用发送用户问题和可选系统指令，然后显示 response.content 或 completion.output_text。
• 使用已知模型端点生成文本：通过 POST https://api.x.ai/v1/responses 流程，将 Grok 集成到偏好直接 HTTP 调用的服务中。
• 为问答流程添加图像理解：使用快速入门中的多模态请求格式，提交图像 URL 和提示，如“What’s in this image?”。
• 强制输出格式以便下游处理：使用支持的 Grok 模型时，应用结构化输出，让结果遵循您定义的 schema。
• 跨运行时快速实验：在 Python 和 JavaScript 示例间切换，同时保持相同的环境变量设置（XAI_API_KEY）。

常见问题

如何认证 xAI API 请求？

在 xAI 控制台创建 API 密钥，并设置为 XAI_API_KEY（例如通过 export XAI_API_KEY="..." 或 .env 文件）。xAI SDK 会自动读取此环境变量。

首个请求可以使用哪些 Grok 模型？

快速入门示例使用 grok-4.20-reasoning 进行纯文本聊天式生成，grok-4 用于图像+文本输入。

无需 SDK 即可调用 API 吗？

可以。快速入门包含直接 curl 示例，向 https://api.x.ai/v1/responses POST JSON 正文，包含 model 和 input。

如何向 Grok 发送图像？

对于支持图像的模型，在输入中附带图像 URL 和文本（示例使用 SDK 中的 input_image / input_text 结构，或 responses 调用中的类型化内容结构）。

什么是结构化输出？

快速入门指出，某些模型支持结构化输出，可强制 LLM 输出遵循指定 schema。该页面引用“文本生成指南”以获取深入用法。

替代方案

• 使用其他 LLM 提供商的聊天/助手 API：如果您的流程是“输入提示，输出生成文本”，可使用类似密钥认证和请求格式替换为其他供应商的 API。
• 使用框架无关的文本生成方式：不依赖特定供应商 SDK，直接针对“completions/responses” 风格端点构建请求，以保持跨语言集成一致性。
• 使用支持多模态的模型 API：如果主要需求是图像+文本理解，请寻找明确支持图像输入的提供商 API，然后相应调整请求负载。