bookoly icon

bookoly

Interact with the bookoly API

Overview

This node integrates with the Bookoly API to perform various operations related to its resources. Specifically, for the "Transcription" resource and the "Get a Specific Transcription" operation, it retrieves detailed information about a single transcription by its unique ID. This is useful when you want to fetch the content or metadata of a particular transcript stored in Bookoly.

Practical examples include:

  • Fetching a transcript to display or process its text content.
  • Retrieving transcription details for further automation or reporting.
  • Integrating transcription data into other workflows or systems.

Properties

Name Meaning
Transcript ID The unique identifier of the transcript to retrieve. This is a required string input.

Output

The node outputs a JSON object representing the transcription data retrieved from the Bookoly API. The structure typically includes all relevant fields of the transcription such as its text content, timestamps, metadata, and any other attributes provided by the API.

If the API supports binary data (e.g., audio files linked to the transcription), this node may also output binary data accordingly, but based on the provided code and properties, the primary output is JSON data containing the transcription details.

Dependencies

  • Requires an active connection to the Bookoly API.
  • Needs an API key credential configured in n8n to authenticate requests.
  • The base URL for API requests is https://bookoly.com/api/v1.
  • No additional external dependencies are indicated beyond the Bookoly API and its authentication.

Troubleshooting

  • No handler found error: If the node throws an error like "No handler found for transcript.getTranscript", ensure that the Resource is set to "Transcription" and Operation to "Get a Specific Transcription".
  • Failed to execute getTranscript: This error indicates issues during the API call, possibly due to invalid Transcript ID, network problems, or authentication failures. Verify the Transcript ID is correct and the API key credential is valid.
  • Empty or missing output: Confirm that the Transcript ID exists in Bookoly and that the API user has permission to access it.

Links and References

Discussion