Recipe Examples
10 beginner-friendly, real-world recipe creation examples with step-by-step guides
Recipe Examples
This section provides 10 beginner-friendly, real-world recipe examples designed for Recipe Authors. Each example is a complete, end-to-end tutorial covering creation, testing, local usage, and deployment across all six integration models.
Personas
Role: Design, build, test, and document recipes that solve real-world problems for App Developers and end users.
Primary Goals: – Create effective recipes that solve specific problems – Design clear interfaces with well-defined inputs/outputs – Write comprehensive tests for reliability – Document thoroughly for easy adoption
Typical Workflow: Define problem → Create structure → Implement → Test → Document → Release
App DeveloperRole: Consume recipes reliably and ship to production.
Focus Areas: – Safe defaults and predictable outputs – Easy integration patterns – Deployment flexibility – Error handling and recovery
Key Concern: “How do I integrate this recipe into my app quickly and safely?”
Integration Models Overview
PraisonAI recipes can be consumed via six integration models. Each example in this section demonstrates all six.
Quick Comparison
| Model | Latency | Best For | Language |
|---|---|---|---|
| 1. Embedded SDK | Lowest | Python apps, notebooks | Python |
| 2. CLI Invocation | Low | Scripts, CI/CD | Any |
| 3. Plugin Mode | Low | IDE/CMS extensions | Any |
| 4. Local HTTP Sidecar | Medium | Microservices, polyglot | Any |
| 5. Remote Managed Runner | Medium | Multi-tenant, cloud | Any |
| 6. Event-Driven | Variable | Async workflows, batch | Any |
Decision Guide
Feature Matrix
| Feature | SDK | CLI | Plugin | Sidecar | Remote | Event |
|---|---|---|---|---|---|---|
| Streaming | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| Multi-tenant | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |
| Auth built-in | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ |
| Async native | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
| Process isolation | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Hot reload | ❌ | ✅ | ✅ | ✅ | ✅ | ❌ |
Recipe Discovery Paths
Recipes are discovered from these directories in order of precedence:
| Priority | Path | Description |
|---|---|---|
| 1 | ~/.praisonai/templates/ | User-local recipes |
| 2 | ~/.config/praisonai/templates/ | XDG config location |
| 3 | ./.praisonai/templates/ | Project-local recipes |
| 4 | Built-in Agent-Recipes | Bundled recipes |
Examples
Generate captions from video files with language detection and multiple output formats (SRT/VTT).
Podcast Transcription CleanerTranscribe audio with speaker labels and intelligent cleanup for podcast content.
Multilingual Subtitle TranslatorTranslate subtitle files while preserving timestamps and formatting.
Voice-to-Voice Translator LiteTranslate spoken audio to another language with optional TTS output.
YouTube Chapter GeneratorGenerate YouTube chapters from transcripts with timestamps and descriptions.
Product Photo Alt Text WriterGenerate accessible alt text and tags for product images.
Customer Support Reply DrafterDraft professional support replies with configurable tone and confidence scoring.
Meeting Minutes Action ItemsExtract action items and generate structured meeting minutes from transcripts.
Document Summarizer with CitationsSummarize documents with proper citations and key point extraction.
Video Highlights Reel PlannerPlan video highlight clips from transcripts without heavy video editing.
Recipe Author Workflow
- Define the Problem
Identify the task to automate, target user, and expected inputs/outputs.
- Create Recipe Structure
Initialize the recipe directory with
TEMPLATE.yaml,recipe.py, andREADME.md. - Implement the Recipe
Write the
run()function with proper input validation and error handling. - Write Tests
Create unit tests and integration tests with proper markers.
- Document
Write comprehensive README with examples, inputs/outputs tables, and troubleshooting.
- Release
Complete the release checklist and publish to your chosen distribution method.
Quick Start
Create your first recipe in under 5 minutes:
# Create recipe directory
mkdir -p ~/.praisonai/templates/my-first-recipe
cd ~/.praisonai/templates/my-first-recipe
# Create the required files
touch TEMPLATE.yaml recipe.py README.md test_recipe.pyThen follow any of the 10 examples in this section for a complete walkthrough.
Next Steps
- Video Caption Generator – Start with this beginner-friendly example
- Integration Models – Deep dive into each integration model
- Recipe Author Persona – Complete author reference
- App Developer Persona – Understand your users