星尘数字人网关文档

概述

星尘数字人提供了Android，iOS和Web三端SDK，客户可以直接通过端侧SDK使用数字人能力，但这种方式下，需要将API-KEY分发到客户端中，带来一定的安全风险。

本文档直接将数字人流程中，需要API-KEY访问的接口，以服务端API的形式进行提供。客户可以通过自己的业务服务端对数字人流程中的API进行封装，使用SDK时，直接通过SDK访问业务服务端封装后的API。这样星尘的API-KEY只需要存放在业务服务端，杜绝了API-KEY在客户端泄漏的可能性。

仅使用端侧SDK

业务服务端转发

数字人初始化

HTTP

shell

curl --location 'https://nlp.aliyuncs.com/v2/api/videochat/initialize' \
--header 'Expect;' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--header 'x-fag-servicename: aca-videochat-init' \
--header 'x-fag-appcode: aca' \
--header 'Authorization: Bearer your-api-key' \
--data '{
            "type": "Avatar",`
            "aca": {
                "botProfile": {
                    "appId": "",
                    "characterId": "",
                    "avatarId": "",
                    "avatarModelId": "",
                    "voiceId": "",
                    "advancedAttributes": {
                        "avatarAudioFormat": "s16"
                    }
                },
                "userProfile": {
                    "userId": ""
                }
            }
        }'

python

import json

import requests

api_key = "your-api-key"
service_name = "aca-videochat-init"

url = "https://nlp.aliyuncs.com/v2/api/videochat/initialize"
headers = {
    "Content-Type": "application/json",
    "x-fag-servicename": service_name,
    "x-fag-appcode": "aca",
    "Authorization": f"Bearer {api_key}"
}
payload = {
    "type": "Avatar",
    "aca": {
        "botProfile": {
            "appId": "",
            "characterId": "",
            "avatarId": "",
            "avatarModelId": "",
            "voiceId": "",
            "advancedAttributes": {
                "avatarAudioFormat": "s16"
            }
        },
        "userProfile": {
            "userId": ""
        }
    }
}
response = requests.post(url, headers=headers, json=payload)
print(response.status_code)
print(json.loads(response.text))

数据结构

request

response

资产获取

HTTP

shell

curl --location 'https://nlp.aliyuncs.com/v2/api/videochat/getRTCAvatarAsset' \
--header 'Expect;' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--header 'x-fag-servicename: aca-videochat-avatar-get' \
--header 'x-fag-appcode: aca' \
--header 'Authorization: Bearer your-api-key' \
--data '{
            "avatarId": "",
            "type": 2
        }'

python

import json

import requests

api_key = "your-api-key"
service_name = "aca-videochat-avatar-get"

url = "https://nlp.aliyuncs.com/v2/api/videochat/getRTCAvatarAsset"
headers = {
    "Content-Type": "application/json",
    "x-fag-servicename": service_name,
    "x-fag-appcode": "aca",
    "Authorization": f"Bearer {api_key}"
}
payload = {
    "avatarId": "",
    "type": 2
}
response = requests.post(url, headers=headers, json=payload)
print(response.status_code)
print(json.loads(response.text))

数据结构

request

response

错误码