Getting started with the Prompt Library

Your agent depends on prompts that change frequently. The Prompt Library lets you manage them outside your codebase, version each change automatically, and link the exact version that ran to its trace.

Adding the Prompt Library to your code

npx skills add comet-ml/opik-skills

Version my prompts in Opik using the /opik-instrument command.

Choosing a version

Pass the version parameter to control which version is returned:

• Omit version (default) — The most recently created version. Useful when you want the agent to pick up new prompt edits automatically.
• "v3" (or any v<N> name) — A specific version. Useful when you want the prompt to stay fixed regardless of newer edits — for example, when reproducing a past run or comparing versions.

# Fetch a specific version
v3 = client.get_prompt(name="system_prompt", version="v3", project_name="my-agent")
# Fetch the most recent version (omit `version`)
latest = client.get_prompt(name="system_prompt", project_name="my-agent")

Chat prompts

For multi-turn agents with system, user, and assistant roles, use create_chat_prompt / createChatPrompt and the matching get_chat_prompt / getChatPrompt. See Text and chat prompts for a deeper comparison, multimodal content, and template engines.

client.create_chat_prompt(
    name="support_assistant",
    messages=[
        {"role": "system", "content": "You are a helpful support agent for {{company}}."},
        {"role": "user", "content": "{{user_query}}"},
    ],
    project_name="my-agent",
)
chat_prompt = client.get_chat_prompt(
    name="support_assistant",
    version="v3",
    project_name="my-agent",
)
messages = chat_prompt.format(
    variables={"company": "Acme", "user_query": "How do I reset my password?"},
)