Skip to main content

​
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

Recipe Author

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 Developer

Role: 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

ModelLatencyBest ForLanguage
1. Embedded SDKLowestPython apps, notebooksPython
2. CLI InvocationLowScripts, CI/CDAny
3. Plugin ModeLowIDE/CMS extensionsAny
4. Local HTTP SidecarMediumMicroservices, polyglotAny
5. Remote Managed RunnerMediumMulti-tenant, cloudAny
6. Event-DrivenVariableAsync workflows, batchAny

​
Decision Guide

​
Feature Matrix

FeatureSDKCLIPluginSidecarRemoteEvent
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:
PriorityPathDescription
1~/.praisonai/templates/User-local recipes
2~/.config/praisonai/templates/XDG config location
3./.praisonai/templates/Project-local recipes
4Built-in Agent-RecipesBundled recipes

​
Examples

Video Caption Generator

Generate captions from video files with language detection and multiple output formats (SRT/VTT).

Podcast Transcription Cleaner

Transcribe audio with speaker labels and intelligent cleanup for podcast content.

Multilingual Subtitle Translator

Translate subtitle files while preserving timestamps and formatting.

Voice-to-Voice Translator Lite

Translate spoken audio to another language with optional TTS output.

YouTube Chapter Generator

Generate YouTube chapters from transcripts with timestamps and descriptions.

Product Photo Alt Text Writer

Generate accessible alt text and tags for product images.

Customer Support Reply Drafter

Draft professional support replies with configurable tone and confidence scoring.

Meeting Minutes Action Items

Extract action items and generate structured meeting minutes from transcripts.

Document Summarizer with Citations

Summarize documents with proper citations and key point extraction.

Video Highlights Reel Planner

Plan video highlight clips from transcripts without heavy video editing.

​
Recipe Author Workflow

1

Define the Problem

Identify the task to automate, target user, and expected inputs/outputs.
2

Create Recipe Structure

Initialize the recipe directory with TEMPLATE.yaml, recipe.py, and README.md.
3

Implement the Recipe

Write the run() function with proper input validation and error handling.
4

Write Tests

Create unit tests and integration tests with proper markers.
5

Document

Write comprehensive README with examples, inputs/outputs tables, and troubleshooting.
6

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.py
Then follow any of the 10 examples in this section for a complete walkthrough.

​
Next Steps