Skip to main content
Follow these steps to create a new HTTP Schema Tool
1

Add a new Tool to a Project

Use the + button to add a new Entity to a Project.
Tool Add

Select HTTP Tool

2

Enter Tool Details

Enter the main details of the tool:
  • Key, used by models to reference the tool
  • Name, used in the studio to find the tool
  • Description, used to describe the tool
    Make the Description as precise as possible, it is used notably by Agents when looking up relevant tools for their tasks.
Http Tool Add Pn

Configure all fields

3

Configure your HTTP Tool

HTTP Tools are defined within the Studio, either using the UI or using JSON (use the toggle to change mode)
Http Tool Configuration Pn

Configure your HTTP Tool

The following configurations are available:
FieldDescription
URLEnter the API URL as well as the HTTP Method for the call
HeaderDefine Request Header Key-value pairs
PayloadDefine Request Body Payload Key-value pairs (these are translated to JSON at runtime)
AuthenticationDefine an optional Bearer Authentication field and Token (Tokens are encrypted when saved in Orq).
You can use Variables with the {{variable}} syntax within any configuration field. The variable will be resolved at runtime when the payload is built for the HTTP call.
Use the Autogenerate Schema when using variables to ensure variable definition is correctly created.