Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

This node integrates with the Lectful API, enabling users to manage various educational resources and user-related data programmatically. Specifically for the AI Resource with the Get AI Resource operation, it retrieves detailed information about a specific AI resource by its ID.

Typical use cases include:

  • Fetching metadata and status of an AI resource (such as PDFs, Word documents, images) stored in Lectful.
  • Integrating AI resource details into automated workflows, e.g., for content management or course enrichment.
  • Monitoring or auditing AI resources linked to courses or standalone.

Example: You have an AI resource file uploaded to Lectful representing a PDF study guide. Using this node, you can retrieve its details like name, type, description, and processing status to display or process further in your workflow.

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
AI Resource ID The numeric ID of the AI resource to retrieve

Output

The node outputs a JSON object containing the detailed information of the requested AI resource. This typically includes fields such as:

  • id: The unique identifier of the AI resource.
  • name: The name of the AI resource.
  • type: The file type (e.g., pdf, docx, jpg).
  • description: Optional description of the resource.
  • status: Current processing status (e.g., uploading, processing, completed).
  • Other metadata related to the resource such as creation date, update date, file size, and possibly URLs or hashes related to the stored file.

No binary data is output by this operation; the response is purely JSON metadata about the AI resource.

Dependencies

  • Requires access to the Lectful API.
  • Requires either stored credentials configured in n8n or manual entry of the Lectful API base URL and API key.
  • The API key must have permissions to read AI resource data.
  • No additional external dependencies beyond standard HTTP requests.

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: Providing an incorrect or non-existent AI Resource ID will result in an API error, typically a 404 Not Found.
  • API connectivity issues: Network problems or incorrect base URL may cause request failures.
  • Parsing errors: If the API returns unexpected data formats, the node attempts to parse JSON but may fail gracefully.

To resolve:

  • Ensure correct and valid API credentials are set or manual parameters are filled.
  • Verify the AI Resource ID exists in Lectful.
  • Check network connectivity and base URL correctness.
  • Review API permissions for the used API key.

Links and References


This summary focuses exclusively on the "AI Resource" resource and the "Get AI Resource" operation as requested.

Discussion