Lark Files icon

Lark Files

Lark Files Management

Actions28

Overview

This node interacts with the Lark Files API to obtain detailed information about a specific comment within a document managed by Lark Docs. It is useful when you need to retrieve metadata or content of a particular comment identified by its unique ID in a collaborative document environment.

Practical scenarios include:

  • Fetching comment details for review or moderation.
  • Integrating comment data into workflows, such as notifications or audit logs.
  • Synchronizing comments from Lark Docs into other systems.

Properties

Name Meaning
Authentication Method of authenticating API requests; options are "Tenant Token" or "OAuth2".
File Type The type of the document (e.g., doc, sheet); optional and used as a query parameter.
File Token The unique token identifying the document containing the comment; required.
Comment Id The unique numeric identifier of the comment to retrieve; required.
Options Additional options; currently supports "Use Custom Body" (boolean) to override request body.

Output

The node outputs JSON data representing the retrieved comment's details. This typically includes fields such as the comment's content, author, timestamps, status, and any related metadata provided by the Lark Files API.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Lark Suite API.
  • Needs either a Tenant Token credential or OAuth2 authentication configured in n8n.
  • The base URL for API requests is https://open.larksuite.com/open-apis.
  • Proper permissions on the Lark Docs file and comment access are necessary.

Troubleshooting

  • Invalid Credentials: Errors may occur if the authentication token is missing, expired, or invalid. Ensure that the correct credential type is selected and properly configured.
  • Comment Not Found: If the specified Comment Id does not exist or is inaccessible, the API will return an error. Verify the Comment Id and ensure the authenticated user has permission to view it.
  • File Token Issues: Providing an incorrect or malformed File Token will cause failures. Double-check the token value corresponds to the target document.
  • API Rate Limits: Excessive requests might be throttled by the Lark API. Implement retry logic or reduce request frequency if needed.
  • Use Custom Body Option: Enabling this without proper custom body structure may lead to malformed requests. Use only if you understand the API requirements.

Links and References

Discussion