Lark Files icon

Lark Files

Lark Files Management

Actions28

Overview

The node "Lark Files" provides integration with Lark's file management API, specifically supporting operations related to document import tasks. The "Query The Import Task Result" operation allows users to check the status and results of a previously initiated document import task by providing its unique ticket ID.

This node is beneficial in scenarios where documents are being programmatically imported into Lark's document system, and you need to monitor or retrieve the outcome of these import processes. For example, after uploading a batch of files for import, you can use this operation to poll or fetch the import result to confirm success or handle errors.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: "Tenant Token" or "OAuth2".
Ticket The unique identifier (ID) of the import task whose result you want to query.
Options Additional optional settings:
- Use Custom Body (boolean): Whether to send a custom request body instead of the default format.

Output

The output JSON contains the response from Lark's API regarding the import task status and details. This typically includes information such as:

  • The current state of the import task (e.g., pending, completed, failed).
  • Any error messages or failure reasons if the import did not succeed.
  • Metadata about the imported documents or files.
  • Timestamps or progress indicators related to the import process.

If the node supports binary data output (not explicitly shown here), it would represent any files or attachments returned by the API related to the import task.

Dependencies

  • Requires an active connection to Lark's Open API endpoint (https://open.larksuite.com/open-apis).
  • Needs authentication credentials configured in n8n, either via:
    • A Tenant Token credential.
    • An OAuth2 credential.
  • Proper permissions on the Lark tenant to query document import tasks.

Troubleshooting

  • Invalid Ticket ID: If the provided ticket ID does not correspond to any import task, the API will likely return an error indicating the task was not found. Verify the ticket value is correct.
  • Authentication Errors: Using incorrect or expired credentials will cause authentication failures. Ensure that the selected authentication method is valid and tokens are refreshed if needed.
  • API Rate Limits: Frequent polling of import task results may hit rate limits imposed by Lark's API. Implement appropriate delays or retries.
  • Use Custom Body Option: Enabling the "Use Custom Body" option without providing a correctly formatted body might cause request failures. Use this option only if you know the exact request structure required.

Links and References

Discussion