Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Document → Get

AI-generated

Overview

This node interacts with the Typesense search platform to retrieve a specific document from a selected collection. It is useful for scenarios where you need to fetch detailed information about a single document stored in a Typesense collection, such as retrieving user profiles, product details, or any indexed data by its unique ID.

Use Case Examples

  1. Fetch a product's details by its document ID from the 'products' collection.
  2. Retrieve a user profile document from the 'users' collection using the document ID.

Properties

Name Meaning
Collection Name Selects the collection from which to retrieve the document.
Document ID Specifies the unique identifier of the document to retrieve.
Filter Columns Comma-separated list of column names to include in the output. If left empty, all columns are returned.

Output

JSON

  • document - The retrieved document's data, including all or filtered columns as specified.

Dependencies

  • Requires an API key credential for authenticating with the Typesense instance.

Troubleshooting

  • If the specified collection does not exist or is misspelled, the node will fail to retrieve the document. Verify the collection name is correct.
  • If the document ID does not exist in the collection, the node will return an error or empty result. Confirm the document ID is valid.
  • Network or authentication errors may occur if the API key credential is invalid or the Typesense instance is unreachable. Check credentials and network connectivity.

Links

Discussion