Actions5
- Document Actions
- Tag Actions
Document → Get by ID
AI-generatedOverview
This node integrates with the Jalvis.ai API to manage documents and tags. Specifically, for the Document - Get by ID operation, it retrieves detailed information about a single document using its unique identifier. This is useful when you need to fetch the full data of a specific document stored in Jalvis.ai, such as retrieving contract details, summaries, participants, or associated metadata.
Practical examples:
- Fetching a contract document by its ID to display or process its content.
- Retrieving a document’s metadata before updating or tagging it.
- Accessing a document’s summary and participants for reporting or auditing purposes.
Properties
| Name | Meaning |
|---|---|
| Document ID | The unique identifier of the document to retrieve. It must be provided to fetch the specific document. |
Output
The output is a JSON object representing the document retrieved from the Jalvis.ai API. It contains all available fields of the document, such as title, summary, participants, creation date, tags, body text, and any additional properties.
If the API response is a string, the node attempts to parse it as JSON before returning. The output also includes a context.debug field containing the raw request details for troubleshooting.
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 version to be configured in the credentials.
- Network access to the Jalvis.ai API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing Document ID will cause the API call to fail.
- Incorrect or expired API credentials will result in authentication errors.
- Network connectivity problems can prevent successful requests.
Error messages:
- Errors returned by the API are captured and included in the output under an
errorfield along with debug information about the request. - If the node throws an error, ensure the Document ID is correct and that the API credentials are valid.
- Check that the base URL and API version in the credentials are properly set.
- Errors returned by the API are captured and included in the output under an
Links and References
- Jalvis.ai API Documentation (hypothetical link, replace with actual if available)
- n8n documentation on Creating Custom Nodes