Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

This node interacts with the Lectful API to manage AI resources and their association with courses. Specifically, the "Detach AI Resource from Course" operation removes a link between a specified AI resource and a course. This is useful in scenarios where an AI resource (such as a PDF, document, or image) previously attached to a course should no longer be associated with it, for example, when updating course materials or cleaning up unused resources.

Practical examples:

  • Detaching outdated AI study materials from a course.
  • Removing mistakenly attached AI resources from a course.
  • Managing course content dynamically by attaching or detaching AI resources as needed.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful API: "Use Stored Credentials" or "Manual Configuration".
Credentials Note Notice shown when using Manual Configuration mode explaining credential overrides.
Base URL Override Optional base URL to override stored credentials (without /api/v1), used in Manual mode.
API Key Override Optional API key to override stored credentials, used in Manual mode.
AI Resource ID The numeric ID of the AI resource to detach from the course.
Course ID The numeric ID of the course from which to detach the AI resource.

Output

The node outputs JSON data representing the API response from the Lectful server after attempting to detach the AI resource from the course. The structure typically includes status information about the detachment operation, such as success confirmation or error details.

No binary data output is involved in this operation.

Example output JSON might look like:

{
  "status": "success",
  "message": "AI resource detached from course successfully"
}

or an error message if the operation fails.

Dependencies

  • Requires access to the Lectful API.
  • Requires either stored API credentials configured in n8n or manual entry of Base URL and API key.
  • The node uses HTTP requests with Bearer token authentication.
  • No additional external dependencies beyond the Lectful API and proper credentials.

Troubleshooting

  • Missing or invalid credentials: If neither stored credentials nor manual overrides are provided correctly, the node will throw an error indicating missing or invalid credentials.
  • Invalid AI Resource ID or Course ID: Providing incorrect IDs may result in API errors such as "Resource not found" or "Invalid ID".
  • API connectivity issues: Network problems or incorrect Base URL can cause request failures.
  • Permission errors: Insufficient permissions on the API key may prevent detaching resources.

To resolve:

  • Verify that the API key and Base URL are correct and have necessary permissions.
  • Confirm that the AI Resource ID and Course ID exist and are valid.
  • Use the Manual Configuration mode if stored credentials are problematic.
  • Check network connectivity and API availability.

Links and References

Discussion