This guide explains step by step how to create a JSON-formatted tool so our AI system can properly call your API. You don’t need to know TypeScript: just follow the indicated structure and fill in the fields with your information.

1. What is a “tool”?

A tool is a simple JSON file that describes:

• The URL of your API
• The HTTP method to use
• The headers to include
• The parameters that go directly in the URL (pathParameters)
• The parameters that appear after the “?” in the URL (queryParameters)
• An optional body to send additional data (bodyParameters)

Our AI system reads this to know how to call your API, which values to pass, in what format, etc…

2. General structure of the tool

Regarding the general structure, there are several parts: some are presented in a graphical interface, and others must be specified in JSON. Below is the main structure expected on the graphical part:

1. URL

Indicate the full URL of your endpoint (with parameters in the path if applicable, e.g., /{id}).

2. Methods

The HTTP method to use: "GET", "POST", "PUT", "DELETE", or "PATCH".

3. Headers

A list of objects describing each header to send, each header must contain:

• The header’s name (e.g., "Authorization")
• The header’s value (e.g., "Bearer 1234abcd")
• secret: “true” if the value must remain confidential (to avoid displaying it in plain text), “false” otherwise