GetPrompt - 获取prompt模板_大模型服务平台百炼(Model Studio)-阿里云帮助中心

通过PromptId和变量信息获取Prompt模板。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
sfm:GetPrompt	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
AgentKey	string	是	业务空间 key。	c160c841c8e54295bf2f441432785944_p_efm
PromptId	string	是	Prompt 的唯一标识。	cfec40c311f14f3e976403059d8f0116
Vars	string	否	prompt 变量信息。	{"platform":"小红书","topic":"蓝牙智能耳机","num1":"5个","num2":"5个"}

返回参数

名称	类型	描述	示例值
	object	Schema of Response.
RequestId	string	Id of the request.	1C139002-0EC5-584C-A755-4B8B9FA080BE
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Code	string	错误状态码。	100004
Message	string	错误信息。	参数缺失
HttpStatusCode	string	http 状态码。	200
Data	object	返回数据。
PromptId	string	Prompt 的唯一标识。	cfec40c311f14f3e976403059d8f0116
PromptContent	string	模板内容。	你是一名在小红书平台具有丰富经验的专业爆款营销文案策划人，现在请以“蓝牙智能耳机”为核心主题，撰写一段极具吸引力的小红书营销内容。要求内容包括：一个引人入胜且符合SEO优化原则的标题，以及一段详细且富有情感煽动力的正文。在正文中，请至少插入5个不同的emoji表情，以增加内容的互动性和视觉吸引力。此外，请根据该主题，设计并提供最多5个热门推荐标签，这些标签需具有高度概括主题和吸引目标用户群的特点。

示例

正常返回示例

JSON格式

{
  "RequestId": "1C139002-0EC5-584C-A755-4B8B9FA080BE",
  "Success": true,
  "Code": "100004",
  "Message": "参数缺失",
  "HttpStatusCode": "200",
  "Data": {
    "PromptId": "cfec40c311f14f3e976403059d8f0116",
    "PromptContent": "你是一名在小红书平台具有丰富经验的专业爆款营销文案策划人，现在请以“蓝牙智能耳机”为核心主题，撰写一段极具吸引力的小红书营销内容。要求内容包括：一个引人入胜且符合SEO优化原则的标题，以及一段详细且富有情感煽动力的正文。在正文中，请至少插入5个不同的emoji表情，以增加内容的互动性和视觉吸引力。此外，请根据该主题，设计并提供最多5个热门推荐标签，这些标签需具有高度概括主题和吸引目标用户群的特点。"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-12-07	API 内部配置变更，不影响调用	查看变更详情