获取Prompt模板列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| sfm:ListPromptTemplates | list | *全部资源 * |
| 无 |
请求语法
GET /{workspaceId}/promptTemplates HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| workspaceId | string | 是 | 业务空间 Id | llm-us9hjmt32nysdxxx |
| name | string | 否 | 基于模板名称关键字搜索 | 小红书 |
| type | string | 否 | 模板类型，可选值： · System：系统预置模板 · Custom：用户自定义模板 | System |
| maxResults | integer | 否 | 最大返回数量 | 10 |
| nextToken | string | 否 | 由前一次的请求返回，传入时本次查询结果将基于前一次请求结果进行分页 | dc270401186b433f975d7e1faaa34e0e |
返回参数
示例
正常返回示例
JSON格式
{
"maxResults": 10,
"nextToken": "dc270401186b433f975d7e1faaa34e0e",
"promptTemplates": [
{
"content": "请写一篇小红书种草笔记，增加丰富的emoji元素，结尾作总结，并加上相关标签。主题为：${theme}",
"name": "小红书文案\n",
"promptTemplateId": "d6935b7efbe34d11b13df9307151cf8c",
"type": "\"System\"",
"variables": [
"\"theme\""
]
}
],
"requestId": "FE9B6CBF-47E6-5D76-9C5D-B814DD5AB071",
"totalCount": 15,
"workspaceId": "llm-us9hjmt32nysdxxx\n"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | PromptTemplate.MaxResultsInvalid | Input parameter MaxResults is invalid. | 输入参数maxResults格式无效。 |
| 400 | PromptTemplate.NameInvalid | Input parameter Name is invalid. | 输入参数Name的格式无效。 |
| 400 | PromptTemplate.NextTokenInvalid | Input parameter NextToken is invalid. | 入参nextToken是无效的。 |
| 400 | PromptTemplate.TypeInvalid | Input parameter type is invalid. | 入参type格式无效。 |
| 500 | PromptTemplate.InternalError | Prompt template service inner exception. | prompt模板服务内部异常 |
访问错误中心查看更多错误码。