API & SDK References

Explore Prefect’s auto-generated API & SDK reference documentation.

Prefect auto-generates reference documentation for the following components:

• Prefect Python SDK: used to build, test, and execute workflows.
• Prefect REST API: used by workflow clients and the Prefect UI for orchestration and data retrieval.
  • Prefect Cloud REST API documentation: https://app.prefect.cloud/api/docs.
  • Self-hosted Prefect server REST API documentation. Additionally, if self-hosting a Prefect server instance, you can access REST API documentation at the /docs endpoint of your PREFECT_API_URL. For example, if you run prefect server start with no additional configuration you can find this reference at http://localhost:4200/docs.