{"componentChunkName":"component---src-templates-acg-portal-new-template-tsx","path":"/vmo6xrd7q","result":{"data":{"markdownRemark":{"html":"\n
\n
\n
\n
\n
POST
\n
\nhttps://qianfan.baidubce.com/v2/promptTemplates?Action=DescribePromptTemplate\n
\n
\n
\n

本接口用于获取单个Prompt模板详情，如Prompt模板ID、名称等。

\n
\n
\n

鉴权说明

\n

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID和Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

\n
\n
\n

请求参数

\n
\n
\n
\n
\n
Headers 参数
\n
除公共头域外，无其它特殊头域
\n
\n
\n
\n
\n
Query 参数
\n
\n
\n
\n
\n
\n\nAction\n\nstring\n
\n

方法名称，本接口该字段值为 DescribePromptTemplate

\n
\n
必选
\n
\n
\n
\n
\n
\n
\n
Body 参数
\n
\n
\n
\n
\n
\n\ntemplateId\n\nstring\n
\n

Prompt模板ID，通过以下任一方式获取该字段值：
· 方式一：调用创建Prompt模板接口，返回的字段 templateId 获取
· 方式二：调用获取Prompt模板列表接口，返回的字段 templateId 获取
· 方式三：在控制台-Prompt模板-点击自制模板页面，选择模板，在模板详情查看模板ID

\n
\n
必选
\n
\n
\n
\n\nvar1\n\nstring\n
\n

动态插值变量示例1
\n请替换为您在模板中定义的真实变量名。例如：您的模板内容包含 {province}，则此处字段名应改为 province，值为具体省份（如 广东）。
\n如果您有多个变量，请按照此格式继续平铺传入（如模板包含 {city}，则传入字段名 city，值为 广州）。

\n
\n
必选
\n
\n
\n
\n\nvarn\n\nstring\n
\n

动态插值变量示例n
\n请替换为您在模板中定义的真实变量名。例如：您的模板内容包含 {province}，则此处字段名应改为 province，值为具体省份（如 广东）。
\n如果您有多个变量，请按照此格式继续平铺传入（如模板包含 {city}，则传入字段名 city，值为 广州）。

\n
\n
必选
\n
\n
\n
\n
\n
\n
\n
\n
\n
请求结构
\n\n
\n
\n\n
\n
POST /v2/promptTemplates?Action=DescribePromptTemplate HTTP/1.1\nHOST: qianfan.baidubce.com\nAuthorization: authorization string\nContent-Type: application/json\n{\n    \"templateId\": \"pt-838***93991e\",\n    \"number\": \"3\"\n}
\n
\n
\n
\n
\n
\n
\n
\n

示例代码

\n
\n\n
\n
\n
\n
请求示例
\n\n
\n
\n\n
\n
curl -i --location 'https://qianfan.baidubce.com/v2/promptTemplates?Action=DescribePromptTemplate'\\\n--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a5xxxx74525543'\\\n--header 'x-bce-date: 2023-09-19T13:37:10Z'\\\n--header 'Content-Type: application/json'\\\n--data '{\n    \"templateId\": \"pt-838***93991e\",\n    \"province\": \"Shanghai\"\n}'
\n
\n
\n
\n
\n
\n
\n
\n

返回响应

\n
\n
\n
\n
\n
Headers 参数
\n
除公共头域外，无其它特殊头域
\n
\n
\n
\n
\n
返回参数
\n
\n
\n
\n
\n
\n\nrequestId\n\nstring\n
\n

请求ID

\n
\n
可选
\n
\n
\n
\n\nresult\n\nobject {12}\n
\n

请求结果，请求成功时返回

\n
\n
可选
\n
\n\n
\n\n显示子属性\n隐藏子属性\n
\n\n
\n
\n
\n\ntemplateId\n\nstring\n
\n

Prompt模板ID

\n
\n
可选
\n
\n
\n
\n\ntemplateName\n\nstring\n
\n

Prompt模板的名称

\n
\n
可选
\n
\n
\n
\n\ntemplateContent\n\nstring\n
\n

模板内容，说明：
（1）如果不使用框架，示例：请以{number}字数生成{province}省相关简介\"
（2）如果使用模型框架该字段值需符合框架要求，详见模板框架说明

\n
\n
可选
\n
\n
\n
\n\ntemplateVariables\n\narray\n
\n

模板变量列表

\n
\n
可选
\n
\n\n
\n\n显示子属性\n隐藏子属性\n
\n\n
\n
\n
\n\nitems\n\nstring\n
\n
\n
\n
\n
\n
\n
\n
\n\nvariableIdentifier\n\nstring\n
\n

变量识别符号，现有符号：
· 大括号{}
· 双大括号{{}}
· 中括号[]
· 双中括号[[]]
· 小括号()
· 双小括号(())

\n
\n
可选
\n
\n
\n
\n\nnegativeTemplateContent\n\nstring\n
\n

反向prompt模板内容，表示不希望大模型生成的内容，说明：只有 sceneType 为 TextToImage，即场景类型为文生图时，返回该字段

\n
\n
可选
\n
\n
\n
\n\nnegativeTemplateVariables\n\nstring\n
\n

反向prompt模板的变量，说明：只有 sceneType 为 TextToImage 时，即场景类型为文生图时，返回该字段

\n
\n
可选
\n
\n
\n
\n\nlabels\n\narray\n
\n

模板标签

\n
\n
可选
\n
\n\n
\n\n显示子属性\n隐藏子属性\n
\n\n
\n
\n
\n\nitems\n\nobject {2}\n
\n
\n
\n\n
\n\n显示子属性\n隐藏子属性\n
\n\n
\n
\n
\n\nlabelId\n\nstring\n
\n

标签ID

\n
\n
可选
\n
\n
\n
\n\nlabelName\n\nstring\n
\n

标签名称

\n
\n
可选
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n\ntype\n\nstring\n
\n

模板类型
· System：系统预置模板
· Custom：用户创建模板。

\n
\n
可选
\n
\n
\n
\n\nsceneType\n\nstring\n
\n

场景类型：
· TextToText：文生文
· TextToImage：文生图。

\n
\n
可选
\n
\n
\n
\n\nframeworkType\n\nstring\n
\n

模板框架，说明：
· None：表示无框架，如果不传，默认是0
· Basic：Basic Prompt Framework
· CRISPE：CRISPE Prompt Framework
· FewShot：Few-shot Promt。

\n
\n
可选
\n
\n
\n
\n\nhyperParameters\n\nobject {12}\n
\n

推理参数，仅在开启推理时有效

\n
\n
可选
\n
\n\n
\n\n显示子属性\n隐藏子属性\n
\n\n
\n
\n
\n\nmodelName\n\nstring\n
\n

模型类别，可选值如下：
· EB-Turbo
· ERNIE-Bot
· open-source。

\n
\n
可选
\n
\n
\n
\n\ntemperature\n\nnumber\n
\n

温度，说明：
（1）较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定
（2）默认0.95，范围 (0, 1.0]，不能为0
（3）建议该参数和 top_p 只设置1个
（4）建议 top_p 和 temperature 不要同时更改

\n
\n
可选
\n
\n
\n
\n\ntopP\n\nnumber\n
\n

多样性，说明：
（1）影响输出文本的多样性，取值越大，生成文本的多样性越强
（2）默认0.8，取值范围 [0, 1.0]
（3）建议该参数和 temperature 只设置1个
（4）建议 top_p 和 temperature 不要同时更改

\n
\n
可选
\n
\n
\n
\n\npenaltyScore\n\nnumber\n
\n

重复惩罚，通过对已生成的token增加惩罚，减少重复生成的现象，说明：
（1）值越大表示惩罚越大
（2）默认1.0，取值范围：[1.0, 2.0]

\n
\n
可选
\n
\n
\n
\n\ndisableSearch\n\nboolean\n
\n

实时搜索，是否强制关闭实时搜索功能，默认false，表示不关闭

\n
\n
可选
\n
\n
\n
\n\nenableCitation\n\nboolean\n
\n

角标返回，是否开启上角标返回，说明：
（1）开启后，有概率触发搜索溯源信息 search_info
（2）默认false，不开启

\n
\n
可选
\n
\n
\n
\n\nstop\n\narray\n
\n

停止标识

\n
\n
可选
\n
\n\n
\n\n显示子属性\n隐藏子属性\n
\n\n
\n
\n
\n\nitems\n\nstring\n
\n
\n
\n
\n
\n
\n
\n
\n\nsystem\n\nstring\n
\n

模型人设，主要用于人设设定，例如，你是xxx公司制作的AI助手，长度限制1024个字符

\n
\n
可选
\n
\n
\n
\n\npicSize\n\nstring\n
\n

图片比例，入参 size。生成图片长宽，说明：
（1）默认值 1024x1024
（2）取值范围如下：[\"512x512\", \"768x768\", \"768x1024\", \"1024x768\", \"576x1024\", \"1024x576\", \"1024x1024\"]
注意：建议选择较大尺寸，结合完善的prompt，以保障图片质量。

\n
\n
可选
\n
\n
\n
\n\npicNum\n\ninteger\n
\n

图片数量，入参 n。生成图片数量，说明：
（1）默认值为1
（2）取值范围为1-4
（3）单次生成的图片较多及请求较频繁可能导致请求超时

\n
\n
可选
\n
\n
\n
\n\nsamplingSteps\n\ninteger\n
\n

采样步数，入参 step。进行采样的次数，说明：
（1）默认值为20
（2）取值范围为10-50

\n
\n
可选
\n
\n
\n
\n\nsamplingMode\n\nstring\n
\n

采样方式，入参 sampler_index，说明：
（1）默认值：Euler a
（2）值如下：
· Euler
· Euler a
· DPM++ 2M
· DPM++ 2M Karras
· LMS Karras
· DPM++ SDE
· DPM++ SDE Karras
· DPM2 a Karras
· Heun
· DPM++ 2M SDE
· DPM++ 2M SDE Karras
· DPM2
· DPM2 Karras
· DPM2 a
· LMS。

\n
\n
可选
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n\n
\n
\n
\n
成功示例
\n\n
\n
\n\n
\n
{\n    \"requestId\": \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\n    \"result\": {\n        \"templateId\": \"pt-838e92379b93991e\",\n        \"templateName\": \"3D角色\",\n        \"templateContent\": \"snowing winter in {location}, super cute baby pixar style white fairy bear, shiny snow-white fluffy, big bright eyes, wearing a woolly cyan hat, delicate and fine, high detailed, bright color, natural light, simple background, octane render, ultra wide angle, 8K\",\n        \"content\": \"snowing winter, super cute baby pixar style white fairy bear, shiny snow-white fluffy, big bright eyes, wearing a woolly cyan hat, delicate and fine, high detailed, bright color, natural light, simple background, octane render, ultra wide angle, 8K\",\n        \"templateVariables\": [\n            \"location\"\n        ],\n        \"variableIdentifier\": \"{}\",\n        \"negativeTemplateContent\": \"(worst quality, low quality:1.4),signature, watermark, simple background, dated, low res, line art, flat colors\",\n        \"negativeContent\": \"(worst quality, low quality:1.4),signature, watermark, simple background, dated, low res, line art, flat colors\",\n        \"labels\": [\n            {\n                \"labelId\": \"pl-9d42a4ea117d30x5\",\n                \"labelName\": \"图像生成\"\n            }\n        ],\n        \"type\": \"System\",\n        \"sceneType\": \"TextToImage\",\n        \"frameworkType\": \"None\",\n        \"hyperParametersStatus\": \"On\",\n        \"hyperParameters\": {\n            \"modelName\": \"开源模型\",\n            \"temperature\": 0.5,\n            \"topP\": 1,\n            \"penaltyScore\": 0.5,\n            \"system\": \"system\",\n            \"stop\": [\n                \"stop1\",\n                \"stop2\"\n            ],\n            \"disableSearch\": true,\n            \"enableCitation\": true\n        }\n    }\n}
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

错误码

\n

若请求错误，服务器将返回的JSON文本包含以下参数：

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
名称描述
requestId请求ID
code错误码
message错误描述信息，帮助理解和解决发生的错误
\n

例如错误返回：

\n
text
{\n    \"requestId\":\"6ba7b810-xxxc04fd430c8\",\n    \"code\":\"AccessDenied\",\n    \"message\":\"Access denied.\"\n}\n
\n

更多其他错误码，也可以查看错误码说明。

\n
\n
","fields":{"slug":"vmo6xrd7q","title":"获取单个Prompt模板详情","date":"2026-05-11","extractedHeadings":[{"value":"鉴权说明","depth":2},{"value":"请求参数","depth":2},{"value":"示例代码","depth":2},{"value":"返回响应","depth":2},{"value":"错误码","depth":2}]},"headings":[]}},"pageContext":{"isCreatedByStatefulCreatePages":false,"slug":"vmo6xrd7q","prev":{"id":"Rmo6w7lla","name":"算力单元服务付费相关","path":"Rmo6w7lla","filePath":"模型/管控面API/算力单元服务付费相关/修改算力单元后付费自动释放时间.md","seo":null,"parentIds":["Hm9b3tx1a","Imm1s6uow","omo6w6dde"],"parents":[{"id":"Hm9b3tx1a","documentId":"d53594ee-6426-4489-ab0f-d46881463d5d","name":"模型","repoName":"qianfan-api","filePath":"模型","disabled":false,"path":"Hm9b3tx1a","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":null},{"id":"Imm1s6uow","documentId":"587c47b1-bbae-46f0-ab50-a1c4d41d24e0","name":"管控面API","repoName":"qianfan-api","filePath":"模型/管控面API","disabled":false,"path":"Imm1s6uow","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""},{"id":"omo6w6dde","documentId":"626932da-e1be-4a3b-91d0-e5b33d80e249","name":"算力单元服务付费相关","repoName":"qianfan-api","filePath":"模型/管控面API/算力单元服务付费相关","disabled":false,"path":"omo6w6dde","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""}]},"next":{"id":"cmo6xmqa6","name":"获取Prompt模板标签列表","path":"cmo6xmqa6","filePath":"模型/管控面API/Prompt工程/获取Prompt模板标签列表.md","seo":null,"parentIds":["Hm9b3tx1a","Imm1s6uow","Tmo6w6wjo"],"parents":[{"id":"Hm9b3tx1a","documentId":"d53594ee-6426-4489-ab0f-d46881463d5d","name":"模型","repoName":"qianfan-api","filePath":"模型","disabled":false,"path":"Hm9b3tx1a","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":null},{"id":"Imm1s6uow","documentId":"587c47b1-bbae-46f0-ab50-a1c4d41d24e0","name":"管控面API","repoName":"qianfan-api","filePath":"模型/管控面API","disabled":false,"path":"Imm1s6uow","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""},{"id":"Tmo6w6wjo","documentId":"4542a2c7-74ef-4d01-a6da-fa015dfc1755","name":"Prompt工程","repoName":"qianfan-api","filePath":"模型/管控面API/Prompt工程","disabled":false,"path":"Tmo6w6wjo","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""}]},"parents":[{"id":"Hm9b3tx1a","documentId":"d53594ee-6426-4489-ab0f-d46881463d5d","name":"模型","repoName":"qianfan-api","filePath":"模型","disabled":false,"path":"Hm9b3tx1a","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":null},{"id":"Imm1s6uow","documentId":"587c47b1-bbae-46f0-ab50-a1c4d41d24e0","name":"管控面API","repoName":"qianfan-api","filePath":"模型/管控面API","disabled":false,"path":"Imm1s6uow","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""},{"id":"Tmo6w6wjo","documentId":"4542a2c7-74ef-4d01-a6da-fa015dfc1755","name":"Prompt工程","repoName":"qianfan-api","filePath":"模型/管控面API/Prompt工程","disabled":false,"path":"Tmo6w6wjo","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":""}],"specificSeo":null}}}