Lectful icon

Lectful

Interact with the VIPay Lectful API

Actions88

Overview

This node integrates with the Lectful API, providing a wide range of operations to manage educational content and user data within the Lectful platform. Specifically for the AI Resource resource, it allows users to list AI resources, retrieve details, create new AI resources by uploading files, update existing ones (including file replacement), delete resources, and manage their association with courses.

The Get Unattached AI Resources operation fetches AI resources that are not currently attached to any course. This is useful for identifying available AI resources that can be assigned or reused in courses without duplication.

Practical examples:

  • Automatically retrieving unattached AI resources to display them in an admin dashboard for assignment.
  • Cleaning up unused AI resources by listing unattached items before deletion.
  • Integrating with workflows that assign AI resources to courses only if they are unattached.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful API:
- Use Stored Credentials
- Manual Configuration
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

For the AI Resource - Get Unattached AI Resources operation, no additional input properties are required beyond authentication.

Output

The node outputs an array of JSON objects representing the API response from Lectful. For the Get Unattached AI Resources operation, the output JSON contains a list of AI resource objects that are not attached to any course.

Each AI resource object typically includes fields such as:

  • id: Unique identifier of the AI resource
  • name: Name of the AI resource
  • type: File type (e.g., pdf, docx, jpg)
  • description: Description of the resource
  • status: Current processing status of the resource
  • Other metadata related to the resource file and its upload status

The node does not output binary data for this operation; it returns metadata about the AI resources.

Dependencies

  • Requires access to the Lectful API.
  • Requires either stored credentials configured in n8n or manual configuration of the base URL and API key.
  • The API key must have sufficient permissions to read AI resources.
  • No additional external dependencies.

Troubleshooting

  • Missing or invalid credentials:
    Error thrown if neither valid stored credentials nor manual configuration parameters are provided.
    Resolution: Configure credentials properly or provide manual base URL and API key.

  • Base URL or API key missing in manual mode:
    If manual mode is selected but base URL or API key is empty, the node throws an error.
    Resolution: Provide both base URL override and API key override.

  • API request failures:
    Network issues, invalid API keys, or insufficient permissions may cause errors.
    Resolution: Verify network connectivity, API key validity, and permission scopes.

  • Parsing errors:
    If the API returns unexpected data formats, parsing might fail. The node attempts to parse string responses as JSON.
    Resolution: Check API response format and ensure compatibility.

Links and References

Discussion