Lark Files icon

Lark Files

Lark Files Management

Actions28

Overview

This node facilitates multipart file uploads to a document management system by preuploading files in blocks. It is designed for scenarios where large files need to be uploaded efficiently by splitting them into smaller chunks, which can then be uploaded separately. This approach helps in resuming interrupted uploads and managing bandwidth effectively.

Typical use cases include:

  • Uploading large documents or media files to cloud storage.
  • Integrating with collaborative platforms that require chunked file uploads.
  • Automating file management workflows where partial uploads are necessary before finalizing the file.

For example, you might use this node to start uploading a large video file by first initiating the upload process with metadata such as file name, size, and parent folder information, allowing subsequent nodes or processes to handle the actual block uploads.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
File Name The name of the file being uploaded.
Parent Node Identifier of the parent directory or folder where the file will be stored.
Parent Type The type/category of the parent container (e.g., folder, drive).
Size Total size of the file in bytes.
Custom Body A JSON object allowing custom request body content to override default parameters.
Options > Use Custom Body Boolean flag indicating whether to send a custom request body instead of the standard one.

Output

The node outputs JSON data representing the response from the preupload API call. This typically includes information required to proceed with uploading the file blocks, such as upload URLs, session identifiers, or tokens needed for subsequent block uploads.

If the node supports binary data output (not explicitly shown here), it would represent the file content or related binary payloads; however, in this case, the output focuses on JSON metadata for managing the multipart upload process.

Dependencies

  • Requires an active connection to the target document management API endpoint at https://open.larksuite.com/open-apis.
  • Needs valid authentication credentials, either via a tenant token or OAuth2 token.
  • Proper configuration of authentication credentials within n8n is necessary to authorize API requests.

Troubleshooting

  • Authentication Errors: If the node fails due to invalid or missing credentials, verify that the correct authentication method is selected and that the credentials are properly configured in n8n.
  • Invalid Parameters: Ensure that required properties like file_name, parent_node, parent_type, and size are correctly set and valid. Missing or incorrect values may cause API errors.
  • Custom Body Usage: When using the "Use Custom Body" option, ensure the JSON structure matches the API expectations; malformed JSON or missing fields can lead to request failures.
  • API Rate Limits or Network Issues: Large file uploads may be affected by network instability or API rate limits. Implement retry logic or monitor API usage quotas if applicable.

Links and References

Discussion