Custom API Calls in Super Agents

What Are Custom API Calls in Super Agents?

Key Benefits

How Custom API Calls Work

The Super Agent evaluates the conversation context and determines whether an API call is relevant based on the instructions you provide. For example, if a contact asks about order status, the Super Agent recognizes that it needs to query an order tracking API.

The Super Agent checks whether it has all required information to execute the API call. If any parameters are missing (such as an order number or customer ID), the Super Agent asks the contact for the information naturally during the conversation.

Once all required parameters are collected, the Super Agent places them into the correct request fields (path parameters, query parameters, headers, or request body) and executes the API call securely using the configured authentication method.

The Super Agent receives the API response, extracts the selected response fields you configured, interprets the data, and continues the conversation using the result. The response is presented naturally as part of the Super Agent's reply.

Setting Up Custom API Calls Using the Builder

Navigate to the Super Agents section in HighLevel and open the saved Super Agent you want to enhance with API capabilities.

Open the Builder interface for your Super Agent. This is the conversational configuration tool that understands natural language instructions.

Tell the Builder which API you want to connect and what the Super Agent should do with it. For example: "I want to connect to the Order Status API at https://api.example.com/orders/{orderId} to check order statuses when customers ask about their orders.

The Builder configures the API call including the endpoint URL, request method (GET, POST, etc.), required parameters, request body structure, authentication method, and usage instructions. Review the configuration to ensure it matches your requirements.

Test the API call to verify it works correctly, select which response fields the Super Agent should use, and enable the API call. The Super Agent can now use this API connection during conversations.

The API call is configured and ready to use. The Super Agent will determine when to execute the call based on the instructions provided by the Builder.

Configuring API Calls Manually

Select the HTTP method for your API call: GET (retrieve data), POST (create data), PUT (replace data), PATCH (update data), or DELETE (remove data).

Enter the full API endpoint URL. Include path parameter placeholders using curly braces, such as https://api.example.com/orders/{orderId}.

Define path parameters (values inserted into the URL path) and query parameters (values appended to the URL after a question mark). Specify parameter names and provide descriptions to help the Super Agent understand what information to collect.

Add custom headers required by the API, such as Content-Type or Accept headers. Headers are sent with every request.

For POST, PUT, and PATCH requests, configure the JSON request body structure. Define the fields the Super Agent should populate based on information collected from the contact.

Select the authentication method: API Key (header or query parameter), Bearer Token (OAuth), Basic Authentication (username and password), or No Authentication for public endpoints.

Provide clear instructions defining when the Super Agent should use this API call. Describe the conversation scenarios, triggers, or contact requests that should cause the Super Agent to execute this API call.

Write detailed usage instructions. The clearer your instructions, the more accurately the Super Agent will determine when to use the API call.

Testing and Selecting Response Fields

Enter test values for all required parameters (path parameters, query parameters, and request body fields). Use realistic values that will return a valid response from the API.

Click the test button to execute the API call. The system sends the request to the API endpoint using your test values and authentication credentials.

The test interface displays four preview sections: the complete request details, the cURL command equivalent, the HTTP status code, and the full JSON response from the API.

Review the API response and select which fields the Super Agent should receive and use in conversations. Selecting specific fields keeps the result focused and helps the Super Agent understand the data structure.

Only select response fields that are relevant to the Super Agent's task. Including too many fields or unnecessary data can confuse the Super Agent and reduce response quality.

How Super Agents Use APIs in Conversations

Frequently Asked Questions