Skip to content

API Node

API nodes let you connect to external systems and retrieve data by making SOAP or REST API calls. You can configure the APIs and pass the necessary parameters to fetch the required information.

Add and Configure an API Node

Setting up an API node in an agent flow involves adding the node at the appropriate location in the flow and configuring various node properties.

Steps to add and configure the node:

  1. On the Agents tab, click the name of the agent to which you want to add the node. The Agent Flow page is displayed.

  2. Click Go to flow to edit the in-development version of the flow.

  3. In the flow builder, click the “+” icon on any existing node on the canvas and select API from the pop-up menu. (Alternatively, drag the API node from the Assets panel onto the canvas.)

  4. Click the added node to open its properties dialog box. The General Settings for the node are displayed.
    Go to Flow Canvas

  5. Enter or select the following information:

    • Node Name: Enter an appropriate name for the node.
    • Type: Select the API type from the drop-down list - REST or SOAP.

    • Integration Type: Select the integration type for the connection—synchronous or Asynchronous—and set the timeout duration for the integration.

      • Synchronous: The allowed range is 5 to 180 seconds (3 minutes). The default is 60 seconds.

      • Asynchronous:

        • Set timeout: The allowed range is 30 to 300 seconds (5 minutes). The default is 60 seconds.
        • No timeout: This allows the integration to wait indefinitely for the response without triggering a timeout error. It allows you to automate your processes, like approvals and checks, within your custom workflows before sending the response back. (Ensure you select the same "No timeout" setting for both the API node and the agent to prevent any timeouts.)

      The node will trigger a timeout error if the request is not completed within the selected time frame.

      Notes

      • The key difference between synchronous and asynchronous integration types is how the integration processes the request and response. Synchronous integrations block the client until the response is received, while asynchronous integrations allow the client to continue working while the integration processes the request.

      • Timeout precedence: Agent timeout is greater than Node timeout is greater than Model timeout.

    • Request Definition: Define the service request details to make the call and fetch the data. Click Define Request and enter or select the following details in the Edit Request dialog box:
      Go to Flow Canvas

      1. Select the request type from the list.
      2. Paste your API Endpoint URL or cURL in the text field.
      3. In the Headers tab, specify the details of the Key and Value pair. For example, Key: Content-Type Value: application/json
      4. The Body tab is displayed for all request types except GET. Select the body content type from the drop-down list:
        • application/x-www-form-urlencoded: Allows file uploads through HTTP POST requests. Add key/value pairs encoded by the platform.
        • application/json: Transmits data between servers and web applications using JSON format without processing.
        • application/xml: Sends XML payload for SOAP services using POST methods, with the option to include node values.
        • Custom: Allows sending request payload in non-standard formats, such as for handling blogs or custom variables.
      5. Click the Test button at the top-right corner of the dialog. The API response is displayed on the Response tab.
      6. Click Save at the top-right corner of the dialog.

  6. Click the Connections icon in the left navigation and select Go to Node for success and failure conditions.
    API node Connections Properties

    1. On Success > Go to Node: After the current node is successfully executed, go to a selected node in the flow to execute next. For example, you can process the data from this node into a Function node and then use it further. In this case, select the Function node.

    2. On Failure > Go to Node: If the execution of the current node fails, go to an appropriate node having a custom error message configured.

  7. Finally, test the flow and fix any issues found. Click the Run Flow button at the top-right corner of the flow builder and follow the onscreen instructions.

Note

Use the following syntax to access an API node using the context variable: 

{{context.steps.Start.APINodeName}}

API Status Codes

  • 200: Request successful
  • 400: Client error, cannot process request
  • 401: Authentication required
  • 403: Access denied
  • 404: Resource not found
  • 500: Unexpected server error
  • 504: Gateway timeout, no timely response from the upstream server