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.

Supported REST HTTP Methods

URI: 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	Details
citation	Type `Picklist` Description Specifies how citations are returned: `post_generation`: Return citations after generation `off`: Don’t return citations
promptResponse	Type string Description The prompt response generated by the action based on the specified prompt template and input.

Additional input values vary according to the input variables specified for the prompt template.

Output	Details
citation	Type `AiCopilot.GenAiCitationOutput` Description The prompt response generated by the action based on the specified prompt template and input.
promptResponse	Type string Description The prompt response generated by the action based on the specified prompt template and input.