Search System Prompts
Searches system prompts with pagination. Custom prompts uploaded by the current account are visible only to platform administrators and the uploading account.
Request URL
POST {base_url}/uc-cconfig/api/v1/sounds/system-prompts/search-page
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.
- Body parameters
-
Parameter Required Type Description pageNumber No Integer The page number to retrieve. pageSize No Integer The number of records to retrieve per page. language No String The language to filter by. ownershipLevel No String The ownership level to filter by.
Valid value:
OWNERSHIP_LEVEL_SYSTEM: Builtin system prompts.OWNERSHIP_LEVEL_PLATFORM: Prompts uploaded by platform administrators.
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.
|
| 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<Search_Result> | The search result of system prompts. |
- Search_Result
-
Parameter Type Description pageSize Integer The number of records per page. pageNumber Integer The current page number. count String The total number of matching records. results Array<System_Prompt> The list of system prompts on the current page.
- System_Prompt
-
Parameter Type Description id String The ID of the system prompt. ownershipLevel String The ownership level of the system prompt:
OWNERSHIP_LEVEL_SYSTEM: A builtin system prompt.OWNERSHIP_LEVEL_PLATFORM: A prompt uploaded by a platform administrator.
language String The language of the system prompt. 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.
resourceId String The ID of the language pack file resource in the resource service. fileSize String The size of the language pack file, in bytes. version String The version of the system prompt. canDelete Boolean Whether the system prompt can be deleted.
true: The system prompt can be deleted.false: The system prompt cannot be deleted.
createdAt String The time when the system prompt was created, in Unix timestamp format (milliseconds). updatedAt String The time when the system prompt was last updated, in Unix timestamp format (milliseconds).
Example
Request example
POST /uc-cconfig/api/v1/sounds/system-prompts/search-page 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
Content-Type: application/json
{
"pageNumber": 1,
"pageSize": 10
}
Response example
HTTP/1.1 200 OK { "requestId": "9e5549a2db2d1b22b64aace5ac3fd144", "code": "200", "message": "SUCCESS", "detailMessage": "", "result": { "pageSize": 10, "pageNumber": 1, "count": "8", "results": [ { "id": "373769137025277952", "ownershipLevel": "OWNERSHIP_LEVEL_PLATFORM", "language": "dede", "isDefault": false, "resourceId": "2115379317511360513", "fileSize": "2006306", "version": "", "canDelete": true, "createdAt": "1793180706563", "updatedAt": "1793180706563", "used": false, "referencedTenantCodes": [], "owner": "Service Provider", "creator": "Service Provider" }, { "id": "337892085916016640", "ownershipLevel": "OWNERSHIP_LEVEL_SYSTEM", "language": "中文", "isDefault": false, "resourceId": "2114650818955153410", "fileSize": "9081372", "version": "v1.1.11", "canDelete": false, "createdAt": "1784626951013", "updatedAt": "1793007018386", "used": false, "referencedTenantCodes": [], "owner": "", "creator": "" }, { "id": "332348858387890176", "ownershipLevel": "OWNERSHIP_LEVEL_SYSTEM", "language": "English", "isDefault": true, "resourceId": "2113193718612856833", "fileSize": "7963676", "version": "v1.1.11", "canDelete": false, "createdAt": "1783305342582", "updatedAt": "1792659618629", "used": true, "referencedTenantCodes": [ "evietest2", "brand", "jint", "colortest5", "eedd2", "dave", "max", "min" ], "owner": "", "creator": "" }, { "id": "338854679921586176", "ownershipLevel": "OWNERSHIP_LEVEL_SYSTEM", "language": "Française (French)", "isDefault": false, "resourceId": "2113156374673330177", "fileSize": "8233500", "version": "v1.1.7", "canDelete": false, "createdAt": "1784856451308", "updatedAt": "1792650715132", "used": false, "referencedTenantCodes": [], "owner": "", "creator": "" }, { "id": "338854666810191872", "ownershipLevel": "OWNERSHIP_LEVEL_SYSTEM", "language": "Español latino (Spanish Latin)", "isDefault": false, "resourceId": "2113156153205690370", "fileSize": "9558044", "version": "1.1.11", "canDelete": false, "createdAt": "1784856448181", "updatedAt": "1792650662362", "used": false, "referencedTenantCodes": [], "owner": "", "creator": "" }, { "id": "340102842819436544", "ownershipLevel": "OWNERSHIP_LEVEL_SYSTEM", "language": "Deutsch(German)", "isDefault": false, "resourceId": "2113156067780300801", "fileSize": "10135580", "version": "v1.1.7", "canDelete": false, "createdAt": "1785154036533", "updatedAt": "1792650642018", "used": false, "referencedTenantCodes": [ "jint" ], "owner": "", "creator": "" }, { "id": "342849140798562304", "ownershipLevel": "OWNERSHIP_LEVEL_SYSTEM", "language": "Português Brasil (Portuguese Brazil)", "isDefault": false, "resourceId": "2113155974746443777", "fileSize": "9517084", "version": "v1.0.6", "canDelete": false, "createdAt": "1785808804995", "updatedAt": "1792650619803", "used": false, "referencedTenantCodes": [ "jint" ], "owner": "", "creator": "" }, { "id": "367958230689402880", "ownershipLevel": "OWNERSHIP_LEVEL_PLATFORM", "language": "dddf", "isDefault": false, "resourceId": "2109568395054526466", "fileSize": "8211962", "version": "", "canDelete": true, "createdAt": "1791795278531", "updatedAt": "1791795278531", "used": false, "referencedTenantCodes": [], "owner": "Service Provider", "creator": "Service Provider" } ], "languageCleared": false } }