The configuration for an HTTP API call by a tool.

​
Example Usage

import { ToolHttpEndpoint } from "syllable-sdk/models/components";

let value: ToolHttpEndpoint = {
  url: "https://celebrated-skeleton.info/",
  method: "post",
  argumentLocation: "path",
};

​
Fields

FieldTypeRequiredDescription
urlstringTRUEThe endpoint URL of the external service to call.
methodcomponents.ToolHttpMethodTRUEThe HTTP method to use for a tool HTTP request.
argumentLocationcomponents.ToolArgumentLocationTRUEThe location of the argument in a tool HTTP request.
‘body’ is used for JSON data in the POST request body.
‘form’ is used for form data in the POST request body.
‘path’ is used for URL path parameters.
‘query’ is used for query parameters in the URL.
ToolFunctionToolHttpMethod