Overview
This node interacts with the Synthflow AI API to manage and utilize AI voice agents. Specifically, the 'List Agents' operation retrieves a list of Synthflow agents within the user's workspace, supporting pagination through 'limit' and 'offset' parameters. This is useful for users who want to view or manage multiple AI agents programmatically, such as in customer service automation or outbound call campaigns.
Use Case Examples
- A customer support manager lists all AI agents to review their configurations.
- A developer retrieves a paginated list of agents to display in a custom dashboard.
Properties
| Name | Meaning |
|---|---|
| Limit | Maximum number of agent results to return in the list. |
| Offset | Index of the first agent to be returned, used for pagination. |
Output
JSON
id- Unique identifier of the Synthflow agent.name- Name of the Synthflow agent.type- Type of the agent (e.g., outbound, inbound, widget).description- Description of the agent, if provided.created_at- Timestamp when the agent was created.updated_at- Timestamp when the agent was last updated.
Dependencies
- Synthflow AI API
- An API key credential for authentication
Troubleshooting
- Ensure the API key credential is correctly configured and has necessary permissions.
- Check that the 'limit' and 'offset' parameters are within valid ranges (limit >= 1, offset >= 0).
- Handle API rate limits or network errors gracefully; the node supports 'continue on fail' to manage errors per item.
Links
- Synthflow API - List Agents - Official API documentation for listing Synthflow agents.