本文帮助您了解并按照步骤完成 API 调用模型，包括如何配置环境，使用 SDK 调用模型服务，便于您了解如何通过代码使用模型能力，进而集成到您的工作或者应用中。

快速入口，供您快速跳转到需要的内容：

• 直接体验模型能力，访问模型广场。
• 有模型调用经验，查看对话(Chat)-文本 API或者模型教程文本生成。
• 已有模型调用业务，迁移到 Doubao 大模型，可参考兼容OpenAI API。

简介

通过代码调用模型服务，可以分为以下几步：

• 1.获取并配置 API Key
• 2.获取 Model ID
• 3.配置环境并发起调用

1.获取并配置 API Key

获取 API Key

1. 打开并登录方舟控制台-API Key 管理。
2. 单击创建 API Key 按钮。
3. 在弹出框的名称文本框中确认/更改 API Key 名称，单击创建。

说明

• 请妥善保存好API Key，强烈建议您不要将其直接写入到调用模型的代码中。
• Access Key鉴权方式，请参见Access Key 签名鉴权。

配置 API Key 到环境变量

您希望仅在当前会话中使用 API Key 环境变量，可以添加临时环境变量。

macOS/Linux

1. 打开终端使用以下命令来设置环境变量，将<ARK_API_KEY>替换为您的方舟 API Key。

export ARK_API_KEY="<ARK_API_KEY>"

2. 执行以下命令，验证该环境变量是否生效。

echo $ARK_API_KEY

Windows

1. 打开 CMD（命令提示符） 。
2. 输入以下命令来设置环境变量，将<ARK_API_KEY>替换为您的实际 API Key：

set ARK_API_KEY=<ARK_API_KEY>

3. 验证环境变量是否设置成功，输入以下命令，如果返回您的 API Key，则表示设置成功。

echo %ARK_API_KEY%

2.获取 Model ID

通过 Model ID的方式快速调用模型。

1. 通过 模型列表 选择模型并获取所需模型的 ID（Model ID）。
2. 访问开通管理页面 开通对应模型服务。

说明

您也可通过Endpoint ID来调用模型，获得限流、计费类型（前付费/后付费）、运行状态查询、监控、安全等高级能力，具体可参考获取 Endpoint ID。

3.配置环境并发起调用

您可以通过 HTTP 方式直接调用方舟模型服务。
在终端窗口中，拷贝下面命令，并替换<Model>为您的推理接入点 ID模型的Model ID。稍等您可以在终端窗口中看到模型调用的返回结果。这样您就完成了您的首次方舟平台模型服务调用。

curl https://ark.cn-beijing.volces.com/api/v3/chat/completions \ 
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer $ARK_API_KEY" \ 
-d '{ "model": "<Model>", "messages": [ { "role": "user", "content": "你好" } ] }'

如果返回错误码 {"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 ，再次运行命令。