Get Prompt Template By ID

Retrieve a prompt template filtered by department and language.

SecurityoAuthUser or oAuthClient
Request
path Parameters
promptID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

The promptID of the prompt template you want to fetch details for.

Example: PROD-4582
query Parameters
department
required
string [ 1 .. 64 ] characters ^[^~`!#$%\^*()=\[\],;'"|<>\/?+{}]+$

Name of the department. Must be a valid department name.

Example: department=Service
languageCode
required
string

The language used while writing the prompt templates.

Enum: "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"
Example: languageCode=en-US
header Parameters
Accept-Language
required
string

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Enum: "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"
Example: en-US
Responses
200

Successful response with list of prompt templates

204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/prompts/prompttemplates/{promptID}
Request samples
Response samples
application/json
{
  • "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": {
    },
  • "reviewStatus": "published",
  • "isSystemCreated": false,
  • "fieldToUpdate": "custom.contactPerson.cust1",
  • "displayAt": [
    ]
}