You need to enable JavaScript to run this app.
导航
获取 API key
最近更新时间:2024.07.02 11:11:26首次发布时间:2024.05.14 23:50:17

火山方舟 SDK V3 使用 API key 作为访问方舟资源的凭证,本文介绍 API key 的获取方法。

注意

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

控制台获取API Key(推荐)

说明

通过您在平台创建 API Key 对推理接入点进行授权,使用相对简单。
火山方舟 V3 API 与 OpenAI API 协议兼容,您可以使用火山引擎官方 SDK,也可以使用 OpenAI SDK 或其他兼容 OpenAI API 协议的多语言社区 SDK 调用火山方舟推理服务。

获取API Key

进入 API Key 管理 页面,选择需要的项目,点击 创建 API Key,即可生成长效 API Key。all权限默认给予项目下所有模型接入点和智能体访问权限。

设置 API Key

您可以在 API Key 管理页面创建及管理 API Key 作为推理接入点的访问密钥。
按如下方式设置 API Key 作为环境变量,其中 YOUR_API_KEY 需要替换为您在平台上创建的 API Key。

export ARK_API_KEY="YOUR_API_KEY"

火山IAM授权 (推荐)

说明

按照云标准 IAM 方式进行身份认证和权限范围管理。平台使用您的 AK/SK 自动帮您换取 API Key,并自动进行续期。

设置 IAM 访问密钥

您可以前往访问控制访问密钥中创建及管理您的 AK/SK。
按如下方式设置 AK/SK 作为环境变量,其中YOUR_AKYOUR_SK 需要替换为您在平台上创建的 API Key。

export VOLC_ACCESSKEY="YOUR_AK"
export VOLC_SECRETKEY="YOUR_SK"

使用SDK 获取 API key (不推荐)

说明

  1. 通过此方法可获取短效 API Key,具有使用时限,过期后请重新获取;

  2. 需要先获取推理接入点(Endpoint)的读权限才能使用您的 AK/SK 换取 API key。

获取示例

python

  1. 安装火山 python sdk。
pip install volcengine-python-sdk
  1. 修改脚本中的占位符 Your AK, Your SK, Your ENDPOINT ID,即可获取模型推理接入点(Endpoint)的API key
    1. API key 有效时长由duration_seconds定义,单位为秒;

    2. AK/SK 可通过API访问密钥 页面获取;

    3. Endpoint ID 可通过火山方舟 - 模型推理获取,格式为ep-xxxxxx;

    4. resource_ids 支持输入多个 Endpoint ID。

from __future__ import print_function
import volcenginesdkcore
import volcenginesdkark
from pprint import pprint
from volcenginesdkcore.rest import ApiException

if __name__ == '__main__':
    configuration = volcenginesdkcore.Configuration()
    configuration.ak = "Your AK"
    configuration.sk = "Your SK"
    configuration.region = "cn-beijing"
    # set default configuration
    volcenginesdkcore.Configuration.set_default(configuration)

    # use global default configuration
    api_instance = volcenginesdkark.ARKApi()
    get_api_key_request = volcenginesdkark.GetApiKeyRequest(
        duration_seconds=30*24*3600, # 时效为 30 天
        resource_type="endpoint",
        resource_ids=[
            "${YOUR_ENDPOINT_ID}"
        ],
    )
    
    try:
        resp = api_instance.get_api_key(get_api_key_request)
        pprint(resp)
    except ApiException as e:
        print("Exception when calling api: %s\n" % e)

平台工具生成 curl 命令获取 API key(不推荐)

使用平台工具 API Explore,执行以下步骤:

  1. 顶部导航栏选择产品:【火山方舟】;

  2. 左侧搜索栏版本号选择【2024-01-01】,搜索 API 名称【GetApiKey】并选择;

  3. 服务 Region 选择【华北2(cn-beijing)】;

  4. 输入 GetApiKey 参数:

    1. DurationSeconds:填写 API key 的过期时间,单位为秒;

    2. ResourceType:选择【endpoint】;

    3. ResourceIds:填写 Endpoint ID,格式为ep-xxxxxxxx;

  5. 选择签名工具,填写以下参数:

    1. Access Key ID:填写 AK,可通过API访问密钥 页面获取;

    2. Secret Access Key:填写 SK,可通过API访问密钥 页面获取;

    3. Host:填写【open.volcengineapi.com】;

  6. 点击 生成签名,将页面下拉至底部,可获取生成 API key的 curl 命令。

HTTP 获取 API key (不推荐)

如果自己实现代码获取 API key,需要用 AK/SK 进行 API 签名。代码逻辑可参考火山签名源码示例,使用以下服务元信息替换火山签名源代码对应字段:

Serviceark
Version2024-01-01
Regioncn-beijing
Hostopen.volcengineapi.com
methodPOST
ContentTypeapplication/json
AK用您火山帐号的 AK
SK用您火山帐号的 SK
actionGetApiKey
// Request Body示例
{
    "DurationSeconds": 2592000,
    "ResourceType": "endpoint",
    "ResourceIds": [
        "${YOUR_ENDPOINT_ID}"
    ]
}

// Response 示例
{
    "ResponseMetadata": {
        "RequestId": "2024050714351457A6700E0283E46A3894",
        "Action": "GetApiKey",
        "Version": "2024-01-01",
        "Service": "ark",
        "Region": "cn-beijing"
    },
    "Result": {
        "ApiKey": "....",
        "ExpiredTime": 1717750566
    }
}