Prompt Template Actions
Creates a response based on the large language model (LLM) response for the specified prompt template and inputs.
This object is available in API version 60.0 and later.
This action is available only if you enable Prompt Builder and the user who runs the flow has the Prompt Template User permission.
The API name for each action is prefixed with generatePromptResponse.
URIs:
- Get a list of available Prompt Template actions:
/services/data/vXX.X/actions/custom/generatePromptResponse - Get information about a specific Prompt Template action:
/services/data/vXX.X/actions/custom/generatePromptResponse/template_API_name
Formats: JSON, XML
HTTP Methods: GET, HEAD, POST
Authentication: Authorization: Bearer token
| Input | Type | Description |
|---|---|---|
citationMode | Picklist | Specifies how citations are returned: in_generation to return citations in generation, post_generation to return citations after generation, or off to not return citations. |
GenAiPromptTemplateVersionId | string | The ID of the prompt template version that runs when this prompt template is called. |
inputs | Array of objects | Inputs to the prompt template called by the Prompt Template Action. The request body format varies based on input type (objects or data model objects (DMO)). |
Use this schema when your prompt template expects structured inputs such as record references.
Use this schema when your prompt template only needs simple string inputs.
Additional input values vary according to the input variables specified for the prompt template.
| Output | Type | Description |
|---|---|---|
citations | AiCopilot.GenAiCitationOutput | Information about the citations associated with this response. |
promptResponse | string | The prompt response generated by the action. The generated response is based on the specified prompt template and input. |
structuredResponse | Apex class | The structured response of the generated text. The type can be a standard or custom Apex class. |