Actions26
- Agent Actions
- API Key Actions
- Async Actions
- Headless Actions
- Persona Actions
- Playbook Actions
- Product Actions
- Reference Actions
- Use Case Actions
Overview
This node integrates with the Octave V2 API, providing various operations across multiple resources. Specifically, for the Reference resource with the List operation, it retrieves a list of references from the Octave system. This is useful when you want to fetch and process reference data such as documents, links, or other reference materials managed within Octave.
Common scenarios include:
- Fetching all references related to a specific product or playbook.
- Searching references by text query.
- Paginating through large sets of references using limit and offset.
- Filtering references based on ownership scope (all, team, or personal).
Practical example:
- A marketing automation workflow that pulls all references tagged to a particular product to include in campaign materials.
- A compliance check that lists references owned by the current user to verify documentation completeness.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only up to a given limit. Boolean: true or false. |
| Limit | Maximum number of results to return if not returning all. Number, minimum 1. |
| Offset | Offset of the results to start returning from (for pagination). Number, default 0. |
| Text Search | Text search query string to filter references by matching content. |
| Query Type | Type of query to perform. Options: All, Team, Mine. |
| Product OID (Filter) | Filter references by a specific Product OID (optional). String. |
| Playbook OID (Filter) | Filter references by a specific Playbook OID (optional). String. |
Output
The node outputs an array of JSON objects representing references retrieved from the Octave API. Each object corresponds to a single reference item with its associated metadata and details as provided by the API.
If binary data were involved (not indicated here), it would typically represent files or attachments related to references, but this operation focuses on JSON data output.
Dependencies
- Requires an API key credential for authenticating with the Octave V2 API.
- The node depends on the Octave API being accessible and properly configured.
- No additional external services are required beyond the Octave API.
- n8n environment must have the Octave API credentials set up.
Troubleshooting
Common issues:
- Authentication failures due to invalid or missing API keys.
- API rate limits or quota exceeded errors.
- Incorrect filtering parameters leading to empty result sets.
- Pagination misconfiguration causing incomplete data retrieval.
Error messages:
- Errors returned from the API will be captured and included in the output if "Continue On Fail" is enabled.
- Parsing errors may occur if the API response body is malformed; these are reported with a parse error message.
- Network or connectivity errors will cause the node to fail unless "Continue On Fail" is active.
Resolutions:
- Verify API key validity and permissions.
- Adjust filters and pagination parameters carefully.
- Enable "Continue On Fail" during testing to capture detailed error info.
- Check network connectivity and API status.
Links and References
- Octave API Documentation (example placeholder link)
- n8n Documentation on Creating Custom Nodes
- General API authentication best practices
Note: The above summary is based solely on static analysis of the provided source code and property definitions.