Query System Prompt List

Query the current system prompt language and the list of installed system prompts.

Request URL

GET {base_url}/{api_path}/system_prompt/list?access_token={access_token}

Request parameters

No request parameters. Send the request URL directly to query system prompt list.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
system_prompt Object<System_Prompt> The current system prompt language and the system prompt information.
System_Prompt
Parameter Type Description
language String The language code of the currently selected system prompt (e.g., "sound-en" for English).
prompt_list Array<System_Prompt_Text> The list of system prompts.

System_Prompt_Text

Parameter Type Description
language String The language code of the system prompt (e.g., "sound-en" for English).
language_text String The display name of the system prompt language.
is_default_install Integer Whether the system prompt is pre-installed.
  • 0: No
  • 1: Yes

Example

Request example

GET /openapi/v1.0/system_prompt/list?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "system_prompt": {
    "language": "sound-en",
    "prompt_list": [
      {
        "language": "sound-en",
        "language_text": "English",
        "is_default_install": 1
      },
      {
        "language": "sound-zh",
        "language_text": "中文 (Chinese)",
        "is_default_install": 0
      }
    ]
  }
}