Skip to main content
HTTP tools connect agents to external APIs and services to fetch data, submit forms, or trigger external services. The agent invokes the tool based on its reasoning, passing the required parameters — the platform handles authentication, request construction, and response mapping.

​
Configuring an HTTP tool

Navigate to Tools > + New Tool > HTTP.

​
Step 1: Provide basic information about the tool

Tool Name: A unique name for the tool. Description: Brief description of the tool. This description is used by the agent to identify when to invoke the tool.

​
Step 2: Configure your API endpoint, authentication, and request settings

The Configuration step defines the API endpoint, authentication, and request structure. You can populate these fields manually or click Import from cURL to automatically parse a cURL command into the configuration fields. Protocol: Select REST for standard HTTP APIs or SOAP for XML-based web services. Endpoint: Enter the full URL of the API endpoint. Method: Select the HTTP method for the request. Authentication: Select the authentication method the API requires. When authentication is configured, use the Auth Profile Reference field to reference a stored auth profile. The platform resolves credentials from the auth profile at runtime. Configure auth profiles in Workspace settings under Auth Profiles. Alternatively, provide the OAuth fields directly, as per the selected authentication method. Query Parameters: Define key-value pairs to append to the endpoint URL. Click + Add to add a parameter. Headers: Define custom headers to include with every request. Click + Add to add a header. You can also use variables.
Plaintext credentials in HTTP tool headers are flagged with a warning. Use secret references (for example, {{secrets.X}}) instead of plaintext credentials to avoid the warning.
Parameters: Define the inputs the LLM provides when invoking this tool. The platform uses these to construct the request payload and inform the LLM of the data it needs to supply. Click + Add to define a parameter manually, or click Parse to auto-detect parameters from {{input.X}} references already used in the endpoint URL, headers, or query parameters. For each parameter, specify the following:
  • Name: Specifies the name of the parameter. Use the same parameter name in the tool configuration where the value is referenced.
  • Type: Specifies the data type of the parameter, such as String.
  • Required: Specifies whether the parameter must have a value when the tool is invoked.
  • Description: Describes the parameter and the value it expects. The LLM uses this description to determine what value to provide.
  • Default value: Specifies an optional default value for the parameter.
  • Source of value: Specifies where the parameter value is obtained from. Model - The LLM fills the value. The parameter appears in the JSON Schema sent to the model. Parameters with System, Runtime, Config, or Auth as the source are populated by the platform and are not exposed to the LLM. Config and Auth values are resolved from configuration variables and secrets, respectively, while Runtime values are resolved from the current session context.
  • Visible to model: When enabled, makes the parameter available to the LLM as part of the tool input or context.
  • Visible in traces: When enabled, makes the parameter value available in tool execution traces for monitoring and troubleshooting.
Advanced Settings Advanced Settings controls the tool’s reliability and performance behavior.

​
Step 3: Testing the tool

After the tool is created, go to the Testing tab. Click Run Test and provide sample values. Validate the request sent and the response received from the service.

​
Attaching tool to the agent

Via UI
  • Go to the **Tools **page under Agent.
  • Click Attach Tool.
  • Add the selected Tool.
Via DSL
  • Open the agent DSL editor by clicking DSL at the top of the agent page.
  • In the editor, type /http-tool to trigger the tool insertion shortcut.
  • Select the tool from the list and click Insert Tool. The platform inserts the tool definition into the DSL.
  • Click Compile to validate and Save to apply.