快速开始 | Grok 中文文档

欢迎！本指南将带你了解使用 xAI API 的基础流程，从创建账户到发出第一个请求。

第 1 步：创建 xAI 账户

在 accounts.x.ai 注册账户，然后充值额度即可开始使用 API。

第 2 步：生成 API key

通过 API Keys 页面创建 API key，然后将其导出或添加为环境变量。

export XAI_API_KEY="your_api_key"

或者将其添加到项目目录中的 .env 文件：

XAI_API_KEY=your_api_key

第 3 步：安装 SDK

选择你的语言并安装 SDK：

pip install xai-sdk

pip install openai

npm install ai @ai-sdk/xai zod

npm install openai

第 4 步：发出第一个请求

向 Grok Build（grok-4.5）发送编程提示词并获取响应。Grok Build 中的 Agent 编程能力由同一模型提供，该模型目前通过 API 提供早期访问：

curl https://api.x.ai/v1/responses \
  -H "Authorization: Bearer $XAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "grok-4.5",
    "input": "Fix this function and explain the bug: function median(a){a.sort();return a[a.length/2]}"
  }'

import os
from xai_sdk import Client
from xai_sdk.chat import user

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

chat = client.chat.create(model="grok-4.5")
chat.append(user("Fix this function and explain the bug: function median(a){a.sort();return a[a.length/2]}"))

print(chat.sample().content)

from openai import OpenAI

client = OpenAI(
    api_key="<YOUR_XAI_API_KEY_HERE>",
    base_url="https://api.x.ai/v1",
)

response = client.responses.create(
    model="grok-4.5",
    input="Fix this function and explain the bug: function median(a){a.sort();return a[a.length/2]}",
)

print(response.output_text)

import { xai } from '@ai-sdk/xai';
import { generateText } from 'ai';

const { text } = await generateText({
  model: xai.responses('grok-4.5'),
  prompt: 'Fix this function and explain the bug: function median(a){a.sort();return a[a.length/2]}',
});

console.log(text);

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env.XAI_API_KEY,
  baseURL: 'https://api.x.ai/v1',
});

const response = await client.responses.create({
  model: 'grok-4.5',
  input: 'Fix this function and explain the bug: function median(a){a.sort();return a[a.length/2]}',
});

console.log(response.output_text);

如需多轮对话、推理和结构化输出，请参阅文本生成指南。如需 Agent 编程工作流，请参阅 Grok Build 概览。

第 5 步：生成图像

使用 Imagine API 根据文本提示词生成图像：

import os
import xai_sdk

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

response = client.image.sample(
    prompt="A futuristic city skyline at sunset",
    model="grok-imagine-image-quality",
)

print(response.url)

import os
from openai import OpenAI

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

response = client.images.generate(
    model="grok-imagine-image-quality",
    prompt="A futuristic city skyline at sunset",
)

print(response.data[0].url)

import { xai } from '@ai-sdk/xai';
import { generateImage } from 'ai';

const { image } = await generateImage({
  model: xai.image('grok-imagine-image-quality'),
  prompt: 'A futuristic city skyline at sunset',
});

console.log(image.base64);

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env.XAI_API_KEY,
  baseURL: 'https://api.x.ai/v1',
});

const response = await client.images.generate({
  model: 'grok-imagine-image-quality',
  prompt: 'A futuristic city skyline at sunset',
});

console.log(response.data[0].url);

curl -X POST https://api.x.ai/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $XAI_API_KEY" \
  -d '{
    "model": "grok-imagine-image-quality",
    "prompt": "A futuristic city skyline at sunset"
  }'

如需批量生成、宽高比控制和图像编辑等更高级的用例，请查看图像生成指南。

接下来

现在你已经发出了第一个请求，可以继续探索 Grok 的能力：

Code使用 API 和 CLI 中的 grok-4.5 进行 Agent 编程探索 Chat多轮对话、推理、结构化输出与流式响应探索 Images使用 Grok 模型生成、编辑和理解图像探索 Video通过文本提示词或参考图像创建、扩展和编辑视频探索 Voice使用 Speech to Speech 能力构建实时语音 Agent探索

资源

流式响应 - 实时接收响应
文件与集合 - 上传文档并构建 RAG pipeline
工具 - Web search、X search、code execution 和 function calling
模型 - 比较可用模型及其能力
价格 - 工具、Batch API 和其他平台价格