Lark Files

Lark Files Management

Actions28

File Actions
Multipart Upload File Actions
Permission Member Actions
Permissionpublic Actions
- Update Common Settings Of A Document
Statistic Actions
- Obtain Statistics Of A File
Media Actions
Multipart Upload Media Actions
Comment Actions
Subscription Actions
Document Import Actions
- Create An Import Task
- Query The Import Task Result

Overview

The "Lark Files" node provides functionality to manage files within the Lark platform. It is designed to interact with Lark's file management APIs, allowing users to perform operations related to files stored or shared in Lark. This node is useful for automating workflows that involve uploading, retrieving, or manipulating files in Lark, such as syncing documents, backing up files, or integrating Lark file data into other systems.

Common scenarios include:

Automatically uploading generated reports or documents to Lark.
Retrieving files from Lark for processing or archival.
Managing file metadata or sharing settings programmatically.

Properties

Name	Meaning
Authentication	Method of authenticating API requests. Options: "Tenant Token" or "OAuth2".
Options	Additional optional settings:
- Use Custom Body	Boolean flag indicating whether to send a custom request body instead of default format.

Output

The node outputs JSON data representing the response from the Lark Files API. This typically includes details about files such as file IDs, names, URLs, metadata, or status messages depending on the operation performed.

If binary data is involved (e.g., downloading a file), the node would output the binary content accordingly, but this is not explicitly detailed in the provided code.

Dependencies

Requires an API authentication credential, either a Tenant Token or OAuth2 token, configured in n8n.
Communicates with the Lark Open API endpoint at https://open.larksuite.com/open-apis.
The node depends on additional property and method definitions imported from bundled files (LarkFiles.properties and LarkFiles.methods), which define specific operations and parameters.

Troubleshooting

Authentication errors: Ensure that the correct authentication method is selected and valid credentials are provided.
API request failures: Check network connectivity and verify that the Lark API service is operational.
Invalid custom body usage: If "Use Custom Body" is enabled, ensure the custom body is correctly formatted as per Lark API requirements.
Missing or incorrect properties: Verify that all required input properties are set appropriately before execution.