Jalvis icon

Jalvis

Interact with Jalvis.ai API

Actions5

Document → Search

AI-generated

Overview

This node integrates with the Jalvis.ai API to manage and search documents and tags. Specifically, for the Document - Search operation, it allows users to query documents stored in Jalvis.ai with various filtering, sorting, and pagination options. This is useful when you want to retrieve a list of documents matching specific criteria such as title keywords, summary content, participants involved, tags, or creation date ranges.

Practical examples include:

  • Retrieving all documents created within a certain date range.
  • Searching documents by a specific participant or tag.
  • Paginating through large sets of documents sorted by creation date.

Properties

Name Meaning
Page Page number for pagination (integer).
Size Number of items per page (integer).
Sort Sort field and direction, e.g., "createdAt,desc" to sort by creation date descending.
Filter Collection of filters to narrow down the search results:
  By Title Filter documents by their title (string).
  By Summary Filter documents by their summary/short description (string).
  By Party Filter documents by participant (string).
  By Tag Filter documents by category/tag (string).
  Created From Filter documents created from this date/time (datetime).
  Created To Filter documents created up to this date/time (datetime).

Output

The output is an array of JSON objects representing documents that match the search criteria. Each item corresponds to one document returned by the Jalvis.ai API. The exact structure depends on the API response but typically includes fields like document ID, title, summary, participants, tags, creation date, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Jalvis.ai API.
  • The node expects the base URL and API token/version to be configured in the credentials.
  • Uses HTTP GET requests to the /document endpoint of the Jalvis.ai API with query parameters for filtering, sorting, and pagination.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication errors.
    • Invalid date formats in filters may lead to request failures.
    • Using unsupported filter values or malformed JSON in parameters can cause API errors.
  • Error messages:
    • Errors returned from the API are captured and included in the output under an error field along with debug information about the request.
    • If the node fails due to an exception, the error message will indicate the problem, such as network issues or invalid parameters.
  • Resolution tips:
    • Verify API credentials and ensure they have proper permissions.
    • Use ISO 8601 format for datetime filters.
    • Check the API documentation for valid filter values and parameter formats.

Links and References

Discussion