For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
DocsReferenceChangelog
DocsReferenceChangelog
  • Getting Started
    • Overview
    • Quickstart
  • Explanation
    • Integrating Humanloop
  • Tutorials
    • Evaluate an Agent in the UI
    • Evaluate an Agent in code
    • Evaluate a RAG app
    • Capture user feedback
  • How-To Guides
    • Migrating from Humanloop
      • Create a Prompt
      • Call a Prompt
      • Log to a Prompt
      • Store Prompts in code
      • Tool calling in Editor
      • Re-use snippets in Prompts
      • Deploy to an environment
      • Create a Directory
      • Link a Tool for Function Calling
  • Reference
    • Deployment Options
    • Supported Models
    • Template Library
    • Vercel AI SDK
    • .prompt and .agent Files
    • Humanloop Runtime Environment
    • Security and Compliance
    • Data Management
    • Access roles (RBACs)
    • SSO and Authentication
    • LLMs.txt
LogoLogo
Sign inBook a demo
On this page
  • Create a Prompt in the UI
  • Create a Humanloop Account
  • Add an OpenAI API Key
  • Get Started
  • Create a Prompt using the SDK
  • Next Steps
How-To GuidesPrompt Management

Create a Prompt

How to create, version and use a Prompt in Humanloop
Was this page helpful?
Previous

Call a Prompt

A guide on how to call your Prompts that are managed on Humanloop.
Next
Built with

Humanloop acts as a registry of your Prompts so you can centrally manage all their versions and Logs, and evaluate and improve your AI systems.

This guide will show you how to create a Prompt in the UI or via the SDK/API.

Prerequisite: A Humanloop account.

You can create an account now by going to the Sign up page.

Create a Prompt in the UI

Account setup

Create a Humanloop Account

If you haven’t already, create an account or log in to Humanloop

Add an OpenAI API Key

If you’re the first person in your organization, you’ll need to add an API key to a model provider.

  1. Go to OpenAI and grab an API key
  2. In Humanloop Organization Settings set up OpenAI as a model provider.

Using the Prompt Editor will use your OpenAI credits in the same way that the OpenAI playground does. Keep your API keys for Humanloop and the model providers private.

Get Started

1

Create a Prompt File

When you first open Humanloop you’ll see your File navigation on the left. Click ‘+ New’ and create a Prompt.

In the sidebar, rename this file to “Comedian Bot” now or later.

2

Create the Prompt template in the Editor

The left hand side of the screen defines your Prompt – the parameters such as model, temperature and template. The right hand side is a single chat session with this Prompt.

In the editor, update the system message to:

You are a funny comedian. Write a joke about {{topic}}.

This message forms the chat template. It has an input slot called topic (surrounded by two curly brackets) for an input value that is provided each time you call this Prompt.

On the right hand side of the page, you’ll now see a box in the Inputs section for topic.

  1. Add a value for topic e.g. music, jogging, whatever
  2. Click Run in the bottom right of the page

This will call OpenAI’s model and return the assistant response. Feel free to try other values, the model is very funny.

You now have a first version of your prompt that you can use.

3

Save your first version of this Prompt

  1. Click the Save button at the top of the editor
  2. Enter Initial Comedian Setup in the version name field
  3. Enter Prompt for making (not so) funny jokes! in the description field
  4. Click Save
4

View the logs

Under the Prompt File, click ‘Logs’ to view all the generations from this Prompt

Click on a row to see the details of what version of the Prompt generated it. From here you can give feedback to that generation, see performance metrics, open up this example in the Editor, or add this log to a Dataset.

Create a Prompt using the SDK

The Humanloop Python SDK allows you to programmatically create and version your Prompts in Humanloop, and log generations from your models. This guide will show you how to create a Prompt using the SDK.

Note that you can also version your prompts dynamically with every Prompt

Prerequisite: A Humanloop SDK Key.

You can get this from your Organisation Settings page if you have the right permissions.

Install and initialize the SDK

First you need to install and initialize the SDK. If you have already done this, skip to the next section.

Open up your terminal and follow these steps:

  1. Install the Humanloop SDK:
1pip install humanloop
  1. Initialize the SDK with your Humanloop API key (you can get it from the Organization Settings page).
1from humanloop import Humanloop
2humanloop = Humanloop(api_key="<YOUR HUMANLOOP KEY>")
3
4# Check that the authentication was successful
5print(humanloop.prompts.list())

After initializing the SDK client, you can call the Prompt creation endpoint.

1

Create the Prompt

This can be done by using the Prompt Upsert method in the SDK.

Or by calling the API directly:

POST
/v5/prompts
1curl -X POST https://api.humanloop.com/v5/prompts \
2     -H "X-API-KEY: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "model": "gpt-4o",
6  "path": "Personal Projects/Coding Assistant",
7  "endpoint": "chat",
8  "template": [
9    {
10      "content": "You are a helpful coding assistant specialising in {{language}}",
11      "role": "system"
12    }
13  ],
14  "provider": "openai",
15  "max_tokens": -1,
16  "temperature": 0.7,
17  "version_name": "coding-assistant-v1",
18  "version_description": "Initial version"
19}'
Try it
2

Go to the App

Go to the Humanloop app and you will see your Prompt in your list of files.

You now have a Prompt in Humanloop that contains your initial version. You can call the Prompt in Editor and invite team members by going to your organization’s members page.

Next Steps

With the Prompt set up, you can now integrate it into your app by following the Call a Prompt Guide.