Prefect llms.txt

The actual file

Source Markdown

The saved llms.txt text, displayed as source. The file belongs to its publisher; the live endpoint may change.

Showing the first 18000 characters. Load the complete file to read the remainder.

# Prefect

## Getting Started

### Get started

- [Introduction](https://docs.prefect.io/v3/get-started/index.md)
- [Install Prefect](https://docs.prefect.io/v3/get-started/install.md)
- [Quickstart](https://docs.prefect.io/v3/get-started/quickstart.md): Create your first workflow

## Concepts

- [Concepts](https://docs.prefect.io/v3/concepts/index.md)

### Workflows

- [Flows](https://docs.prefect.io/v3/concepts/flows.md): Flows compose work into a workflow.
- [Tasks](https://docs.prefect.io/v3/concepts/tasks.md): Tasks are atomic units of work with transactional semantics.
- [Assets](https://docs.prefect.io/v3/concepts/assets.md): Assets represent objects your workflows produce.
- [Caching](https://docs.prefect.io/v3/concepts/caching.md)
- [States](https://docs.prefect.io/v3/concepts/states.md): Prefect states contain information about the status of a flow or task run.
- [Runtime context](https://docs.prefect.io/v3/concepts/runtime-context.md): The runtime context allows global access to information about the current run.
- [Artifacts](https://docs.prefect.io/v3/concepts/artifacts.md): Artifacts are persisted outputs designed for human consumption and available in the UI.
- [Task runners](https://docs.prefect.io/v3/concepts/task-runners.md): Learn about task runners for concurrent, parallel or distributed execution of tasks.
- [Global concurrency limits](https://docs.prefect.io/v3/concepts/global-concurrency-limits.md): Understand how global concurrency limits control execution and manage resource usage.
- [Tag-based concurrency limits](https://docs.prefect.io/v3/concepts/tag-based-concurrency-limits.md): Understand how tag-based concurrency limits prevent too many tasks from running simultaneously.

### Deployments

- [Deployments](https://docs.prefect.io/v3/concepts/deployments.md): Learn how to use deployments to trigger flow runs remotely.
- [Schedule flow runs](https://docs.prefect.io/v3/concepts/schedules.md): Prefect can schedule when to automatically create new flow runs.
- [Work pools](https://docs.prefect.io/v3/concepts/work-pools.md): Learn how to configure dynamic infrastructure provisioning with work pools
- [Workers](https://docs.prefect.io/v3/concepts/workers.md): Workers poll work pools for new runs to execute.

### Configuration

- [Variables](https://docs.prefect.io/v3/concepts/variables.md): Variables are dynamically-named, mutable JSON values that can be used to store and reuse non-sensitive bits of data.
- [Blocks](https://docs.prefect.io/v3/concepts/blocks.md): Prefect blocks allow you to manage configuration schemas, infrastructure, and secrets for use with deployments or flow scripts.
- [Settings and profiles](https://docs.prefect.io/v3/concepts/settings-and-profiles.md): Prefect settings let you customize behavior across different environments.
- [Prefect server](https://docs.prefect.io/v3/concepts/server.md): Self-host your own Prefect server instance.
- [Telemetry](https://docs.prefect.io/v3/concepts/telemetry.md): Learn about Prefect's anonymous usage telemetry

### Automations

- [Events](https://docs.prefect.io/v3/concepts/events.md): An event is a notification of a change - a record of activity in your stack.
- [Automations](https://docs.prefect.io/v3/concepts/automations.md): Learn how to automatically take action in response to events.
- [Define event triggers](https://docs.prefect.io/v3/concepts/event-triggers.md): Define a custom trigger to react to many kinds of events and metrics.

### Prefect Cloud

- [Rate limits and data retention](https://docs.prefect.io/v3/concepts/rate-limits.md): Understand Prefect Cloud's API rate limits, request size limits, and data retention policies.
- [Measure reliability with Service Level Agreements](https://docs.prefect.io/v3/concepts/slas.md): Define the performance expectations for your flows and to enable automated alerts when those expectations are not met.
- [Webhooks](https://docs.prefect.io/v3/concepts/webhooks.md): Understand Prefect Cloud webhooks, their configuration, and how to use templates to transform incoming HTTP requests into Prefect events.

## How-to Guides

- [How-to Guides](https://docs.prefect.io/v3/how-to-guides/index.md)

### Workflows

- [How to write and run a workflow](https://docs.prefect.io/v3/how-to-guides/workflows/write-and-run.md)
- [How to use assets to track workflow outputs](https://docs.prefect.io/v3/how-to-guides/workflows/assets.md)
- [How to automatically rerun your workflow when it fails](https://docs.prefect.io/v3/how-to-guides/workflows/retries.md)
- [How to manually retry a flow run](https://docs.prefect.io/v3/how-to-guides/workflows/retry-flow-runs.md)
- [How to customize a workflow's metadata](https://docs.prefect.io/v3/how-to-guides/workflows/custom-metadata.md)
- [How to pass inputs to a workflow](https://docs.prefect.io/v3/how-to-guides/workflows/pass-inputs.md)
- [How to add logging to a workflow](https://docs.prefect.io/v3/how-to-guides/workflows/add-logging.md)
- [How to access runtime information](https://docs.prefect.io/v3/how-to-guides/workflows/access-runtime-info.md)
- [How to run work concurrently](https://docs.prefect.io/v3/how-to-guides/workflows/run-work-concurrently.md)
- [How to cache workflow step outputs](https://docs.prefect.io/v3/how-to-guides/workflows/cache-workflow-steps.md)
- [How to run background tasks](https://docs.prefect.io/v3/how-to-guides/workflows/run-background-tasks.md)
- [How to respond to state changes](https://docs.prefect.io/v3/how-to-guides/workflows/state-change-hooks.md): Learn how to execute code in response to entering states in your workflows.
- [How to produce workflow artifacts](https://docs.prefect.io/v3/how-to-guides/workflows/artifacts.md)
- [How to test workflows](https://docs.prefect.io/v3/how-to-guides/workflows/test-workflows.md): Learn how to test Prefect flows and tasks with the test harness, pytest fixtures, and common troubleshooting patterns.
- [How to apply global concurrency and rate limits](https://docs.prefect.io/v3/how-to-guides/workflows/global-concurrency-limits.md): Learn how to control concurrency and apply rate limits using Prefect's provided utilities.
- [How to limit concurrent task runs with tags](https://docs.prefect.io/v3/how-to-guides/workflows/tag-based-concurrency-limits.md): Prevent too many tasks from running simultaneously using tags.

### Deployments

- [How to create deployments](https://docs.prefect.io/v3/how-to-guides/deployments/create-deployments.md): Learn how to create deployments via the CLI, Python, or Terraform.
- [Trigger ad-hoc deployment runs](https://docs.prefect.io/v3/how-to-guides/deployments/run-deployments.md): Learn how to trigger deployment runs using the Prefect CLI and Python SDK.
- [How to create schedules](https://docs.prefect.io/v3/how-to-guides/deployments/create-schedules.md): Learn how to create schedules for your deployments.
- [Manage Deployment schedules](https://docs.prefect.io/v3/how-to-guides/deployments/manage-schedules.md): Learn how to pause, resume, and remove deployment schedules using the Prefect CLI.
- [How to deploy flows with Python](https://docs.prefect.io/v3/how-to-guides/deployments/deploy-via-python.md): Learn how to use the Python SDK to deploy flows to run in work pools.
- [How to define deployments with YAML](https://docs.prefect.io/v3/how-to-guides/deployments/prefect-yaml.md): Use YAML to schedule and trigger flow runs and manage your code and deployments.
- [How to retrieve code from storage](https://docs.prefect.io/v3/how-to-guides/deployments/store-flow-code.md): Learn about code storage as it relates to execution of deployments
- [How to version deployments](https://docs.prefect.io/v3/how-to-guides/deployments/versioning.md): Track changes to your deployments and roll back to previous versions
- [How to override job variables](https://docs.prefect.io/v3/how-to-guides/deployments/customize-job-variables.md): Override job variables on a deployment or flow run to set environment variables, specify a Docker image, allocate resources, and more.

### Configuration

- [How to store secrets](https://docs.prefect.io/v3/how-to-guides/configuration/store-secrets.md)
- [How to share configuration between workflows](https://docs.prefect.io/v3/how-to-guides/configuration/variables.md)
- [How to manage settings](https://docs.prefect.io/v3/how-to-guides/configuration/manage-settings.md)

### Automations

- [How to create automations](https://docs.prefect.io/v3/how-to-guides/automations/creating-automations.md): Learn how to define automations that trigger actions based on events.
- [Custom notifications](https://docs.prefect.io/v3/how-to-guides/automations/custom-notifications.md): Send notifications with custom webhook payloads.
- [How to create deployment triggers](https://docs.prefect.io/v3/how-to-guides/automations/creating-deployment-triggers.md): Learn how to define automations that trigger deployment runs based on events.
- [How to chain deployments with events](https://docs.prefect.io/v3/how-to-guides/automations/chaining-deployments-with-events.md): Learn how to establish event-based dependencies between individual workflows.
- [How to access deployment and flow run parameters](https://docs.prefect.io/v3/how-to-guides/automations/access-parameters-in-templates.md): Learn how to access deployment and flow run parameters in templates
- [How to pass event payloads to flows](https://docs.prefect.io/v3/how-to-guides/automations/passing-event-payloads-to-flows.md): Learn how to pass custom event payload data to flows triggered by automations

### Workflow Infrastructure

- [How to manage work pools](https://docs.prefect.io/v3/how-to-guides/deployment_infra/manage-work-pools.md): Configure Prefect work pools using the CLI, Terraform, or REST API
- [How to run flows in local processes](https://docs.prefect.io/v3/how-to-guides/deployment_infra/run-flows-in-local-processes.md): Create a deployment for a flow by calling the `serve` method.
- [How to run flows on serverless compute](https://docs.prefect.io/v3/how-to-guides/deployment_infra/serverless.md): Learn how to use Prefect push work pools to schedule work on serverless infrastructure without having to run a worker.
- [How to run flows in Docker containers](https://docs.prefect.io/v3/how-to-guides/deployment_infra/docker.md): Learn how to execute deployments in isolated Docker containers
- [How to run flows in a long-lived Docker container](https://docs.prefect.io/v3/how-to-guides/deployment_infra/serve-flows-docker.md): Learn how to serve a flow in a long-lived Docker container
- [How to run flows on Kubernetes](https://docs.prefect.io/v3/how-to-guides/deployment_infra/kubernetes.md): Learn how to run flows on Kubernetes using containers.
- [How to run flows on Modal](https://docs.prefect.io/v3/how-to-guides/deployment_infra/modal.md): Learn how to use Modal as a push work pool to schedule, run, and debug your Prefect flows
- [How to run flows on Coiled](https://docs.prefect.io/v3/how-to-guides/deployment_infra/coiled.md): Deploy cloud infrastructure without expertise with Coiled

#### Managed Infrastructure

- [How to run flows on Prefect Managed infrastructure](https://docs.prefect.io/v3/how-to-guides/deployment_infra/managed.md): Learn how Prefect runs deployments on Prefect's infrastructure.
- [Using cloud workload identity with Prefect Managed work pools](https://docs.prefect.io/v3/how-to-guides/deployment_infra/managed-aws-federated-identity.md): Learn how to configure cloud provider workload identity with short-lived credentials in Prefect Managed work pools.

### Prefect Cloud

- [How to connect to Prefect Cloud](https://docs.prefect.io/v3/how-to-guides/cloud/connect-to-cloud.md): Configure a local execution environment to access Prefect Cloud.
- [How to manage workspaces](https://docs.prefect.io/v3/how-to-guides/cloud/workspaces.md): Organize and compartmentalize your workflows with workspaces.
- [How to create a webhook](https://docs.prefect.io/v3/how-to-guides/cloud/create-a-webhook.md): Learn how to setup a webhook in the UI to trigger automations from external events.
- [How to troubleshoot Prefect Cloud](https://docs.prefect.io/v3/how-to-guides/cloud/troubleshoot-cloud.md): Learn how to identify and resolve common issues with Prefect Cloud.
- [Prefect scope of support](https://docs.prefect.io/v3/how-to-guides/cloud/scope-of-support.md): Understand what Prefect support covers and where to find help for requests outside its scope.

#### Manage accounts

- [How to manage user accounts](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/index.md): Special features for Prefect Cloud users
- [How to manage service accounts](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/service-accounts.md): Workspaces are isolated environments for flows and deployments within Prefect Cloud.
- [How to manage teams](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/manage-teams.md): Manage teams of users in Prefect Cloud.
- [How to manage account roles](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/manage-roles.md): Configure user workspace roles in Prefect Cloud.
- [How to manage API keys](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/api-keys.md): Create an API key to access Prefect Cloud from a local execution environment.
- [How to configure single sign-on](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/configure-sso.md): Configure single sign-on (SSO) for your Prefect Cloud users.
- [How to audit Cloud activity](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/audit-logs.md): Monitor user access and activity with audit logs in Prefect Cloud.
- [How to manage Access Control Lists (ACLs)](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/object-access-control-lists.md): Restrict block and deployment access to individual actors within a workspace.
- [How to secure access by IP address](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/secure-access-by-ip-address.md): Manage network access to Prefect Cloud accounts with IP Allowlists.
- [How to secure access over PrivateLink](https://docs.prefect.io/v3/how-to-guides/cloud/manage-users/secure-access-by-private-link.md): Manage network access to Prefect Cloud accounts over PrivateLink.

### Prefect Self-hosted

- [How to run a local Prefect server](https://docs.prefect.io/v3/how-to-guides/self-hosted/server-cli.md): Get started with self-hosting by running Prefect server locally.
- [How to run the Prefect server in Docker](https://docs.prefect.io/v3/how-to-guides/self-hosted/server-docker.md): Run a containerized Prefect server instance with Docker.
- [How to run Prefect on Windows](https://docs.prefect.io/v3/how-to-guides/self-hosted/server-windows.md): Learn how to run Prefect server and workers on Windows with PowerShell.
- [How to run the Prefect Server via Docker Compose](https://docs.prefect.io/v3/how-to-guides/self-hosted/docker-compose.md): Deploy a self-hosted Prefect server environment using Docker Compose, including PostgreSQL, Redis, server, background services, and worker.

### AI

- [AI assistants with Prefect MCP](https://docs.prefect.io/v3/how-to-guides/ai/index.md)
- [How to use the Prefect MCP server](https://docs.prefect.io/v3/how-to-guides/ai/use-prefect-mcp-server.md): Connect AI assistants to Prefect using the Model Context Protocol.
- [AI log summaries](https://docs.prefect.io/v3/how-to-guides/ai/flow-run-log-summaries.md): Use AI-generated summaries of flow run logs to understand failures faster.

### Migrate

- [How to Migrate from Airflow](https://docs.prefect.io/v3/how-to-guides/migrate/airflow.md): Migration from Apache Airflow to Prefect: A Comprehensive How-To Guide
- [How to upgrade to Prefect 3.0](https://docs.prefect.io/v3/how-to-guides/migrate/upgrade-to-prefect-3.md): Learn how to upgrade from Prefect 2.x to Prefect 3.0.
- [How to upgrade from agents to workers](https://docs.prefect.io/v3/how-to-guides/migrate/upgrade-agents-to-workers.md): Learn how to upgrade from agents to workers to significantly enhance the experience of deploying flows.
- [How to transfer resources between Prefect environments](https://docs.prefect.io/v3/how-to-guides/migrate/transfer-resources.md): Migrate flows, deployments, work pools, and other resources between Prefect profiles

## Advanced

- [Advanced](https://docs.prefect.io/v3/advanced/index.md)

### Workflows

- [How to customize asset metadata](https://docs.prefect.io/v3/advanced/assets.md): This guide covers how to enhance your assets with rich metadata, custom properties, and explicit dependency management beyond what's automatically inferred from your task graph.
- [How to customize caching behavior](https://docs.prefect.io/v3/advanced/caching.md)
- [How to customize Prefect's logging configuration](https://docs.prefect.io/v3/advanced/logging-customization.md)
- [How to write transactional workflows](https://docs.prefect.io/v3/advanced/transactions.md)
- [How to cancel running workflows](https://docs.prefect.io/v3/advanced/cancel-workflows.md)
- [How to write interactive workflows](https://docs.prefect.io/v3/advanced/interactive.md)
- [How to persist and retrieve workflow results](https://docs.prefect.io/v3/advanced/results.md): Results represent the data returned by a flow or a task and enable features such as caching.
- [How to deploy a web application powered by background tasks](https://docs.prefect.io/v3/advanced/background-tasks.md): Learn how to background heavy tasks from a web application to dedicated infrastructure.

### Deployments

- [Configure UI forms for validating workflow inputs](https://docs.prefect.io/v3/advanced/form-building.md): Learn how to craft validated and user-friendly input forms for workflows.
- [How to generate a custom SDK for your deployments](https://docs.prefect.io/v3/advanced/generate-custom-sdk.md): Generate a custom Python SDK from your deployments for IDE autocomplete and type checking.

### Automations

- [How to