Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

The "Generate Subtitle" operation of the Lectful node allows users to generate AI-powered subtitles for a specified video. This is useful in scenarios where you want to automatically create subtitles in different languages for videos hosted on the Lectful platform, enhancing accessibility and user engagement.

Typical use cases include:

  • Automatically generating subtitles for educational or training videos to support multiple languages.
  • Creating subtitles for marketing or promotional videos to reach a broader audience.
  • Enhancing video content with accurate captions for compliance or accessibility standards.

For example, if you have uploaded a video to Lectful and want to generate English subtitles, you provide the video ID and specify the language code "en". The node then triggers the subtitle generation process via the Lectful API.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful API:
- Use Stored Credentials
- Manual Configuration (provide base URL and API key manually)
Credentials Note Notice shown when using Manual Configuration mode explaining credential usage
Base URL Override Optional base URL to override the stored credential's base URL (without /api/v1)
API Key Override Optional API key to override the stored credential's API key
Video ID The unique identifier of the video for which subtitles will be generated (required)
Language Language code for subtitle generation (e.g., en for English, es for Spanish, fr for French) (required)

Output

The node outputs a JSON object representing the response from the Lectful API after requesting subtitle generation. The structure typically includes details about the subtitle generation request status or resulting subtitle data as returned by the API.

Example output JSON structure (simplified):

{
  "status": "processing",
  "video_id": "12345",
  "language": "en",
  "subtitle_url": "https://lectful.example.com/subtitles/12345_en.vtt"
}

No binary data output is produced by this operation; it only returns JSON metadata about the subtitle generation.

Dependencies

  • Requires access to the Lectful API.
  • Requires either stored credentials configured in n8n or manual entry of the Lectful API base URL and an API key.
  • Proper API authentication token or key must be provided for successful requests.
  • Network connectivity to the Lectful API endpoint.

Troubleshooting

  • Missing or invalid credentials: If neither stored credentials nor manual configuration parameters are correctly set, the node will throw an error indicating missing or invalid credentials. Ensure that either valid stored credentials are configured or manual base URL and API key are provided.
  • Invalid Video ID: Providing an incorrect or non-existent video ID will result in API errors. Verify the video ID before running the node.
  • Unsupported language code: Using an unsupported or invalid language code may cause the API to reject the request. Use standard ISO language codes supported by Lectful.
  • API rate limits or network issues: Network failures or API rate limiting can cause request failures. Check network connectivity and API usage limits.
  • Error messages: Errors from the API are returned in the JSON response. Review the error message for guidance, such as authorization failures or invalid parameters.

Links and References

Discussion