Getting Started - PromptYap Documentation

Welcome to PromptYap

PromptYap is designed to make AI prompt management simple and powerful. In this guide, you'll learn how to create your first Yap (variable) and use it in a prompt.

What You'll Learn

How to create and manage Yaps (dynamic variables)
Writing prompts that use Yap variables
Running prompts with different AI providers
Understanding Sacred Yaps for sequences

Prerequisites

Before you begin, make sure you have:

A PromptYap account (sign up if you haven't already)
At least one AI provider configured (OpenAI, Anthropic, Google, etc.)
Basic understanding of AI prompts and language models

AI Provider Setup Required

You'll need to configure at least one AI provider to run prompts. Check out our AI Providers guide for setup instructions.

Step 1: Create Your First Yap

Yaps are reusable variables that you can insert into any prompt. Let's create your first one:

1. Navigate to Yaps

Go to the Yaps page in your dashboard.

2. Click "Create a Yap"

Click the blue "Create a Yap" button to open the creation form.

3. Fill in the Details

Enter the following information for your first Yap:

Example Yap

Shorthand: company_name
Content: Acme Corporation
Description: Our company name for use in marketing materials

4. Save Your Yap

Click "Create Yap" to save it. You'll now see it in your Yaps list.

Yap Naming Best Practices

Use descriptive, lowercase names with underscores
Keep shorthands concise but meaningful
Group related Yaps with prefixes (e.g., "company_name", "company_address")

Step 2: Create Your First Prompt

Now let's create a prompt that uses your Yap variable:

1. Navigate to Prompts

Go to the Prompts page in your dashboard.

2. Create a New Prompt

Click "Create a Prompt" and fill in the details:

Example Prompt

Title: Company Introduction Email
Content: Write a professional email introducing {{ yap = company_name }} to potential clients. 
The email should highlight our innovative solutions and commitment to excellence. 
Keep the tone professional but friendly, and include a clear call-to-action.

3. Understanding Yap Syntax

The syntax {{ yap = company_name }} tells PromptYap to replace this with the content of your "company_name" Yap.

Yap Validation

PromptYap will automatically validate that all Yaps referenced in your prompt exist. If a Yap is missing, you'll see a warning before running the prompt.

Step 3: Run Your First Prompt

Now let's run your prompt and see the magic happen:

1. Select an AI Model

Choose an AI provider and model from the dropdown. Popular choices include:

OpenAI GPT-4 or GPT-3.5
Anthropic Claude
Google Gemini

2. Click "Run Prompt"

PromptYap will:

Replace {{ yap = company_name }} with "Acme Corporation"
Send the processed prompt to your chosen AI model
Display the AI's response

3. View the Results

You'll see both the processed prompt (with Yaps replaced) and the AI's response.

Congratulations!

You've successfully created and run your first PromptYap prompt with dynamic variables!

Next Steps

Now that you understand the basics, here's what to explore next:

Advanced Yaps

Learn about Sacred Yaps, validation, and best practices for organizing your variables.

Explore Yaps Documentation →

Prompt Management

Discover advanced prompt features, testing, and debugging techniques.

Learn About Prompts →

Workflow Sequences

Chain multiple prompts together and use Sacred Yaps to reference previous outputs.

Build Sequences →

AI Provider Setup

Configure additional AI providers and understand their capabilities.

Setup Providers →

Common Issues

Yap Not Found Error

If you see "Yap not found" errors, check that:

The Yap shorthand is spelled correctly
The Yap exists in your account
You're using the correct syntax: {{ yap = shorthand }}

AI Provider Errors

If prompts fail to run, verify:

Your AI provider API keys are configured correctly
You have sufficient credits/quota with the provider
The selected model is available

← Back to Documentation Next: Yaps Overview →