Using an API playground

This documentation site provides a playground to test out calls. Self-hosted users also have access to a built-in playground hosted as part of their instance.

Documentation playground

You can test API calls from this site's API reference. You need to set your server's base URL and instance name, and add an API key.

n8n uses Scalar's open source API platform to power this functionality.

Built-in playground

The n8n API comes with a built-in Swagger UI playground in self-hosted versions. This provides interactive documentation, where you can try out requests. The path to access the playground depends on your hosting.

n8n constructs the path from values set in your environment variables:

N8N_HOST:N8N_PORT/N8N_PATH/api/v<api-version-number>/docs

The API version number is 1. There may be multiple versions available in the future.

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

N8N_HOST:N8N_PORT/N8N_PATH/api/v<api-version-number>/credentials/schema/{credentialTypeName}

{
    ...,
    "credentials": {
        "googleDriveOAuth2Api": {
        "id": "9",
        "name": "Google Drive"
        }
    }
}