文档反馈
问问助手说明
单击参与方舟文档调研，前 100 位提交有效问卷即可获得 30 元代金券！本次调研聚焦代码示例交互体验，助力提升文档使用体验。期待您的参与！
本文帮助您快速完成 API 调用模型，包括配置环境、使用 SDK 。
快速入口：
- 直接体验模型能力，访问 模型广场
- 有模型调用经验，查看教程文本生成。
- 业务从 OpenAI 迁移至方舟，查看兼容 OpenAI SDK。
获取 API Key
- 打开并登录API Key 管理 页面。
- （可选）单击左上角 账号全部资源 下拉箭头，切换项目空间。
- 单击 创建 API Key 按钮。
- 在弹出框的 名称 文本框中确认/更改 API Key名称，单击创建。
您可以在API Key 管理 页面的 API Key 列表中查看刚创建的API Key信息。
说明
如使用 Access Key，请参见 Base URL及鉴权。
配置 API Key 到环境变量
建议配置 API Key 到环境变量，避免在代码中明文输入 API Key，降低泄漏风险。
完整说明请参见 环境变量配置指南。
仅在当前会话中使用 API Key 环境变量，可以添加临时环境变量。
- 打开终端使用以下命令来设置环境变量，将
<ARK_API_KEY>替换为您的方舟 API Key。
export ARK_API_KEY="<ARK_API_KEY>"
- 执行以下命令，验证该环境变量是否生效。
echo $ARK_API_KEY
通过 Model ID 快速调用模型。
说明
如是多应用、企业用户等场景，推荐通过 Endpoint ID 来调用模型，具体可参考获取 Endpoint ID。
Curl ｜Python ｜ Go ｜ Java
选择熟悉和方便的语言调用模型推理服务。
Curl
通过 HTTP 方式直接调用方舟模型服务。
在终端窗口中，复制并运行下面命令，稍等可在终端窗口中看到模型调用的返回结果。这样就完成了首次方舟平台模型服务调用。
curl https://ark.cn-beijing.volces.com/api/v3/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $ARK_API_KEY" \ -d '{ "model": "doubao-seed-1-6-251015", "messages": [ { "role": "user", "content": "hello" } ] }'
- 如果返回错误码
{"error":{"code":"AuthenticationError","message":"The API key or AK/SK in the request is missing or invalid. requestId: 0217***，说明 API Key 没有被正确设置到环境变量中，检查您的环境配置或直接替换$ARK_API_KEY为 API Key ，再次运行命令。
Python
检查并安装 3.7 或以上版本 Python。
在终端输入以下命令检查 Python 版本：python -V如运行失败，请尝试命令：
python3 -V如果未安装或者版本不满足，请参考 Python 安装教程。
安装/升级方舟 Python SDK。
# 安装 pip install 'volcengine-python-sdk[ark]' # 升级 pip install 'volcengine-python-sdk[ark]' -U如安装错误，可尝试使用下面命令安装。
# 安装 pip install volcengine-python-sdk[ark] # 升级 pip install -U volcengine-python-sdk[ark]创建
ark_example.py文件，复制下面示例代码进文件。import os from volcenginesdkarkruntime import Ark client = Ark( api_key=os.environ.get("ARK_API_KEY"), # The base URL for model invocation . base_url="https://ark.cn-beijing.volces.com/api/v3", ) completion = client.chat.completions.create( # Replace with Model ID . model="doubao-seed-1-6-251015", messages=[ {"role": "user", "content": "Hello"} ] ) print(completion.choices[0].message)在终端输入下面命令，运行代码。
python ark_example.py稍等在终端窗口中会打印调用结果。这样你完成了首次模型服务调用。
Go
检查 Go 版本，需 1.18 或以上。
go version如果未安装 Go 或者版本不满足要求，参考文档安装 1.18 或以上版本 Go。
安装方舟 Go SDK。
方舟 Go SDK 使用 go mod 进行管理。运行以下命令初始化工程。替换<YOUR_PROJECT_NAME>为您的项目名称。go mod init <YOUR_PROJECT_NAME>运行以下命令安装方舟 Go SDK。
go get -u github.com/volcengine/volcengine-go-sdk创建一个
main.go文件，复制下面代码到文件。package main import ( "context" "fmt" "os" "github.com/volcengine/volcengine-go-sdk/service/arkruntime" "github.com/volcengine/volcengine-go-sdk/service/arkruntime/model" "github.com/volcengine/volcengine-go-sdk/volcengine" ) func main() { client := arkruntime.NewClientWithApiKey( os.Getenv("ARK_API_KEY"), arkruntime.WithBaseUrl("https://ark.cn-beijing.volces.com/api/v3"), // The base URL for model invocation ) // 创建一个上下文，通常用于传递请求的上下文信息，如超时、取消等 ctx := context.Background() // 构建聊天完成请求，设置请求的模型和消息内容 req := model.CreateChatCompletionRequest{ Model: "doubao-seed-1-6-251015", // Replace with Model ID Messages: []*model.ChatCompletionMessage{ { // 消息的角色为用户 Role: model.ChatMessageRoleUser, Content: &model.ChatCompletionMessageContent{ StringValue: volcengine.String("hello"), }, }, }, } // 发送聊天完成请求，并将结果存储在 resp 中，将可能出现的错误存储在 err 中 resp, err := client.CreateChatCompletion(ctx, req) if err != nil { // 若出现错误，打印错误信息并终止程序 fmt.Printf("standard chat error: %v\n", err) return } // 打印聊天完成请求的响应结果 fmt.Println(*resp.Choices[0].Message.Content.StringValue) }在终端运行下面命令，更新项目的依赖项。
go mod tidy执行下面命令，运行代码。
go run main.go稍等，终端中打印模型调用结果。这样您完成了首次模型服务调用。
Java
检查 Java 版本，需要 1.8 或以上。
java -version如果未安装 Java 或者版本不满足要求，访问网站下载并安装 Java，请确保选择 1.8 或以上版本。
安装方舟 Java SDK。
方舟 Java SDK 支持通过 Maven 和 Gradle 两种方式安装。通过 Maven 安装：在项目的
pom.xml文件中添加以下依赖配置。... <dependency> <groupId>com.volcengine</groupId> <artifactId>volcengine-java-sdk-ark-runtime</artifactId> <version>LATEST</version> </dependency> ...打开终端并进入项目根目录，运行下面命令，来安装依赖项。
mvn clean install通过 Gradle 安装：在项目的
build.gradle文件中，在dependencies部分添加以下依赖。implementation 'com.volcengine:volcengine-java-sdk-ark-runtime:LATEST'
说明
获取 SDK 版本信息，替换'LATEST' 为指定/最新版本号。可查询：https://github.com/volcengine/volcengine-java-sdk/releases
将下面的示例代码复制到您的项目中。
package com.ark.example; import com.volcengine.ark.runtime.model.completion.chat.ChatCompletionRequest; import com.volcengine.ark.runtime.model.completion.chat.ChatMessage; import com.volcengine.ark.runtime.model.completion.chat.ChatMessageRole; import com.volcengine.ark.runtime.service.ArkService; import java.util.ArrayList; import java.util.List; /** * 这是一个示例类，展示了如何使用ArkService来完成聊天功能。 */ public class ChatCompletionsExample { public static void main(String[] args) { // 从环境变量中获取API密钥 String apiKey = System.getenv("ARK_API_KEY"); // . ArkService arkService = ArkService.builder().apiKey(apiKey).baseUrl("https://ark.cn-beijing.volces.com/api/v3").build(); // 初始化消息列表 List<ChatMessage> chatMessages = new ArrayList<>(); // 创建用户消息 ChatMessage userMessage = ChatMessage.builder() .role(ChatMessageRole.USER) // 设置消息角色为用户 .content("hello") // 设置消息内容 .build(); // 将用户消息添加到消息列表 chatMessages.add(userMessage); // 创建聊天完成请求 ChatCompletionRequest chatCompletionRequest = ChatCompletionRequest.builder() .model("doubao-seed-1-6-251015") // Replace with Model ID .messages(chatMessages) // 设置消息列表 .build(); // 发送聊天完成请求并打印响应 try { // 获取响应并打印每个选择的消息内容 arkService.createChatCompletion(chatCompletionRequest) .getChoices() .forEach(choice -> System.out.println(choice.getMessage().getContent())); } catch (Exception e) { System.out.println("Error: " + e.getMessage()); } finally { // 关闭服务执行器 arkService.shutdownExecutor(); } } }编译您的 Java 项目并运行。
稍等，终端窗口中会打印模型调用的结果。这样您就完成了首次模型服务调用。
现在你已经完成了首次方舟模型服务的 API 调用，你可以探索模型的更多能力，包括：