System Templates

System templates allow you to create dynamic, context-aware prompts for your AI agents using Jinja2 templating. This guide covers everything you need to know about creating and customizing system templates.

Overview

System templates in Julep are Jinja2 templates that define the initial system prompt for your AI agents. They allow you to:

Create dynamic prompts that adapt based on context
Include user information, session data, and other variables
Implement conditional logic for different scenarios
Maintain consistency across agent interactions
Inject custom metadata at the message level for dynamic behavior

Template Hierarchy

Julep uses a three-level hierarchy for system templates:

Agent Default Template: Defined when creating an agent
Session Template: Can override the agent’s default template for specific sessions
Chat Metadata: Can inject dynamic variables at the individual message level

The session template takes precedence over the agent’s default template. Chat metadata is available in both cases.

Default System Template

When you create an agent without specifying a custom template, Julep uses this default template:

{%- if agent.name -%}
You are {{agent.name}}.{{" "}}
{%- endif -%}

{%- if agent.about -%}
About you: {{agent.about}}.{{" "}}
{%- endif -%}

{%- if user.name -%}
You are talking to {{user.name}}.{{" "}}
{%- endif -%}

{%- if user.about -%}
About the user: {{user.about}}.{{" "}}
{%- endif -%}

{{agent.instructions}}

{%- if tools -%}
You have access to these tools:
{%- for tool in tools -%}
{%- if tool.type == "function" -%}
- {{tool.function.name}}
{%- if tool.function.description -%}: {{tool.function.description}}{%- endif -%}
{%- else -%}
- {{ 0/0 }} {# Error: Other tool types aren't supported yet #}
{%- endif -%}
{%- endfor -%}
{%- endif -%}

{%- if docs -%}
Relevant documents:
{%- for doc in docs -%}
{{doc.title}}
{%- if doc.content -%}:
<document>
{{doc.content}}
</document>
{%- endif -%}
{%- endfor -%}
{%- endif -%}

Template Variables

The following variables are available in your system templates:

Core Variables

Variable	Type	Description
`agent`	Object	The agent’s configuration and details
`agent.name`	String	The agent’s name
`agent.about`	String	Description of the agent
`agent.instructions`	Array/String	Agent’s instructions
`user`	Object	Information about the current user
`user.name`	String	The user’s name
`user.about`	String	Description of the user
`session`	Object	Current session information
`session.situation`	String	The session’s context/situation

Dynamic Variables

Variable	Type	Description
`tools`	Array	Available tools for the agent
`docs`	Array	Relevant documents from searches
`metadata`	Object	Custom metadata passed in chat requests

Creating Custom Templates

Basic Example

Here’s a simple custom template for a customer service agent:

agent = client.agents.create(
    name="Customer Support Agent",
    model="gpt-4",
    about="A helpful customer service representative",
    instructions=[
        "Be polite and professional",
        "Always offer to help further"
    ],
    default_system_template="""
You are {{agent.name}}, a customer service representative.

{%- if metadata.priority == "high" -%}
⚠️ HIGH PRIORITY CUSTOMER - Provide expedited service
{%- endif -%}

{%- if metadata.customer_tier == "premium" -%}
Premium customer - Offer enhanced support options
{%- endif -%}

Your guidelines:
{{agent.instructions}}

{%- if user.name -%}
Customer name: {{user.name}}
{%- endif -%}
"""
)

Advanced Example with Conditional Logic

template = """
{%- if agent.name -%}
You are {{agent.name}}.
{%- endif -%}

{# Mood-based personality adjustment #}
{%- if metadata.mood == "friendly" -%}
Be warm, conversational, and use a friendly tone.
{%- elif metadata.mood == "professional" -%}
Maintain a formal, business-appropriate tone.
{%- elif metadata.mood == "playful" -%}
Feel free to be creative and add appropriate humor.
{%- else -%}
Respond in a balanced, helpful manner.
{%- endif -%}

{# Language preferences #}
{%- if metadata.language -%}
Respond in {{metadata.language}}.
{%- endif -%}

{# Expertise areas #}
{%- if metadata.expertise -%}
You are an expert in:
{%- for skill in metadata.expertise -%}
- {{skill}}
{%- endfor -%}
{%- endif -%}

{# Include instructions #}
{{agent.instructions}}

{# Tool availability #}
{%- if tools -%}
Available tools:
{%- for tool in tools -%}
- {{tool.function.name}}: {{tool.function.description}}
{%- endfor -%}
{%- endif -%}
"""

# Using the template with metadata
response = client.sessions.chat(
    session_id=session.id,
    messages=[
        {"role": "user", "content": "Help me with Python"}
    ],
    metadata={
        "mood": "friendly",
        "language": "English",
        "expertise": ["Python", "Machine Learning", "Data Science"]
    }
)

Using Chat Metadata

The metadata field in chat requests allows you to pass dynamic variables that can be used in your system templates. This enables message-level customization without modifying the agent or session.

Example: Dynamic Instructions

# Create an agent with a metadata-aware template
agent = client.agents.create(
    name="Adaptive Assistant",
    default_system_template="""
You are {{agent.name}}.

{%- if metadata.instructions -%}
Special instructions for this conversation:
{{metadata.instructions}}
{%- endif -%}

{%- if metadata.constraints -%}
Important constraints:
{%- for constraint in metadata.constraints -%}
- {{constraint}}
{%- endfor -%}
{%- endif -%}
"""
)

# Use metadata to modify behavior per message
response = client.sessions.chat(
    session_id=session.id,
    messages=[{"role": "user", "content": "Write a story"}],
    metadata={
        "instructions": "Write in the style of Edgar Allan Poe",
        "constraints": [
            "Keep it under 200 words",
            "Include a raven",
            "End with a twist"
        ]
    }
)

Session vs Agent Templates

You can override an agent’s default template at the session level:

# Agent with default template
agent = client.agents.create(
    name="Multi-purpose Assistant",
    default_system_template="You are a helpful assistant."
)

# Session with custom template
session = client.sessions.create(
    agent_id=agent.id,
    system_template="""
You are a technical writing assistant.
Focus on clarity, accuracy, and proper documentation structure.
{%- if metadata.doc_type -%}
You are writing a {{metadata.doc_type}}.
{%- endif -%}
"""
)

Use session templates when you need different behavior for the same agent in different contexts (e.g., customer service vs internal support).

Jinja2 Features

System templates support the full range of Jinja2 features:

Conditionals

{%- if user.subscription_level == "premium" -%}
You have access to advanced features.
{%- elif user.subscription_level == "basic" -%}
Some features may be limited.
{%- else -%}
Welcome! Consider upgrading for more features.
{%- endif -%}

Loops

{%- if metadata.topics -%}
Focus on these topics:
{%- for topic in metadata.topics -%}
- {{topic}}
{%- endfor -%}
{%- endif -%}

Filters

Agent name in uppercase: {{agent.name|upper}}
Word count limit: {{metadata.word_limit|default(500)}}

Comments

{# This is a comment and won't appear in the output #}

Best Practices

1. Keep Templates Focused

2. Use Meaningful Variable Names

3. Provide Fallbacks

4. Test Template Rendering

Common Patterns

Multi-language Support

{%- if metadata.language == "es" -%}
Eres un asistente útil. Responde en español.
{%- elif metadata.language == "fr" -%}
Vous êtes un assistant utile. Répondez en français.
{%- else -%}
You are a helpful assistant. Respond in English.
{%- endif -%}

Role-based Access

{%- if metadata.user_role == "admin" -%}
You have full access to all operations and sensitive information.
{%- elif metadata.user_role == "user" -%}
Provide general assistance. Do not share sensitive information.
{%- endif -%}

Context-aware Behavior

{%- if metadata.context == "code_review" -%}
Focus on code quality, security issues, and best practices.
{%- elif metadata.context == "debugging" -%}
Help identify and fix issues. Ask clarifying questions.
{%- elif metadata.context == "learning" -%}
Explain concepts clearly with examples. Be patient and thorough.
{%- endif -%}

Debugging Templates

To debug template rendering issues:

Check Variable Availability: Ensure all referenced variables exist
Validate Jinja2 Syntax: Use a Jinja2 linter or validator
Test Incrementally: Add template features one at a time
Use the Render Endpoint: Test template rendering without making chat requests

# Test template rendering
render_result = client.sessions.render(
    session_id=session.id,
    messages=[{"role": "user", "content": "Test"}],
    metadata={"test_var": "test_value"}
)

# Inspect the rendered system message
print(render_result.messages[0]["content"])

Agents - Learn more about agent configuration
Sessions - Understand session management
Tasks - Create complex workflows with templates
Tool Integration - Add tools referenced in templates

System templates are rendered server-side before being sent to the language model. This ensures security and consistency across all API clients.

​Overview

​Template Hierarchy

​Default System Template

​Template Variables

​Core Variables

​Dynamic Variables

​Creating Custom Templates

​Basic Example

​Advanced Example with Conditional Logic

​Using Chat Metadata

​Example: Dynamic Instructions

​Session vs Agent Templates

​Jinja2 Features

​Conditionals

​Loops

​Filters

​Comments

​Best Practices

​Common Patterns

​Multi-language Support

​Role-based Access

​Context-aware Behavior

​Debugging Templates

​Related Topics

Overview

Template Hierarchy

Default System Template

Template Variables

Core Variables

Dynamic Variables

Creating Custom Templates

Basic Example

Advanced Example with Conditional Logic

Using Chat Metadata

Example: Dynamic Instructions

Session vs Agent Templates

Jinja2 Features

Conditionals

Loops

Filters

Comments

Best Practices

Common Patterns

Multi-language Support

Role-based Access

Context-aware Behavior

Debugging Templates

Related Topics