Pickaxe icon

Pickaxe

Interact with the Pickaxe APIs

Overview

The Pickaxe node allows users to interact with the Pickaxe API, specifically to retrieve documents associated with a selected studio. This node is useful in scenarios where you want to automate workflows involving document retrieval from Pickaxe studios, such as fetching contract files, reports, or other stored documents for further processing or integration with other systems.

For example, you might use this node to:

  • Automatically fetch a specific document from a Pickaxe studio when triggered.
  • Integrate document data into another system like a CRM or cloud storage.
  • Use document content downstream in an automation workflow for analysis or notifications.

Properties

Name Meaning
Studio Select the Pickaxe studio from which to retrieve the document. Options are dynamically loaded from your available studios.
Documents Select the specific document to retrieve from the chosen studio. Options are dynamically loaded based on the selected studio.

Output

The node outputs JSON data representing the retrieved document's details and content as returned by the Pickaxe API. The exact structure depends on the API response but typically includes metadata about the document and its contents.

If the document contains binary data (e.g., file attachments), the node would handle it accordingly, but based on the provided code, the output focuses on JSON data.

Dependencies

  • Requires an active connection to the Pickaxe API using OAuth2 authentication.
  • The node expects an API key credential configured in n8n for authenticating requests to Pickaxe.
  • Network access to https://api.pickaxe.co/v1 is necessary.

Troubleshooting

  • Authentication errors: Ensure that the OAuth2 credentials for Pickaxe are correctly set up and have not expired.
  • Empty or missing options in dropdowns: Verify that the selected studio has documents available; also check network connectivity to the Pickaxe API.
  • API request failures: Check if the Pickaxe API service is operational and that the base URL has not changed.
  • Invalid document ID: Make sure the document ID selected corresponds to a valid document within the chosen studio.

Links and References

Discussion