Pickaxe icon

Pickaxe

Interact with the Pickaxe APIs

Overview

The Pickaxe node allows users to interact with the Pickaxe API, specifically enabling the creation of documents within a selected studio. This is useful for automating content ingestion workflows where documents need to be programmatically created from either raw text or by parsing a website URL. For example, you might use this node to create a new document in your Pickaxe studio by providing a URL to scrape and convert into a structured document, or by directly supplying raw content.

Properties

Name Meaning
Studio Select the target studio where the document will be created. Options are dynamically loaded.
Document Name The name to assign to the newly created document.
Website To Parse (Optional) A URL of a website whose content will be parsed and used as the document content.
Raw Content (Optional) Raw textual content to be used directly as the document content instead of a website.

Output

The node outputs JSON data representing the response from the Pickaxe API after creating the document. This typically includes details about the newly created document such as its ID, name, status, and any metadata returned by the API. The output does not include binary data.

Dependencies

  • Requires an active API authentication token configured in n8n credentials to access the Pickaxe API.
  • Network access to https://api.pickaxe.co/v1 is necessary.
  • The node depends on the Pickaxe API OAuth2 authentication method for secure requests.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 credentials are correctly set up and have sufficient permissions.
  • Invalid studio selection: If no studios appear in the dropdown, verify that the authenticated user has access to at least one studio in Pickaxe.
  • Document creation failures: Check that either "Website To Parse" or "Raw Content" is provided; otherwise, the API may reject the request.
  • Network issues: Confirm that your environment can reach the Pickaxe API endpoint without firewall restrictions.

Links and References

Discussion