快速入门

快速入门

欢迎！在本指南中，我们将带您了解使用 xAI API 的基础知识，从创建账户到发出您的第一个请求。

步骤 1：创建 xAI 账户

在 accounts.x.ai 注册账户，然后为其充值以开始使用 API。

步骤 2：生成 API 密钥

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

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 中的代理编码提供支持，并在 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);

有关多轮对话、推理和结构化输出的内容，请参阅文本生成指南。有关代理编码工作流，请参阅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 能做什么：

资源

• 流式传输 - 实时流式传输响应
• 文件与集合 - 上传文档并构建 RAG 管道
• 工具 - 网络搜索、X 搜索、代码执行和函数调用
• 模型 - 比较可用模型及其功能
• 定价 - 工具、批量 API 和其他平台定价