文章来源:Grok 漫游指南 | xAI Docs
欢迎!在本指南中,我们将引导您了解使用 xAI API 的基础知识。
#第 1 步:创建 xAI 帐户
您需要一个 xAI 帐户才能访问 xAI API。在此处注册帐户。
创建账户后,您需要为其加载积分才能开始使用 API。
#第 2 步:生成 API 密钥
通过 xAI API 控制台中的 API 密钥页面创建 API 密钥。
生成 API 密钥后,我们需要将其保存在安全的地方!我们建议您将其导出为终端中的环境变量。
bash (Mac)
export XAI_API_KEY="your_api_key"
#第 3 步:提出您的第一个请求
将 xAI API 密钥导出为环境变量后,您就可以发出第一个 API 请求了。
让我们使用curl
.将以下内容直接粘贴到您的终端中。
bash
curl https://api.x.ai/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $XAI_API_KEY" \
-d '{"messages": [{"role": "system","content": "You are Grok, a chatbot inspired by the Hitchhikers Guide to the Galaxy."},{"role": "user","content": "What is the meaning of life, the universe, and everything?"}],"model": "grok-2-latest","stream": false,"temperature": 0
}'
#第 4 步:通过 Python 或 Javascript 发出请求
我们的 API 与 OpenAI 和 Anthropic SDK 完全兼容。例如,我们可以从 Python 或 Javascript 发出相同的请求,如下所示:
python
# In your terminal, first run:
# pip install openaiimport os
from openai import OpenAIXAI_API_KEY = os.getenv("XAI_API_KEY")
client = OpenAI(api_key=XAI_API_KEY,base_url="https://api.x.ai/v1",
)completion = client.chat.completions.create(model="grok-2-latest",messages=[{"role": "system","content": "You are Grok, a chatbot inspired by the Hitchhikers Guide to the Galaxy."},{"role": "user","content": "What is the meaning of life, the universe, and everything?"},],
)print(completion.choices[0].message.content)
有关使用 Grok 进行文本回复的深入指南,请查看我们的 聊天指南.
#第 5 步:使用 Grok 分析图像
某些 grok 模型可以同时接受文本和图像作为输入。例如:
python
import os
from openai import OpenAIXAI_API_KEY = os.getenv("XAI_API_KEY")
image_url = "https://science.nasa.gov/wp-content/uploads/2023/09/web-first-images-release.png"client = OpenAI(api_key=XAI_API_KEY,base_url="https://api.x.ai/v1",
)messages = [{"role": "user","content": [{"type": "image_url","image_url": {"url": image_url,"detail": "high",},},{"type": "text","text": "What's in this image?",},],},
]completion = client.chat.completions.create(model="grok-2-vision-latest",messages=messages,temperature=0.01,
)
print(completion.choices[0].message.content)
瞧!Grok 会告诉你图片中的确切内容:
这张图片是一张太空区域的照片,特别是 Carina 星云的一部分,由 James Webb 太空望远镜拍摄。它展示了星际气体和尘埃的壮丽景色,被年轻而炽热的恒星照亮。光的亮点是星星,五颜六色的云朵由各种气体和尘埃颗粒组成。该图像突出了星云中恒星形成的复杂细节和美丽。
要了解如何将 Grok Vision 用于更高级的用例,请查看我们的 Image Understanding Guide。
#监控使用情况
当您使用 API 密钥时,您需要为使用的令牌数量付费。有关概述,您可以在 xAI Console Usage Page 上监控您的使用情况。
如果您想要更精细的按请求使用情况跟踪,API 响应包括一个使用情况对象,该对象提供有关提示(输入)和完成(输出)令牌使用情况的详细信息。
json
"usage": {"prompt_tokens": 41,"completion_tokens": 87,"total_tokens": 128,"prompt_tokens_details": {"text_tokens": 41,"audio_tokens": 0,"image_tokens": 0,"cached_tokens": 0}
}
如果您发送请求过于频繁或提示时间过长,则可能会遇到速率限制并收到错误响应。有关更多信息,请阅读消耗和速率限制。
文章来源:Grok 漫游指南 | xAI Docs