Get Prompt
AI-generatedSummary
Retrieve a prompt from Future AGI prompt management using its name or ID and optional version settings.
Inputs
- promptName (required) — Name or ID of the prompt to retrieve; can be specified as an expression.
- useDefaultVersion (required) — Whether to use the default version configured for this prompt.
- useCompiledPrompt (required) — Whether to use the compiled version of the prompt.
- variableObjectMap (required) — JSON object mapping variable names to their values.
- promptVersion (required) — Version or label of the prompt to retrieve when not using the default version.
Output shape
object containing name, version, prompt config, and a list of variables
The returned object represents the retrieved prompt; variable names are provided in a "Variables" field.
Examples
Example 1: Retrieve the default version of a prompt named "WelcomeMessage"
promptName: "WelcomeMessage", useDefaultVersion: true
Example 2: Retrieve a specific compiled version of a prompt
promptName: "UserQuery", useCompiledPrompt: true, promptVersion: "v2", variableObjectMap: {"user": "John"}
Example 3: Retrieve a prompt using an expression for its ID
promptName: {{$node["Previous"].json.promptId}}, useDefaultVersion: false, promptVersion: "v3"