Skip to content

Retrieve a Prompt

Once a prompt exists in Prompt Hub, your application fetches it at runtime instead of hardcoding the text. You can look it up by name or by ID, and optionally ask for a specific version - if you don’t, you get the latest available content. If you don’t ask for compilation, you get the raw prompt text back untouched, including any {{variableName}} placeholders still in place.

Any {{variableName}} placeholder in a prompt’s content is replaced with the value you pass at fetch time when compilation is enabled. It’s plain text substitution - there’s no escaping, no nested variables, and no default values, so make sure you pass a value for every placeholder the prompt uses.

Every fetch is counted, so the Downloads column on the prompt list and the per-version counts on the Versions tab reflect real usage from your application.

To authenticate SDK or API requests, you need an API key:

Create an API Key
  • Go to Shield360 and navigate to the API Keys page.
  • Click Create API Key.
  • Enter a name for your API key.
  • Save the key displayed - store it securely, since you’ll pass it to the SDK for authentication.
GET Prompt API reference

Full request/response schema, plus Python and TypeScript SDK examples for fetching and compiling a prompt