API Node

Function

The API node is used to call external APIs, such as search engine query APIs or enterprise internal system APIs.

The API node has the following properties:

API Address

Set the URL for the API call.

Call Method

Set the method for the API call. There are two available methods:

• Fixed Format: The fixed format uses the POST method to call, with input parameters as a JSON object that includes the selected variables:
  {output variable name: value}
• AI Call: Use prompts to let AI make the API call. This method can handle various API formats and parameters flexibly.

API Call Parameters

When the call method is set to "Fixed Format," you can select output variables from the API call parameter list to be passed as input parameters to the API.

Does It Require AI to Process the Results?

Set whether the large language model is needed to process the results returned by the API. This is suitable for scenarios where the API results need to be returned to the user in natural language or when specific fields need to be extracted from the API results and saved as output variables.

Result Processing Prompt

The prompt used to process the results.

Should the Results Be Sent Directly to the User?

Set whether the results of the API call node should be sent to the user.