You need to enable JavaScript to run this app.
导航
签名鉴权方式
最近更新时间:2024.07.23 14:51:42首次发布时间:2024.07.10 15:12:25

火山方舟各 API 支持的签名鉴权方式如下表所示:

API签名鉴权方式
大模型/智能体调用 APIAPI Key 签名鉴权
其他 OpenAPI基于 IAM 访问控制的 AK/SK 签名鉴权

API Key 签名鉴权

API Key 是您请求火山方舟模型推理 API 的安全凭证,您可以在 API Key 管理页面创建并获取 API Key 作为推理接入点的访问密钥。

获取 API Key

进入 API Key 管理页面,在您有权限的项目下点击创建 API Key,即可生成长效 API Key。

注意

API Key 是您请求火山方舟大模型服务的重要凭证。API Key 长期有效,请您不要将密钥信息共享至公开环境,妥善保管并定期轮换密钥,避免因未经授权的使用造成安全风险或资金损失。



权限范围

API Key 的授权范围为同项目下所有模型推理接入点 API 和智能体 API。

签名构造

API Key 签名鉴权方式要求在 HTTP 请求 header 中按如下方式添加 Authorization header:

Authorization: Bearer <api-key>

API 调用示例

curl https://ark.cn-beijing.volces.com/api/v3/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ea764f0f-3b60-45b3-****-************" \
  -d '{
    "model": "ep-20240704******-*****",
    "messages": [
        {
            "role": "system",
            "content": "You are a helpful assistant."
        },
        {
            "role": "user",
            "content": "Hello!"
        }
    ]
  }'

AK/SK 签名鉴权

访问密钥(Access Key)是请求火山引擎各云服务 OpenAPI 的安全凭证,请参考 Access Key 管理 获取账户的 Access Key ID 和 Secret Access Key。

获取访问密钥

如果您需要获取当前身份的密钥,您可以进入 API 访问密钥页面(也可以从顶部导航中头像下拉菜单中的API 访问密钥入口中进入页面),创建并获取 Access Key ID 和 Secret Access Key。

签名构造

火山引擎在 SDK 中提供了签名函数或方法,开发者只需要在请求中提供访问密钥等信息, SDK 会自动计算请求签名,并将签名结果添加到请求中。这种方法简化了签名过程,降低了开发难度。具体使用方式请参考各语言 SDK 文档。

您也可以使用火山引擎开发者工具 API Explorer 中的签名工具,快速构建 请求所需的 Authorization Header 并发起 cURL 请求:



当您不可避免地需要自行编码构造签名时,可参考签名方法文档内的签名机制介绍,自行编码构造签名。我们也为您提供了签名 Demo 示例:


API 调用示例

curl -X POST \
  'https://open.volcengineapi.com/?Action=ListEndpoints&Version=2024-01-01' \
  -H 'Authorization: HMAC-SHA256 Credential=AKLTM2MyNzJhMGExZmFhNDI5YTgzMTI****************/20240710/cn-beijing/ark/request, SignedHeaders=host;x-content-sha256;x-date, Signature=a7a01ad627bcb9ef03bd708bf0f680873d99fa99c45fe8b4****************' \
  -H 'Content-Type: application/json' \
  -H 'Host: open.volcengineapi.com' \
  -H 'X-Content-Sha256: 44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e83****************' \
  -H 'X-Date: 20240710T042925Z' \
  -d '{}'