Lark Files icon

Lark Files

Lark Files Management

Overview

This node facilitates the completion of a multipart upload process for media files in Lark's Docs File Management system. When uploading large files, they are often split into multiple blocks (chunks). This node finalizes the upload by informing the server that all blocks have been uploaded, allowing the server to assemble them into a complete file.

Common scenarios include:

  • Uploading large media files or documents where chunked uploads are necessary due to size constraints.
  • Finalizing an upload session after all parts have been successfully transmitted.
  • Integrating with Lark's file management API to automate file uploads within workflows.

Practical example:

  • A user uploads a video file in 10 blocks; after sending all blocks, this node is used to signal completion so the video becomes available in Lark Docs.

Properties

Name Meaning
Authentication Method of authentication: either "Tenant Token" or "OAuth2"
Block Num The number of blocks (chunks) that were uploaded
Upload Id The unique identifier for the multipart upload session
Custom Body JSON object to send a custom request body instead of the standard parameters
Use Custom Body Boolean flag to determine whether to use the custom JSON body instead of standard fields

Output

The node outputs a JSON object representing the response from the Lark Docs API confirming the completion of the multipart upload. This typically includes metadata about the uploaded file or confirmation status.

If binary data is returned (not indicated here), it would represent the uploaded media content or related file data, but this node primarily deals with JSON responses confirming upload completion.

Dependencies

  • Requires access to Lark Suite's Open APIs for Docs File Management.
  • Needs either a Tenant Token or OAuth2 credentials configured in n8n for authentication.
  • Network connectivity to https://open.larksuite.com/open-apis.

Troubleshooting

  • Invalid Upload ID: If the provided upload ID is incorrect or expired, the API will reject the completion request. Verify the upload ID matches the one received when initiating the multipart upload.
  • Incorrect Block Number: Providing a block number that does not match the actual number of uploaded blocks may cause errors. Ensure the block count is accurate.
  • Authentication Errors: Using invalid or expired tokens will result in authorization failures. Refresh or reconfigure credentials as needed.
  • Custom Body Misconfiguration: If using the custom body option, ensure the JSON structure matches the API requirements exactly to avoid malformed request errors.

Links and References

Discussion