Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

This node integrates with the Lectful API to manage AI resources and other educational content. Specifically, for the AI Resource - List AI Resources operation, it retrieves a paginated list of AI resources available in the Lectful system. Users can filter these resources by name, type, and status, as well as sort and paginate the results.

This node is beneficial when you want to automate or integrate AI resource management within your workflows, such as fetching available AI-powered documents, images, or files for further processing, reporting, or display in other systems.

Practical example:

  • Automatically retrieve all completed PDF AI resources updated recently to feed into a document processing pipeline.
  • Filter AI resources by file type (e.g., only JPEG images) to generate image galleries or thumbnails.
  • Paginate through AI resources to synchronize them with an external database or CMS.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful API: "Use Stored Credentials" or "Manual Configuration".
Base URL Override (Manual mode) Optional base URL to override the credential setting (without /api/v1).
API Key Override (Manual mode) Optional API key to override the credential setting.
Filter by Name Filter AI resources by their name (partial match).
Filter by Type Filter AI resources by file type. Options include: All Types, PDF, Word Document (doc/docx), Text File, Excel Spreadsheet (xls/xlsx), PowerPoint Presentation (ppt/pptx), JPEG Image (jpg/jpeg), PNG Image, GIF Image.
Filter by Status Filter AI resources by status. Options include: All Statuses, Uploading, Processing, Completed, Failed, Ready.
Sort By Sort field for AI resources. Options include Updated At (newest/oldest), Created At (newest/oldest), ID (ascending/descending), Name (A-Z/Z-A), Type (A-Z/Z-A), Status (A-Z/Z-A). Default is Updated At (Newest First).
Per Page Number of results per page (pagination size). Default is 10.

Output

The output is a JSON array where each item corresponds to an AI resource object returned by the Lectful API. The structure 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).
  • status: Current processing status (uploading, processing, completed, etc.).
  • description: Optional description of the resource.
  • updated_at, created_at: Timestamps for sorting/filtering.
  • Other metadata related to the AI resource.

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

Dependencies

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

Troubleshooting

  • Missing or invalid credentials: If using stored credentials, ensure they are correctly configured with valid Base URL and API key. For manual mode, both Base URL Override and API Key Override must be provided.
  • API errors: Errors from the Lectful API (e.g., unauthorized, not found) will be thrown. Check that the API key has sufficient permissions and the Base URL is correct.
  • Empty results: If filters are too restrictive (e.g., filtering by a name or type that doesn't exist), the result may be empty.
  • Pagination issues: Ensure the Per Page value is reasonable and supported by the API to avoid unexpected behavior.

Links and References


This summary covers the logic and usage of the Lectful node's "List AI Resources" operation based on static code analysis and provided property definitions.

Discussion