Skip to content

API Reference

Prefect 2 provides a number of programmatic workflow interfaces. Each API is documented in this section.

  • The Prefect Python API is used to build, test, and execute workflows against the Orion workflow engine. This is the primary user-facing API.
  • The Prefect Orion Python API is used by the Orion server to work with workflow metadata and enforce orchestration logic. This API is primarily used by Orion developers.
  • The Prefect Orion REST API is used for communicating data from Orion clients to the Orion server so that orchestration can be performed. This API is mainly consumed by Orion clients like the Prefect Python Client or the Orion Dashboard.

Prefect REST API interactive documentation

Prefect Cloud REST API documentation is available at

The Prefect Orion REST API documentation for a local instance run with with prefect orion start is available at http://localhost:4200/docs or the /docs endpoint of the PREFECT_API_URL you have configured to access the server.

The Prefect Orion REST API documentation for locally run open-source Prefect Orion servers is also available in the Prefect Orion REST API Reference.