Example Projects and Tasks

Relevant source files

• docs/bulk-actions.mdx
• docs/docs.json
• docs/guides/ai-agents/claude-code-trigger.mdx
• docs/guides/ai-agents/overview.mdx
• docs/guides/example-projects/claude-changelog-generator.mdx
• docs/guides/example-projects/claude-github-wiki.mdx
• docs/guides/example-projects/mastra-agents-with-memory.mdx
• docs/guides/example-projects/openai-agent-sdk-guardrails.mdx
• docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx
• docs/guides/example-projects/product-image-generator.mdx
• docs/guides/example-projects/realtime-fal-ai.mdx
• docs/guides/examples/fal-ai-image-to-cartoon.mdx
• docs/guides/examples/fal-ai-realtime.mdx
• docs/guides/examples/replicate-image-generation.mdx
• docs/guides/examples/scrape-hacker-news.mdx
• docs/guides/introduction.mdx
• docs/introduction.mdx
• docs/replaying.mdx
• docs/snippets/web-scraping-warning.mdx
• docs/video-walkthrough.mdx

Purpose and Scope

This page documents the example projects and tasks that form a key part of the Trigger.dev documentation system. These examples serve as practical, working demonstrations of how to use Trigger.dev features and integrate with external services. The examples are divided into two categories: Example Tasks (copyable code snippets) and Example Projects (full applications with GitHub repositories).

For information about the overall documentation structure and navigation, see Documentation Structure. For details about integration patterns with AI agents and external services, see Integration Patterns.

Documentation Organization

The examples are organized within the Mintlify documentation system through the docs/docs.json configuration file. The navigation structure includes:

Guides & examples dropdown
├── Introduction (guides/introduction.mdx)
├── Frameworks/
├── Guides/
│   └── AI Agents/
├── Use cases/
├── Example projects/
├── Python guides/
├── Example tasks/
└── Migration guides/

Example projects navigation (docs/docs.json349-366):

• Full applications with GitHub repositories
• Organized by complexity and feature set
• Include topics: web scraping, AI agents, realtime updates, Python integration

Example tasks navigation (docs/docs.json379-404):

• Individual code snippets for specific integrations
• Categorized by service (FFmpeg, Fal.ai, Puppeteer, etc.)
• Designed for copy-paste into user projects

Sources: docs/docs.json269-420 docs/guides/introduction.mdx1-104

Example Categories

Example Tasks vs Example Projects

Example Tasks are lightweight, focused demonstrations:

• Single task file with inline code (docs/guides/examples/fal-ai-image-to-cartoon.mdx32-102)
• Typically 50-200 lines of code
• Demonstrate specific integrations (Fal.ai, FFmpeg, Puppeteer, etc.)
• Include prerequisites, environment variables, and test payload
• No external repository required

Example Projects are comprehensive applications:

• Full project structure with GitHub repository link
• Frontend and backend integration
• Demonstrate complex workflows and patterns
• Include deployment considerations
• Examples: claude-changelog-generator realtime-fal-ai mastra-agents

Sources: docs/guides/introduction.mdx47-98 docs/guides/examples/fal-ai-image-to-cartoon.mdx1-112 docs/guides/example-projects/realtime-fal-ai.mdx1-44

Example Task Structure

Standard Task Documentation Pattern

Each example task follows a consistent structure:

Section	Purpose	File Reference
Title & Description	Explains what the task does	docs/guides/examples/scrape-hacker-news.mdx1-5
Video Walkthrough	YouTube embed showing implementation	docs/guides/examples/scrape-hacker-news.mdx10-18
Overview	Lists features and tools used	docs/guides/examples/scrape-hacker-news.mdx20-37
Prerequisites	Required accounts and setup	docs/guides/examples/scrape-hacker-news.mdx40-46
Build Configuration	trigger.config.ts setup	docs/guides/examples/scrape-hacker-news.mdx50-64
Environment Variables	Required API keys	docs/guides/examples/scrape-hacker-news.mdx68-76
Task Code	Complete implementation	docs/guides/examples/scrape-hacker-news.mdx80-211
Testing Instructions	How to run and test	docs/guides/examples/scrape-hacker-news.mdx250-253

Sources: docs/guides/examples/scrape-hacker-news.mdx1-253 docs/guides/examples/fal-ai-image-to-cartoon.mdx1-112

Common Task Patterns

Scraping and Data Collection (docs/guides/examples/scrape-hacker-news.mdx):

• Uses Puppeteer with BrowserBase proxy
• Demonstrates scheduled tasks with schedules.task()
• Shows batch triggering with batchTriggerAndWait()
• Includes retry configuration and idempotency
• Example: Scrape Hacker News → Summarize with OpenAI → Send via Resend

AI Image Generation (docs/guides/examples/fal-ai-image-to-cartoon.mdx):

• Integrates with Fal.ai for image processing
• Demonstrates progress tracking with onQueueUpdate
• Uploads results to Cloudflare R2
• Uses schema validation with Zod

Scheduled Workflows (docs/guides/examples/scrape-hacker-news.mdx92-148):

Sources: docs/guides/examples/scrape-hacker-news.mdx80-211 docs/guides/examples/fal-ai-image-to-cartoon.mdx28-112 packages/trigger-sdk/src/v3/schedules/index.ts64-91

Example Project Structure

Full Project Documentation Pattern

Example projects include comprehensive documentation with:

GitHub Repository Links - All projects link to triggerdotdev/examples repository:

Relevant Code Table - Maps features to specific files (docs/guides/example-projects/claude-github-wiki.mdx58-63):

File	Description
trigger/analyze-repo.ts	Main task that clones repo, runs Claude agent
trigger/agent-stream.ts	Typed stream definition for real-time
app/api/analyze-repo/route.ts	API endpoint that triggers task
app/response/[runId]/page.tsx	Real-time streaming display

Configuration Highlights - Special setup requirements (docs/guides/example-projects/claude-github-wiki.mdx67-82):

Sources: docs/guides/example-projects/realtime-fal-ai.mdx1-44 docs/guides/example-projects/claude-github-wiki.mdx1-94 docs/guides/example-projects/mastra-agents-with-memory.mdx1-93

AI Agent Examples

Agent Example Categories

The documentation organizes AI agent examples into two categories:

Agent Fundamentals (docs/guides/ai-agents/overview.mdx64-100) - Basic patterns from Anthropic's "building effective agents" research:

• Prompt chaining: Sequential prompts for complex tasks
• Routing: Direct queries to appropriate models
• Parallelization: Run multiple agents simultaneously
• Orchestrator-workers: Coordinate specialized agents
• Evaluator-optimizer: Iterative improvement with feedback

SDK Integrations (docs/guides/ai-agents/overview.mdx7-62) - Production agent frameworks:

• Claude Agent SDK: File system access, code editing
• OpenAI Agents SDK (TypeScript): 7 patterns including handoffs
• OpenAI Agents SDK (Python): Guardrails implementation
• Mastra: Memory sharing between agents

Sources: docs/guides/ai-agents/overview.mdx1-101 docs/guides/introduction.mdx24-43

Claude Agent SDK Projects

claude-changelog-generator (docs/guides/example-projects/claude-changelog-generator.mdx):

• Custom MCP tools: list_commits, get_commit_diff
• Two-phase analysis: list all commits, selectively fetch diffs
• Real-time streaming with trigger/changelog-stream.ts
• Live metadata updates for observability

claude-github-wiki (docs/guides/example-projects/claude-github-wiki.mdx):

• Tools: Grep and Read for codebase exploration
• Shallow git clone (depth=1) for performance
• Cancellation support with cleanup
• Progress tracking via run metadata

Both require special configuration (docs/guides/ai-agents/claude-code-trigger.mdx28-46):

Sources: docs/guides/example-projects/claude-changelog-generator.mdx1-96 docs/guides/example-projects/claude-github-wiki.mdx1-94 docs/guides/ai-agents/claude-code-trigger.mdx1-211

OpenAI Agents SDK Examples

TypeScript Playground (docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx) - 7 production patterns:

Pattern	File	Key Feature
Basic Chat	basicAgentChat.ts	Strategic model selection (GPT-4, o1-preview, o1-mini)
With Tools	agentWithTools.ts	Weather data with Zod validation
Streaming	streamingAgent.ts	Real-time progress tracking
Handoffs	agentHandoff.ts	Multi-agent delegation
Parallel	parallelAgents.ts	batch.triggerByTaskAndWait for concurrent execution
Scheduled	scheduledAgent.ts	Cron-based monitoring every 6 hours
Guardrails	agentWithGuardrails.ts	Input classification and validation

Python Guardrails (docs/guides/example-projects/openai-agent-sdk-guardrails.mdx) - Three guardrail types:

1. Input Guardrails (input-guardrails.py):

   • @input_guardrail decorator validates user input
   • Example: Math tutor only responds to math questions

2. Output Guardrails (output-guardrails.py):

   • @output_guardrail decorator validates generated responses
   • Uses separate guardrail agent for checking

3. Streaming Guardrails (streaming-guardrails.py):

   • Processes ResponseTextDeltaEvent streams
   • Async checks at configurable intervals
   • Example: Stops if language too complex for 10-year-old

Sources: docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx1-65 docs/guides/example-projects/openai-agent-sdk-guardrails.mdx1-61

Mastra Integration

mastra-agents-with-memory (docs/guides/example-projects/mastra-agents-with-memory.mdx) demonstrates multi-agent memory sharing:

Architecture Pattern:

Key Features (docs/guides/example-projects/mastra-agents-with-memory.mdx36-44):

• Centralized PostgreSQL storage prevents duplicate connections
• Sequential agent execution with triggerAndWait
• Weather analyst writes to working memory
• Clothing advisor reads from working memory
• Custom Mastra tool with Zod validation

Project Structure (docs/guides/example-projects/mastra-agents-with-memory.mdx45-60):

src/
├── mastra/
│   ├── agents/
│   │   ├── weather-analyst.ts
│   │   ├── clothing-advisor.ts
│   ├── tools/weather-tool.ts
│   ├── schemas/weather-data.ts
│   └── index.ts
├── trigger/weather-task.ts

Sources: docs/guides/example-projects/mastra-agents-with-memory.mdx1-93

Realtime Integration Examples

Example Projects with Realtime Streaming

realtime-fal-ai (docs/guides/example-projects/realtime-fal-ai.mdx) demonstrates frontend streaming:

Components:

• Task: trigger/realtime-generate-image.ts - Generates image with Fal.ai
• Trigger: app/api/process-image.ts - Server action triggers task
• Display: app/processing/[id]/ProcessingContent.tsx - Real-time progress with error handling
• Form: app/page.tsx - User input submission

Task Implementation (docs/guides/examples/fal-ai-realtime.mdx42-78):

The frontend uses React hooks to display progress, handle errors, and show completion status in real-time.

Sources: docs/guides/example-projects/realtime-fal-ai.mdx1-44 docs/guides/examples/fal-ai-realtime.mdx1-90

Python Integration Examples

Python Build Extension Usage

Python examples use the pythonExtension() build configuration to execute Python scripts from tasks:

Configuration (docs/guides/example-projects/openai-agent-sdk-guardrails.mdx54):

Task Pattern (docs/guides/example-projects/openai-agent-sdk-guardrails.mdx42-44):

• TypeScript task invokes Python script
• Passes arguments as command-line parameters
• Parses JSON output from Python
• Handles exceptions like InputGuardrailTripwireTriggered

Example Projects:

• openai-agent-sdk-guardrails - Guardrails system
• python-crawl4ai - Headless web crawler
• python-image-processing - Pillow image processing
• python-doc-to-markdown - MarkItDown document conversion
• python-pdf-form-extractor - PyMuPDF data extraction

Sources: docs/guides/example-projects/openai-agent-sdk-guardrails.mdx1-61 docs/introduction.mdx92-106

Common Integration Patterns

External Service Integration

AI Service Integrations - Common patterns:

• API key in environment variables
• Schema validation with Zod
• Progress tracking with onQueueUpdate callbacks
• Retry configuration for API failures

Media Processing - Requires build extensions:

• Puppeteer: puppeteer() extension (docs/guides/examples/scrape-hacker-news.mdx50-64)
• FFmpeg: ffmpeg() extension
• Python: pythonExtension() for Pillow, PyMuPDF

Storage Integration - Cloudflare R2 via S3 SDK:

Sources: docs/guides/examples/scrape-hacker-news.mdx1-253 docs/guides/examples/fal-ai-image-to-cartoon.mdx28-102 docs/introduction.mdx108-178

Documentation Maintenance

Example File Organization

The examples follow a strict file naming and organization convention:

Example Tasks Location:

docs/guides/examples/
├── dall-e3-generate-image.mdx
├── fal-ai-image-to-cartoon.mdx
├── fal-ai-realtime.mdx
├── ffmpeg-video-processing.mdx
├── puppeteer.mdx
├── scrape-hacker-news.mdx
└── [service-name-action].mdx

Example Projects Location:

docs/guides/example-projects/
├── anchor-browser-web-scraper.mdx
├── claude-changelog-generator.mdx
├── claude-github-wiki.mdx
├── mastra-agents-with-memory.mdx
├── openai-agents-sdk-typescript-playground.mdx
└── [project-description].mdx

Navigation Registration (docs/docs.json349-404):

• Projects listed under "group": "Example projects"
• Tasks listed under "group": "Example tasks"
• Maintained in docs.json navigation array

Sources: docs/docs.json349-404 docs/guides/introduction.mdx47-98

Testing and Video Content

Video Walkthroughs - Embedded YouTube iframes:

Test Instructions - Consistent pattern:

1. Navigate to dashboard Test page
2. Provide example JSON payload
3. Click "Run test" button
4. View results in run detail page

Warning Notices - Special cases like web scraping (docs/snippets/web-scraping-warning.mdx):

Sources: docs/guides/examples/scrape-hacker-news.mdx10-18 docs/guides/examples/fal-ai-realtime.mdx22-30 docs/snippets/web-scraping-warning.mdx1-3

Reference Tables

Example Task Summary

Category	Example	Key Features	Build Extension
AI Image	DALL·E 3	GPT-4o + DALL·E 3	None
AI Image	Fal.ai cartoon	Image-to-image, R2 upload	None
Media	FFmpeg	Video processing, R2 storage	ffmpeg()
Media	PDF to image	MuPDF conversion	None
Scraping	Hacker News	BrowserBase, batch triggers	puppeteer()
Scraping	Puppeteer	PDF generation, scraping	puppeteer()
Email	Resend sequence	Multi-day email workflow	None
Email	React Email	Template rendering	None

Example Project Summary

Project	Framework	Key Technologies	Patterns
realtime-fal-ai	Next.js	Fal.ai, React hooks	Realtime streaming
claude-github-wiki	Next.js	Claude Agent SDK	Tool usage, cancellation
claude-changelog-generator	Next.js	Claude, Octokit	Custom MCP tools
mastra-agents-with-memory	Node.js	Mastra, PostgreSQL	Memory sharing
openai-agents-sdk-typescript-playground	Node.js	OpenAI Agents SDK	7 agent patterns
openai-agent-sdk-guardrails	Node.js	Python, OpenAI	Guardrails system

Sources: docs/guides/introduction.mdx47-98 docs/docs.json349-404