The Prompt-Hub allows you to manage prompts, fetch specific versions of the prompt, and compile prompts with variables.

​
Key Features

  • Prompt Management: Create, edit, and track different versions of your prompts.
  • Versioning: Supports major, minor, and patch updates for clear version management.
  • Dynamic Variables: Use {{variableName}} placeholders that are dynamically replaced at runtime.
  • Statistics: View download stats and version history directly in the UI.

​
Get Started

1

List of Prompts

Get a quick overview of all prompts created.

  1. Navigate to the Prompt Hub in OpenLIT.
  2. Explore the available prompts listed.
2

Create or Edit a Prompt

Build new prompts or edit existing ones with ease.

  1. Click on + New to create a new prompt
  2. In the prompt editor, add the prompt name, Meta Properties and use placeholders like {{variableName}} to represent dynamic data that will be substituted when the prompt is compiled.
  3. Specify major, minor, or patch updates for versioning as you create or modify prompts.

View Prompt Details

Once the prompt is creaetd, You can see information about the prompt along with details on all past versions.

4

Retrieve the Prompt

1

Create an API Key

To authenticate your requests, you need an API key. Here’s how you can create one:

  • Go to the OpenLIT UI.
  • Navigate to the API Keys page.
  • Click on Create API Key.
  • Enter a name for your API key.
  • Save the API key displayed. Ensure you store it securely as it will be used for authentication in the SDK.
2

Get prompt using the SDK

Here’s how you can fetch and compile a prompt in Python:

import openlit

response = openlit.get_prompt(
  url="http://127.0.0.1:3000", 
  api_key="_OPENLIT_API_KEY",  
  name="prompt_name",          
  should_compile=True,                
  variables={
    "name": "John",            
  },
)

print(response)
Output
{
  err: null,
  res: {
      promptId: '88c4cbcd-87f9-4957-a37b-b41066e17471',
      name: 'prompt_name',
      version: '3.3.3',
      tags: [ 'user', 'greeting' ],
      metaProperties: { model: 'gpt4' },
      prompt: 'Hello {{name}}, how are you today?',
      compiledPrompt: 'Hello John, how are you today?'
  }
}

SDK Parameters

Below are the parameters for use with the SDK, formatted to indicate whether each is required or optional:

ParameterDescription
urlSets the Openlit URL. Defaults to the OPENLIT_URL environment variable.
api_keySets the OpenLIT API Key. Can also be provided via the OPENLIT_API_KEY environment variable.
nameSets the name to fetch a unique prompt. Use this or prompt_id.
prompt_idSets the ID to fetch a unique prompt. Use this or name. Optional
versionSet to True to get the prompt with variable substitution.. Optional
shouldCompileBoolean value that compiles the prompt using the provided variables. Optional
variablesSets the variables for prompt compilation. Optional
meta_propertiesSets the meta-properties for storing in the prompt’s access history metadata. Optional

Was this page helpful?

Track Cost for Custom ModelsConnect Multiple Databases