Get Prompt Template By ID
Retrieve a prompt template filtered by department and language.
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
The promptID of the prompt template you want to fetch details for.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Query Parameters
Name of the department. Must be a valid department name.
^[^~`!#$%\^*()=\[\],;'"|<>\/?+{}]+$1 <= length <= 64The 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"
Header Parameters
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/PROD-4582?department=Service&languageCode=en-US" \ -H "Accept-Language: en-US"{ "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" ]}Get Prompt Templates GET
Retrieve prompt templates filtered by department and language.
Retrieve Chunks POST
The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines. The Retrieve API's response will either be a Certified Answer or a list of chunks. - **Certified Answers Response**: This response is observed when there's a matching certified answer to the user's query. - **Chunk List Response**: This response is observed, if there is no matched Certified Answer. Responses for both chunks and certified answers include relevance scores and metadata. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.

