bookoly icon

bookoly

Interact with the bookoly API

Overview

This node integrates with the Bookoly API to create sound effects from text input. Specifically, the "Create a Sound Effect" operation under the "Sound" resource converts provided text into an audio sound effect of configurable duration. This is useful for automating the generation of audio clips based on textual content, such as creating notification sounds, voice prompts, or custom audio alerts dynamically within workflows.

Common scenarios include:

  • Generating short sound effects for UI notifications.
  • Creating audio snippets from text for accessibility features.
  • Automating audio content creation in multimedia workflows.

For example, you can input the phrase "Success!" and generate a 2-second sound effect representing that text, which can then be used in other parts of your workflow or application.

Properties

Name Meaning
Name The name assigned to the generated sound effect.
Text The text string that will be converted into the sound effect audio.
Effect Duration Duration in seconds for the generated sound effect (minimum 0.5, maximum 22). If not set, the system guesses optimal length.
Wait for Completion Whether to pause the workflow until the sound generation completes. If false, only minimal info (ID and timestamp) is returned.
Webhook URL Optional URL to receive webhook notifications when the sound generation finishes, including sound ID and URL.

Output

The node outputs JSON data representing the created sound effect. When "Wait for Completion" is enabled, the output includes the full sound object with details such as the sound's URL, metadata, and timestamps. If waiting is disabled, the output contains only the sound effect's ID and creation timestamp.

If a webhook URL is provided, the node does not wait but relies on webhook callbacks to notify about completion asynchronously.

No binary data output is indicated by the source code; all outputs are JSON objects describing the sound effect.

Dependencies

  • Requires an active connection to the Bookoly API service.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • Internet access to https://bookoly.com/api/v1 endpoints.
  • Optional: A publicly accessible webhook URL if asynchronous notifications are desired.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an effect duration outside the allowed range (less than 0.5 or greater than 22) may result in errors.
    • Incorrect webhook URLs might lead to missed notifications.
    • Network connectivity problems can prevent communication with the Bookoly API.
  • Error messages:

    • "No handler found for sound.createSoundEffect" indicates misconfiguration or unsupported operation/resource combination.
    • Errors mentioning failed execution usually relate to API request failures or invalid parameters.
  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure effect duration is within valid limits.
    • Confirm webhook URL is correct and reachable.
    • Check network connectivity and API status.

Links and References

Discussion