Octave icon

Octave

Interact with the Octave V2 API

Actions26

Overview

This node interacts with the Octave V2 API to list agents based on various filtering and sorting criteria. It is useful for scenarios where you need to retrieve a collection of agents, such as fetching marketing or sales automation agents filtered by type, searching by text query, or paginating through large sets of agents.

Practical examples include:

  • Retrieving all email-type agents to analyze their configurations.
  • Searching for agents containing specific keywords in their metadata.
  • Paginating through agents sorted by creation date to display in a dashboard.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit (true/false).
Limit Maximum number of results to return (used if "Return All" is false).
Offset Offset of the results to return, used for pagination.
Query Text search query to filter agents by matching text.
Agent Type Filter agents by type. Options: All, Content, Email, Enrich Company, Enrich Person, Personalize Template, Prospector, Qualify Company, Qualify Person.
Order By Field Field to order the agents by. Options: Created At, Updated At.
Order Direction Direction to order the agents by. Options: Descending, Ascending.

Output

The node outputs an array of JSON objects representing the agents retrieved from the Octave API. Each object contains the agent's data fields as returned by the API, which typically include identifiers, type, metadata, timestamps, and other relevant properties describing each agent.

If binary data were involved, it would be summarized here, but this operation deals solely with JSON data.

Dependencies

  • Requires an API key credential for authenticating with the Octave V2 API.
  • The node depends on the Octave API service being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API keys.
    • API rate limits or network connectivity problems causing request failures.
    • Incorrect property values leading to empty or unexpected results (e.g., invalid agent type or offset).

  • Error messages:

    • Errors thrown by the API will be caught and can include detailed context and response body when available.
    • Parsing errors may occur if the API response body is malformed; these are reported with a parse error message.

  • Resolutions:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Check network connectivity and API status.
    • Adjust input parameters like limit, offset, and filters to valid values.
    • Enable "Continue On Fail" option to handle errors gracefully and inspect error details in output.

Links and References

Discussion