API & SDK References

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.
• Events reference: catalog of all events emitted by Prefect, Prefect Cloud, and integrations.
  • Prefect Cloud REST API documentation: <a href="https://app.prefect.cloud/api/docs" target="_blank">https://app.prefect.cloud/api/docs</a>.
  • 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 <a href="http://localhost:4200/docs" target="_blank">http://localhost:4200/docs</a>.