Dan
f685c6637d
* Added mastra agent docs * Added links in the ai agents section * Caught typos all thanks to coderabbit. Thanks coderabbit
581 lines
18 KiB
JSON
581 lines
18 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"theme": "maple",
|
|
"name": "Trigger.dev",
|
|
"description": "Trigger.dev is an open source background jobs framework that lets you write reliable workflows in plain async code. Run long-running AI tasks, handle complex background jobs, and build AI agents with built-in queuing, automatic retries, and real-time monitoring. No timeouts, elastic scaling, and zero infrastructure management required.",
|
|
"colors": {
|
|
"primary": "#A8FF53",
|
|
"light": "#A8FF53",
|
|
"dark": "#A8FF53"
|
|
},
|
|
"favicon": "/images/favicon.png",
|
|
"contextual": {
|
|
"options": ["copy", "view", "claude"]
|
|
},
|
|
"navigation": {
|
|
"dropdowns": [
|
|
{
|
|
"dropdown": "Documentation",
|
|
"description": "Resources for Trigger.dev",
|
|
"icon": "book-open",
|
|
"groups": [
|
|
{
|
|
"group": "Getting started",
|
|
"pages": [
|
|
"introduction",
|
|
"quick-start",
|
|
"video-walkthrough",
|
|
"how-it-works",
|
|
"limits",
|
|
"upgrade-to-v4"
|
|
]
|
|
},
|
|
{
|
|
"group": "Fundamentals",
|
|
"pages": [
|
|
{
|
|
"group": "Tasks",
|
|
"pages": ["tasks/overview", "tasks/schemaTask", "tasks/scheduled"]
|
|
},
|
|
"triggering",
|
|
"runs",
|
|
"apikeys"
|
|
]
|
|
},
|
|
{
|
|
"group": "Writing tasks",
|
|
"pages": [
|
|
"writing-tasks-introduction",
|
|
"logging",
|
|
"errors-retrying",
|
|
{
|
|
"group": "Wait",
|
|
"pages": ["wait", "wait-for", "wait-until", "wait-for-token"]
|
|
},
|
|
"queue-concurrency",
|
|
"versioning",
|
|
"machines",
|
|
"idempotency",
|
|
"runs/max-duration",
|
|
"tags",
|
|
"runs/metadata",
|
|
"run-usage",
|
|
"context"
|
|
]
|
|
},
|
|
{
|
|
"group": "Configuration",
|
|
"pages": [
|
|
"config/config-file",
|
|
{
|
|
"group": "Build extensions",
|
|
"pages": [
|
|
"config/extensions/overview",
|
|
{
|
|
"group": "Built-in extensions",
|
|
"pages": [
|
|
"config/extensions/prismaExtension",
|
|
"config/extensions/pythonExtension",
|
|
"config/extensions/playwright",
|
|
"config/extensions/puppeteer",
|
|
"config/extensions/ffmpeg",
|
|
"config/extensions/aptGet",
|
|
"config/extensions/additionalFiles",
|
|
"config/extensions/additionalPackages",
|
|
"config/extensions/syncEnvVars",
|
|
"config/extensions/esbuildPlugin",
|
|
"config/extensions/emitDecoratorMetadata",
|
|
"config/extensions/audioWaveform"
|
|
]
|
|
},
|
|
"config/extensions/custom"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Development",
|
|
"pages": ["cli-dev"]
|
|
},
|
|
{
|
|
"group": "Deployment",
|
|
"pages": [
|
|
"deployment/overview",
|
|
"deploy-environment-variables",
|
|
"github-actions",
|
|
"deployment/preview-branches",
|
|
"deployment/atomic-deployment",
|
|
{
|
|
"group": "Deployment integrations",
|
|
"pages": ["vercel-integration"]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Frontend usage",
|
|
"pages": [
|
|
"frontend/overview",
|
|
{
|
|
"group": "React hooks",
|
|
"pages": [
|
|
"frontend/react-hooks/overview",
|
|
"frontend/react-hooks/realtime",
|
|
"frontend/react-hooks/triggering"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Realtime API",
|
|
"pages": [
|
|
"realtime/overview",
|
|
"realtime/streams",
|
|
"realtime/react-hooks",
|
|
"realtime/subscribe-to-run",
|
|
"realtime/subscribe-to-runs-with-tag",
|
|
"realtime/subscribe-to-batch"
|
|
]
|
|
},
|
|
{
|
|
"group": "CLI",
|
|
"pages": [
|
|
"cli-introduction",
|
|
{
|
|
"group": "Commands",
|
|
"pages": [
|
|
"cli-deploy-commands",
|
|
"cli-dev-commands",
|
|
"cli-init-commands",
|
|
"cli-list-profiles-commands",
|
|
"cli-login-commands",
|
|
"cli-logout-commands",
|
|
"cli-preview-archive",
|
|
"cli-promote-commands",
|
|
"cli-switch",
|
|
"cli-update-commands",
|
|
"cli-whoami-commands"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Using the Dashboard",
|
|
"pages": ["run-tests", "troubleshooting-alerts", "replaying", "bulk-actions"]
|
|
},
|
|
{
|
|
"group": "Troubleshooting",
|
|
"pages": [
|
|
"troubleshooting",
|
|
"troubleshooting-debugging-in-vscode",
|
|
"upgrading-packages",
|
|
"troubleshooting-uptime-status",
|
|
"troubleshooting-github-issues",
|
|
"request-feature"
|
|
]
|
|
},
|
|
{
|
|
"group": "Self-hosting",
|
|
"pages": [
|
|
"self-hosting/overview",
|
|
"self-hosting/docker",
|
|
"self-hosting/kubernetes",
|
|
{
|
|
"group": "Environment variables",
|
|
"pages": ["self-hosting/env/webapp", "self-hosting/env/supervisor"]
|
|
}
|
|
],
|
|
"tags": ["v4"],
|
|
"tag": "v4"
|
|
},
|
|
{
|
|
"group": "Self-hosting",
|
|
"pages": ["open-source-self-hosting"]
|
|
},
|
|
{
|
|
"group": "Open source",
|
|
"pages": ["open-source-contributing", "github-repo", "changelog", "roadmap"]
|
|
},
|
|
{
|
|
"group": "Help",
|
|
"pages": ["community", "help-slack", "help-email"]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"dropdown": "API reference",
|
|
"description": "The Trigger.dev API",
|
|
"icon": "code",
|
|
"groups": [
|
|
{
|
|
"group": "API reference",
|
|
"pages": [
|
|
"management/overview",
|
|
"management/authentication",
|
|
"management/errors-and-retries",
|
|
"management/auto-pagination",
|
|
"management/advanced-usage"
|
|
]
|
|
},
|
|
{
|
|
"group": "Tasks API",
|
|
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
|
|
},
|
|
{
|
|
"group": "Runs API",
|
|
"pages": [
|
|
"management/runs/list",
|
|
"management/runs/retrieve",
|
|
"management/runs/replay",
|
|
"management/runs/cancel",
|
|
"management/runs/reschedule",
|
|
"management/runs/update-metadata"
|
|
]
|
|
},
|
|
{
|
|
"group": "Schedules API",
|
|
"pages": [
|
|
"management/schedules/list",
|
|
"management/schedules/create",
|
|
"management/schedules/retrieve",
|
|
"management/schedules/update",
|
|
"management/schedules/delete",
|
|
"management/schedules/deactivate",
|
|
"management/schedules/activate",
|
|
"management/schedules/timezones"
|
|
]
|
|
},
|
|
{
|
|
"group": "Env Vars API",
|
|
"pages": [
|
|
"management/envvars/list",
|
|
"management/envvars/import",
|
|
"management/envvars/create",
|
|
"management/envvars/retrieve",
|
|
"management/envvars/update",
|
|
"management/envvars/delete"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"dropdown": "Guides & examples",
|
|
"description": "A great way to get started",
|
|
"icon": "books",
|
|
"groups": [
|
|
{
|
|
"group": "Introduction",
|
|
"pages": ["guides/introduction"]
|
|
},
|
|
{
|
|
"group": "Frameworks",
|
|
"pages": [
|
|
"guides/frameworks/bun",
|
|
"guides/frameworks/nextjs",
|
|
"guides/frameworks/nodejs",
|
|
"guides/frameworks/remix",
|
|
"guides/community/sveltekit"
|
|
]
|
|
},
|
|
{
|
|
"group": "Guides",
|
|
"pages": [
|
|
{
|
|
"group": "AI Agents",
|
|
"icon": {
|
|
"name": "microchip-ai",
|
|
"style": "regular"
|
|
},
|
|
"pages": [
|
|
"guides/ai-agents/overview",
|
|
"guides/ai-agents/generate-translate-copy",
|
|
"guides/ai-agents/route-question",
|
|
"guides/ai-agents/respond-and-check-content",
|
|
"guides/ai-agents/translate-and-refine",
|
|
"guides/ai-agents/verify-news-article"
|
|
]
|
|
},
|
|
"guides/cursor-rules",
|
|
"guides/frameworks/drizzle",
|
|
"guides/frameworks/prisma",
|
|
"guides/frameworks/sequin",
|
|
{
|
|
"group": "Supabase",
|
|
"icon": {
|
|
"name": "bolt",
|
|
"style": "solid"
|
|
},
|
|
"pages": [
|
|
"guides/frameworks/supabase-guides-overview",
|
|
"guides/frameworks/supabase-edge-functions-basic",
|
|
"guides/frameworks/supabase-edge-functions-database-webhooks",
|
|
"guides/frameworks/supabase-authentication"
|
|
]
|
|
},
|
|
{
|
|
"group": "Webhooks",
|
|
"icon": {
|
|
"name": "webhook",
|
|
"style": "solid"
|
|
},
|
|
"pages": [
|
|
"guides/frameworks/webhooks-guides-overview",
|
|
"guides/frameworks/nextjs-webhooks",
|
|
"guides/frameworks/remix-webhooks",
|
|
"guides/examples/stripe-webhook"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
|
|
{
|
|
"group": "Example projects",
|
|
"pages": [
|
|
"guides/example-projects/batch-llm-evaluator",
|
|
"guides/example-projects/claude-thinking-chatbot",
|
|
"guides/example-projects/human-in-the-loop-workflow",
|
|
"guides/example-projects/mastra-agents-with-memory",
|
|
"guides/example-projects/meme-generator-human-in-the-loop",
|
|
"guides/example-projects/openai-agent-sdk-guardrails",
|
|
"guides/example-projects/openai-agents-sdk-typescript-playground",
|
|
"guides/example-projects/realtime-csv-importer",
|
|
"guides/example-projects/realtime-fal-ai",
|
|
"guides/example-projects/turborepo-monorepo-prisma",
|
|
"guides/example-projects/vercel-ai-sdk-deep-research",
|
|
"guides/example-projects/vercel-ai-sdk-image-generator"
|
|
]
|
|
},
|
|
{
|
|
"group": "Python guides",
|
|
"pages": [
|
|
"guides/python/python-image-processing",
|
|
"guides/python/python-doc-to-markdown",
|
|
"guides/python/python-crawl4ai",
|
|
"guides/python/python-pdf-form-extractor"
|
|
]
|
|
},
|
|
{
|
|
"group": "Example tasks",
|
|
"pages": [
|
|
"guides/examples/dall-e3-generate-image",
|
|
"guides/examples/deepgram-transcribe-audio",
|
|
"guides/examples/fal-ai-image-to-cartoon",
|
|
"guides/examples/fal-ai-realtime",
|
|
"guides/examples/ffmpeg-video-processing",
|
|
"guides/examples/firecrawl-url-crawl",
|
|
"guides/examples/libreoffice-pdf-conversion",
|
|
"guides/examples/open-ai-with-retrying",
|
|
"guides/examples/pdf-to-image",
|
|
"guides/examples/puppeteer",
|
|
"guides/examples/react-pdf",
|
|
"guides/examples/react-email",
|
|
"guides/examples/resend-email-sequence",
|
|
"guides/examples/satori",
|
|
"guides/examples/scrape-hacker-news",
|
|
"guides/examples/sentry-error-tracking",
|
|
"guides/examples/sharp-image-processing",
|
|
"guides/examples/supabase-database-operations",
|
|
"guides/examples/supabase-storage-upload",
|
|
"guides/examples/vercel-ai-sdk",
|
|
"guides/examples/vercel-sync-env-vars"
|
|
]
|
|
},
|
|
{
|
|
"group": "Migration guides",
|
|
"pages": ["migration-mergent"]
|
|
},
|
|
{
|
|
"group": "Community packages",
|
|
"pages": [
|
|
"guides/community/dotenvx",
|
|
"guides/community/fatima",
|
|
"guides/community/rate-limiter",
|
|
"guides/community/sveltekit"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"logo": {
|
|
"light": "/logo/light.png",
|
|
"dark": "/logo/dark.png",
|
|
"href": "https://trigger.dev"
|
|
},
|
|
"api": {
|
|
"openapi": ["openapi.yml", "v3-openapi.yaml"],
|
|
"playground": {
|
|
"display": "simple"
|
|
}
|
|
},
|
|
"appearance": {
|
|
"default": "dark",
|
|
"strict": true
|
|
},
|
|
"background": {
|
|
"color": {
|
|
"light": "#fff",
|
|
"dark": "#121317"
|
|
}
|
|
},
|
|
"navbar": {
|
|
"primary": {
|
|
"type": "github",
|
|
"href": "https://github.com/triggerdotdev/trigger.dev"
|
|
}
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"x": "https://twitter.com/triggerdotdev",
|
|
"github": "https://github.com/triggerdotdev",
|
|
"linkedin": "https://www.linkedin.com/company/triggerdotdev"
|
|
},
|
|
"links": [
|
|
{
|
|
"header": "Developers",
|
|
"items": [
|
|
{
|
|
"label": "Changelog",
|
|
"href": "https://trigger.dev/changelog"
|
|
},
|
|
{
|
|
"label": "Contributing",
|
|
"href": "https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md"
|
|
},
|
|
{
|
|
"label": "Open source",
|
|
"href": "https://github.com/triggerdotdev/trigger.dev?tab=Apache-2.0-1-ov-file#readme"
|
|
},
|
|
{
|
|
"label": "GitHub",
|
|
"href": "https://github.com/triggerdotdev/trigger.dev"
|
|
},
|
|
{
|
|
"label": "OSS Friends",
|
|
"href": "https://trigger.dev/oss-friends"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"header": "Product",
|
|
"items": [
|
|
{
|
|
"label": "Pricing",
|
|
"href": "https://trigger.dev/pricing"
|
|
},
|
|
{
|
|
"label": "How it works",
|
|
"href": "https://trigger.dev/#how-it-works"
|
|
},
|
|
{
|
|
"label": "Features",
|
|
"href": "https://trigger.dev/product"
|
|
},
|
|
{
|
|
"label": "Roadmap",
|
|
"href": "https://feedback.trigger.dev/roadmap"
|
|
},
|
|
{
|
|
"label": "FAQs",
|
|
"href": "https://trigger.dev/pricing#faqs"
|
|
},
|
|
{
|
|
"label": "Uptime status",
|
|
"href": "https://status.trigger.dev/"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"header": "Company",
|
|
"items": [
|
|
{
|
|
"label": "Blog",
|
|
"href": "https://trigger.dev/blog"
|
|
},
|
|
{
|
|
"label": "Contact",
|
|
"href": "https://trigger.dev/contact"
|
|
},
|
|
{
|
|
"label": "Careers",
|
|
"href": "https://trigger.dev/jobs"
|
|
},
|
|
{
|
|
"label": "Privacy",
|
|
"href": "https://trigger.dev/legal/privacy"
|
|
},
|
|
{
|
|
"label": "Terms of service",
|
|
"href": "https://trigger.dev/legal"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"redirects": [
|
|
{
|
|
"source": "/v3/feature-matrix",
|
|
"destination": "https://feedback.trigger.dev/roadmap"
|
|
},
|
|
{
|
|
"source": "/v3/upgrading-from-v2",
|
|
"destination": "/guides/use-cases/upgrading-from-v2"
|
|
},
|
|
{
|
|
"source": "/v3/open-source-self-hosting",
|
|
"destination": "/open-source-self-hosting"
|
|
},
|
|
{
|
|
"source": "/v3/:slug*",
|
|
"destination": "/:slug*"
|
|
},
|
|
{
|
|
"source": "/reattempting-replaying",
|
|
"destination": "/replaying"
|
|
},
|
|
{
|
|
"source": "/tasks-overview",
|
|
"destination": "/tasks/overview"
|
|
},
|
|
{
|
|
"source": "/tasks-scheduled",
|
|
"destination": "/tasks/scheduled"
|
|
},
|
|
{
|
|
"source": "/trigger-folder",
|
|
"destination": "/config/config-file"
|
|
},
|
|
{
|
|
"source": "/trigger-config",
|
|
"destination": "/config/config-file"
|
|
},
|
|
{
|
|
"source": "/guides/frameworks/introduction",
|
|
"destination": "/guides/introduction"
|
|
},
|
|
{
|
|
"source": "/guides/examples/intro",
|
|
"destination": "/guides/introduction"
|
|
},
|
|
{
|
|
"source": "/examples/:slug*",
|
|
"destination": "/guides/examples/:slug*"
|
|
},
|
|
{
|
|
"source": "/realtime",
|
|
"destination": "/realtime/overview"
|
|
},
|
|
{
|
|
"source": "/runs-and-attempts",
|
|
"destination": "/runs"
|
|
},
|
|
{
|
|
"source": "/frontend/react-hooks",
|
|
"destination": "/frontend/react-hooks/overview"
|
|
},
|
|
{
|
|
"source": "/management/projects/runs",
|
|
"destination": "/management/overview"
|
|
}
|
|
]
|
|
}
|