Prompt
Get Prompt Templates
Retrieve prompt templates filtered by department and language.
Authorization
accessToken AuthorizationBearer <token>
JWT Bearer Token authentication for API access
In: header
Query Parameters
department*string
Name of the department. Must be a valid department name.
Match
^[^~`!#$%\^*()=\[\],;'"|<>\/?+{}]+$Length
1 <= length <= 64languageCode*string
The language used while writing the prompt templates.
Value in
- "en-US"
- "fr-FR"
- "en-GB"
- "es-ES"
- "it-IT"
- "nl-NL"
- "da-DA"
- "sv-SE"
- "pt-PT"
- "fi-FI"
- "no-NB"
- "no-NN"
- "ja-JA"
- "de-DE"
- "pt-BR"
- "zh-CN"
- "zh-TW"
- "ko-KO"
- "ru-RU"
- "el-EL"
- "tr-TR"
- "pl-PL"
- "cs-CS"
- "sk-SK"
- "hu-HU"
- "sr-SR"
- "ar-SA"
- "hr-HR"
- "ro-RO"
- "th-TH"
- "xx-XX"
name?string
Fetch only templates with this exact name.
Match
^[\w\W]*$Length
1 <= length <= 255useFor?string
Filter prompt templates based on console.
Value in
- "advisor"
- "knowledge"
- "custom"
Header Parameters
Accept-Language*string
The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
Value in
- "en-US"
- "es-ES"
- "fr-FR"
- "it-IT"
- "de-DE"
- "nl-NL"
- "pt-BR"
- "pt-PT"
- "da-DK"
- "ru-RU"
- "fr-CA"
- "zh-CN"
- "ja-JP"
- "ko-KR"
- "sv-SE"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/knowledge/contentmgr/v4/prompts/prompttemplates?department=Service&languageCode=en-US&name=Generate+email&useFor=knowledge" \ -H "Accept-Language: en-US"{ "promptTemplates": [ { "name": "Generate Title", "id": "PROD-26471", "description": "Generate article title based on article content", "active": true, "useFor": "knowledge", "appliesTo": "article", "instruction": "I want you to generate...", "outputFormat": "html", "createdOn": "2024-04-01T08:00:00Z", "modifiedDate": "2024-04-30T17:30:00Z", "createdBy": { "id": "string", "userName": "string", "firstName": "string", "middleName": "string", "lastName": "string" }, "reviewStatus": "published", "isSystemCreated": false, "fieldToUpdate": "custom.contactPerson.cust1", "displayAt": [ "article.content-area" ] } ]}
