Get System Prompt Options

Retrieves the list of system prompts that are available as options, filtered by language.

Request URL

GET {base_url}/uc-cconfig/api/v1/sounds/options/system-prompts

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.

x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Query parameters
Parameter Required Type Description
language No String The language to filter by.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.

result Object<System_Prompt_Options> The list of system prompt options.
System_Prompt_Options
Parameter Type Description
options Array<System_Prompt_Option> The list of system prompt options.
System_Prompt_Option
Parameter Type Description
id String The ID of the system prompt.
language String The language of the system prompt.
isUsed Boolean

Whether the system prompt is in use.

  • true: The system prompt is in use.
  • false: The system prompt is not in use.
isDefault Boolean

Whether the system prompt is the default prompt.

  • true: The system prompt is the default prompt.
  • false: The system prompt is not the default prompt.

Example

Request example

GET /uc-cconfig/api/v1/sounds/options/system-prompts HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM3Mzc0NiwiaWF0IjoxNzkzMzUyMTQ2LCJqdGkiOiI4ODZlOTNhYS03YjU4LTQ0YmMtYTc2MS1lZmRlYTQ4ZThjZGMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.Qer2s1XtlMW2QjET3dn3LpkVdV7u-8JM-Xu-kqt3fXvAKU_oC6bcYmI4WDj1hOxxxedrmlWsVficK9GfCkN04A400eDTcS5ZzTA84Wwr_atew0M8H-uZMQLVPyLTplBlSHaXUzQLw1_UMYMzhiujWsbd17CiY8agw25m51KLnaQgNxa5lGNP1Uma3sjau6UXPQ7lXJQmGLP3RBccxqL9MpxF4Q5ai7q-muOscl1s_pf-2qskOx_yoLMaa5sZYdm_tOeQHRgqVGYvl85fJJMbhSJBfzZG1D-K452pwwndR7txwdKxHFEMCGPoJDkzFRhINLFcyMi-oJyTAwNjeFoYxg

Response example

HTTP/1.1 200 OK
{
  "requestId": "f759257bb483779e1d6d2288df067109",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "options": [
      {
        "id": "373769137025277952",
        "language": "dede",
        "isUsed": false,
        "isDefault": false
      },
      {
        "id": "337892085916016640",
        "language": "中文",
        "isUsed": false,
        "isDefault": false
      },
      {
        "id": "332348858387890176",
        "language": "English",
        "isUsed": true,
        "isDefault": true
      },
      {
        "id": "338854679921586176",
        "language": "Française (French)",
        "isUsed": false,
        "isDefault": false
      },
      {
        "id": "338854666810191872",
        "language": "Español latino (Spanish Latin)",
        "isUsed": false,
        "isDefault": false
      },
      {
        "id": "340102842819436544",
        "language": "Deutsch(German)",
        "isUsed": false,
        "isDefault": false
      },
      {
        "id": "342849140798562304",
        "language": "Português Brasil (Portuguese Brazil)",
        "isUsed": false,
        "isDefault": false
      },
      {
        "id": "367958230689402880",
        "language": "dddf",
        "isUsed": false,
        "isDefault": false
      }
    ]
  }
}