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

Querying Applications

Function

Queries applications.

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

GET /v1/{project_id}/digital-human-chat/robot

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset where the query starts.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Number of items displayed on each page.

Value range:

1~100

Default value:

10

room_id

No

String

ID of the room for interactive dialogs.

robot_type

No

String

Interaction interconnection type.

  • LIVE: livestream interaction

  • CHAT: intelligent interaction

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Request ID.
Table 5 Response body parameters

Parameter

Type

Description

offset

Integer

Offset from the first data record.

Value range:

0~2147483647

Default value:

0

limit

Integer

Page size.

Value range:

1~1000

Default value:

10

count

Integer

Total number.

Value range:

0~2147483647

data

Array of RobotInfo objects

Application information
Table 6 RobotInfo

Parameter

Type

Description

robot_id

String

Application ID.

name

String

Application name.

room_id

String

ID of the room for interactive dialogs.

app_id

String

Third-party application ID.

app_type

Integer

Third-party application vendor. Options:

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

Value range:

0~32

app_key

String

Access key or account of an application.

robot_type

String

Interaction interconnection type.

  • LIVE: livestream interaction

  • CHAT: intelligent interaction

language

String

Language for intelligent interaction. Options:

  • zh_CN: Simplified Chinese (discontinued. Use CN.)

  • en_US: English (discontinued. Use EN.)

  • CN: Chinese

  • EN: English

  • ESP: Spanish (supported only outside China)

  • por: Portuguese (supported only outside China)

  • Arabic: Arabic (supported only outside China)

  • Thai: Thai (supported only outside China)

create_time

String

Creation time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

update_time

String

Update time. The format complies with RFC 3339, for example, 2021-01-10T08:43:17Z.

region

Integer

Region where CBS is

Value range:

0~32

cbs_project_id

String

Project ID of the region where CBS is

llm_url

String

Third-party language model URL.

is_stream

Boolean

Whether streaming response is used.

Default value:

false

chat_rounds

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

is_ifly_production

Boolean

Whether it is a production environment

Default value:

false

tail_silence_time

Integer

End-of-sentence pause duration threshold for immediately ending speech recognition. The default value is 500 ms.

Value range:

0~3000

role_id

String

AI Ask role ID.

sis_region

Integer

Region where SIS is

Value range:

0~32

sis_project_id

String

Project ID of the region where SIS is

enable_hot_words

Boolean

Whether to enable the keyword function

enable_question_audit

Boolean

Whether to enable question text review

asr_type

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

String

ASR account.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

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

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "offset" : 0,
  "limit" : 10,
  "count" : 1,
  "data" : [ {
    "robot_id" : "b3e2b1db10b34f45bff241b133142627",
    "name" : "Exhibition hall robot",
    "app_id" : "e1xxxecf",
    "app_type" : 0,
    "create_time" : "2023-09-01T06:34:21Z",
    "update_time" : "2023-09-01T06:34:21Z",
    "language" : "CN",
    "enable_hot_words" : false,
    "enable_question_audit" : true
  } ]
}

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