Doubao API 申请指南

什么是Doubao API

Doubao API是字节跳动旗下火山引擎提供的一项服务，通过API接口的方式，为开发者和企业提供大模型的调用能力。用户可以通过Doubao API，轻松地接入字节跳动的AI大模型，进行各种自然语言处理、图像识别等任务。Doubao API的开放为研发人员提供了一个便捷的工具，可以在不具备大规模计算资源的情况下，利用先进的AI技术进行开发和创新。

Doubao API Logo

Doubao API的核心功能包括文本生成、文本分析、图像识别等。其强大的处理能力和稳定的服务质量，使得开发者能够用更少的代码实现复杂的功能。通过调用API，用户无需再自行搭建复杂的AI模型和基础设施，即可快速实现业务需求。

如何注册Doubao API

注册Doubao API是开启AI应用的第一步。首先，你需要访问火山引擎的官方网站，并在用户界面中找到API注册入口。注册过程非常简单，只需填写基本的账户信息并同意服务条款即可。

注册界面

完成注册后，用户需要验证邮箱，以确保账户的安全性。邮箱验证通过后，用户即可登录火山引擎管理控制台，开始配置和使用API。

配置API密钥

注册完成后，下一步是配置API密钥。API密钥是调用Doubao API的关键凭证，确保用户的每一次调用都能被正确授权和计费。

登录火山引擎控制台，导航到API密钥管理页面。
点击“创建API Key”按钮，填写名称并提交。
保存生成的API密钥，这将用于后续的API调用。

创建推理接入点

为了能够使用Doubao的大模型，用户需要在火山引擎平台上创建一个推理接入点。这个步骤是确保模型能够被正确调用的关键配置。

创建推理接入点

选择适合的模型

在创建推理接入点时，用户需要选择适合自身需求的模型版本。目前，Doubao提供了多种模型，如Doubao-lite和Doubao-pro，分别适用于不同的应用场景。

进入模型推理页面，点击“创建推理接入点”。
选择需要的模型版本，如Doubao-pro-32k。
确定模型版本后，点击“添加”以完成模型选择。

使用SDK调用Doubao API

为了简化API的调用过程，Doubao提供了多种编程语言的SDK，可以帮助开发者快速集成API功能。以下是使用Java SDK的示例：

package com.volcengine.ark.runtime;

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;

public class ChatCompletionsExample {
    public static void main(String[] args) {
        String apiKey = System.getenv("ARK_API_KEY");
        ArkService service = new ArkService(apiKey);

        List messages = new ArrayList();
        ChatMessage systemMessage = ChatMessage.builder().role(ChatMessageRole.SYSTEM).content("你是豆包，是由字节跳动开发的 AI 人工智能助手").build();
        ChatMessage userMessage = ChatMessage.builder().role(ChatMessageRole.USER).content("常见的十字花科植物有哪些？").build();
        messages.add(systemMessage);
        messages.add(userMessage);

        ChatCompletionRequest chatCompletionRequest = ChatCompletionRequest.builder()
                .model("${YOUR_ENDPOINT_ID}")
                .messages(messages)
                .build();

        service.createChatCompletion(chatCompletionRequest).getChoices().forEach(choice -> System.out.println(choice.getMessage().getContent()));

        service.shutdownExecutor();
    }
}

常见问题解答

FAQ

问：Doubao API 支持哪些编程语言的集成？
- 答：Doubao API 提供多种语言的SDK，包括Java、Python、Node.js等，方便开发者快速集成。
问：如何保证API调用的安全性？
- 答：API调用的安全性通过API密钥进行保障，用户需要妥善保管自己的密钥，并定期更新。
问：申请API的费用如何计算？
- 答：API费用根据调用次数和使用的模型版本计算，具体定价可参考火山引擎的官方定价文档。
问：API调用失败怎么办？
- 答：如遇API调用失败，建议检查网络连接、API密钥的有效性，以及接入点配置是否正确。
问：如何查看API的使用情况？
- 答：用户可以登录火山引擎管理控制台，在“使用统计”页面查看API的调用情况和资源使用详情。