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

本接口用于获取Prompt模板列表。

\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

方法名称，固定值DescribePromptTemplates

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

标记本次查询的起始位置。首次或首页查询可不传或传空字符串，往后翻页时请传上一次查询响应体中的的nextMarker

\n
\n
可选
\n
\n
\n
\n\nmaxKeys\n\ninteger\n
\n

本次查询包含的最大结果集数量，默认10，建议最大值不超过100

\n
\n
可选
\n
\n
\n
\n\npageReverse\n\nboolean\n
\n

是否倒序查询，默认为false

\n
\n
可选
\n
\n
\n
\n\nname\n\nstring\n
\n

输入模板名称或内容搜索

\n
\n
可选
\n
\n
\n
\n\nlabelIds\n\narray\n
\n

标签ID数组，说明：（1）如果不填写该字段，表示获取所有模板 （2）数组内元素为标签ID，string类型

\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\ntype\n\nstring\n
\n

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

\n
\n
可选
\n
\n
\n
\n
\n
\n
\n
\n
\n
请求结构
\n\n
\n
\n\n
\n
POST /v2/promptTemplates?Action=DescribePromptTemplates HTTP/1.1\nHOST: qianfan.baidubce.com\nAuthorization: authorization string\nContent-Type: application/json\n{\n    \"marker\": \"\",\n    \"maxKeys\": 2,\n    \"pageReverse\": false,\n    \"name\": \"\",\n    \"labelIds\": [\"pl-838e92379b93991e\"],\n    \"type\": \"Custom\"\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=DescribePromptTemplates'\\\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    \"marker\": \"\",\n    \"maxKeys\": 2,\n    \"pageReverse\": false,\n    \"name\": \"\",\n    \"labelIds\": [\"pl-838e92379b93991e\"],\n    \"type\": \"Custom\"\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 {2}\n
\n

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

\n
\n
可选
\n
\n\n
\n\n显示子属性\n隐藏子属性\n
\n\n
\n
\n
\n\npageInfo\n\nobject {4}\n
\n

分页信息

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

本次查询的起始位置标识

\n
\n
可选
\n
\n
\n
\n\nisTruncated\n\nboolean\n
\n

后面是否还有数据。· true：表示后面还有数据· false：表示已经是最后一页

\n
\n
可选
\n
\n
\n
\n\nnextMarker\n\nstring\n
\n

下次查询的起始位置标记，示例：\"pl-dnqpsnv1sahwj604\"

\n
\n
可选
\n
\n
\n
\n\nmaxKeys\n\ninteger\n
\n

本次查询的页大小

\n
\n
可选
\n
\n
\n
\n
\n
\n
\n\nitems\n\narray\n
\n

模板数组

\n
\n
可选
\n
\n\n
\n\n显示子属性\n隐藏子属性\n
\n\n
\n
\n
\n\nitems\n\nobject {8}\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\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 {3}\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\ncolor\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
\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        \"pageInfo\": {\n            \"marker\": \"pt-5c126587e90b2b15\",\n            \"isTruncated\": true,\n            \"nextMarker\": \"pt-sdsfds516ca2f4d02\",\n            \"maxKeys\": 2\n        },\n        \"items\": [\n            {\n                \"templateId\": \"pt-5c126587e90b2b15\",\n                \"templateName\": \"照片写实2\",\n                \"templateContent\": \"Cherry Blossoms in Hokkaido in the {season}, Canon RF 16mm f:2.8 STM Lens, hyperrealistic photography, style of unsplash and National Geographic\",\n                \"negativeTemplateContent\": \"owres,bad anatomy,cropped,worst quality,low quality,normal quality,blurry,blurry,sketches\",\n                \"labels\": [\n                    {\n                        \"labelId\": \"pl-838e92379b93991e\",\n                        \"labelName\": \"图像生成\",\n                        \"color\": \"#0099E6\"\n                    }\n                ],\n                \"type\": \"System\",\n                \"sceneType\": \"TextToImage\"\n            },\n            {\n                \"templateId\": \"pt-8d2916f476edb9d8\",\n                \"templateName\": \"3D角色\",\n                \"templateContent\": \"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                \"negativeTemplateContent\": \"(worst quality, low quality:1.4),signature, watermark, simple background, dated, low res, line art, flat colors\",\n                \"labels\": [\n                    {\n                        \"labelId\": \"pl-2c99e0e003a78114\",\n                        \"labelName\": \"图像生成\",\n                        \"color\": \"#0099E6\"\n                    }\n                ],\n                \"type\": \"System\",\n                \"sceneType\": \"TextToImage\"\n            }\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":"imo6xke09","title":"获取Prompt模板列表","date":"2026-04-21","extractedHeadings":[{"value":"鉴权说明","depth":2},{"value":"请求参数","depth":2},{"value":"示例代码","depth":2},{"value":"返回响应","depth":2},{"value":"错误码","depth":2}]},"headings":[]}},"pageContext":{"isCreatedByStatefulCreatePages":false,"slug":"imo6xke09","prev":{"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":""}]},"next":{"id":"Lmo6xhk07","name":"更新Prompt模板","path":"Lmo6xhk07","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}}}