Skip to content

Using the API playground#

The Workflow² API comes with a built-in Swagger UI playground. This provides interactive documentation, allowing you to try out requests. The path to access the playground depends on your hosting.

For self-hosted users, WF² constructs the path from values set in your environment variables:

1
WF²_HOST:WF²_PORT/WF²_PATH/api/v<version-number>/docs

For WF² Cloud users, the API playground path contains your cloud instance URL:

1
<your-cloud-instance>/api/v<version-number>/docs

The API includes built-in documentation about credential formats. This is available using the credentials endpoint:

1
/api/credentials/schema/{id}

Real data

If you click Authorize and enter your API key in the API playground, you have access to your live data. This is useful for trying out requests. However, be aware you can change or delete real data.