Help Center/ MetaStudio/ API Reference/ Intelligent Interaction/ Intelligent Interaction Management/ Virtual Avatar Application Management/ Verifying an Application
Updated on 2025-12-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Verifying an Application

Function

Verifies an application.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{project_id}/digital-human-chat/robot/validate

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

You can obtain the token by calling the IAM API used to obtain a user token.

Value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

X-App-UserId

No

String

Third-party user ID, which does not allow Chinese characters.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

app_type

Yes

Integer

Third-party application vendor. Options:

NOTE:
0: iFLYTEK AIUI; 1: Huawei Cloud CBS; 2: iFLYTEK Spark Cognitive Model; 6: Third-party Language Model; 7: AI Assistant; 8: Mobvoi

Value range:

0~32

huawei_ei_cbs

No

HuaweiEiCbs object

Huawei Cloud CBS application configuration

iflytek_aiui_config

No

IflytekAiuiConfig object

iFLYTEK AIUI application configuration

iflytek_spark

No

IflytekSpark object

iFLYTEK Spark Cognitive Model application configuration

third_party_model_config

No

ThirdPartyModelConfig object

Third-party language model configuration

mobvoi_config

No

MobvoiConfig object

AI Ask application configuration

wise_brain_config

No

WiseBrainConfig object

AI assistant application configuration
Table 4 HuaweiEiCbs

Parameter

Mandatory

Type

Description

app_id

No

String

CBS application ID.

region

No

Integer

Region where CBS is

Value range:

0~32

cbs_project_id

No

String

Project ID of the region where CBS is

sis_region

No

Integer

Region where SIS is

Value range:

0~32

sis_project_id

No

String

Project ID of the region where SIS is

enable_hot_words

No

Boolean

Whether to enable the keyword function
Table 5 IflytekAiuiConfig

Parameter

Mandatory

Type

Description

app_id

No

String

AIUI application ID.

app_key

No

String

AIUI application key.

api_secret

No

String

AIUI API key.

is_production

No

Boolean

Whether it is a production environment

Default value:

false
Table 6 IflytekSpark

Parameter

Mandatory

Type

Description

app_id

No

String

iFLYTEK Spark Cognitive Model application ID.

app_key

No

String

iFLYTEK Spark Cognitive Model application key.

api_secret

No

String

iFLYTEK Spark Cognitive Model API key.

is_production

No

Boolean

Whether it is a production environment

Default value:

false
Table 7 ThirdPartyModelConfig

Parameter

Mandatory

Type

Description

app_id

No

String

Third-party language model application ID.

app_key

No

String

Third-party language model application key.

llm_url

No

String

Third-party language model URL.

is_stream

No

Boolean

Whether streaming response is used.

Default value:

false

chat_rounds

No

Integer

Number of supported multi-round dialogs. If the value is greater than 1, historical dialog information is carried when a third-party language model is requested.

Value range:

1~10

Default value:

1

sis_region

No

Integer

Region where SIS is

Value range:

0~32

sis_project_id

No

String

Project ID of the region where SIS is

enable_hot_words

No

Boolean

Whether to enable keywords (This parameter is valid when asr_type is set to EI_SIS).

asr_type

No

String

Interconnected ASR vendor type

  • EI_SIS: Huawei Cloud SIS (supported only in the Chinese mainland)

  • MOBVOI: Mobvoi (supported only outside the Chinese mainland)

asr_account

No

String

ASR account (This parameter is not required when asr_type is set to EI_SIS.)

asr_secret

No

String

ASR key (This parameter is not required when asr_type is set to EI_SIS.)
Table 8 MobvoiConfig

Parameter

Mandatory

Type

Description

app_key

No

String

AI Ask application account.

app_secret

No

String

AI Ask application secret.

role_id

No

String

AI Ask role ID.

sis_region

No

Integer

Region where SIS is

Value range:

0~32

sis_project_id

No

String

Project ID of the region where SIS is

enable_hot_words

No

Boolean

Whether to enable the keyword function
Table 9 WiseBrainConfig

Parameter

Mandatory

Type

Description

role_id

No

String

Role ID.

sis_region

No

Integer

Region where SIS is

Value range:

0~32

sis_project_id

No

String

Project ID of the region where SIS is

enable_hot_words

No

Boolean

Whether to enable the keyword function

Response Parameters

Status code: 200

Table 10 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

POST https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/robot/validate

{
  "app_type" : 0,
  "iflytek_aiui_config" : {
    "app_id" : "e1xxxecf",
    "app_key" : "xxxxxxxxxx",
    "api_secret" : "xxxxxxxxxx",
    "is_production" : false
  }
}

Example Responses

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

Returned when the request succeeded.

400

Parameters error, including the error code and its description.

Error Codes

See Error Codes.

Parent Topic: Virtual Avatar Application Management