1. How do I use AI Agent Studio?
  2. Add External REST tool

Add External REST tool

You can enable your agents to securely connect to internal or external SaaS applications and public APIs by adding External REST tools in AI Agent Studio. Make sure you have a role with the Create and Edit Backends for Visual Builder Studio (ORA_FND_TRAP_PRIV) privilege assigned to it.

  1. Go to AI Agent Studio.
  2. From the Tools tab, click Add.
  3. Add a new tool of type External REST.
  4. Enter the name, code, and description for the tool, and select the appropriate family and product.
  5. Select Require Human Approval to ensure that a person reviews and approves any action before the tool runs.
    1. Message: Enter instructions for the reviewer.
    2. Actions: Select the required action.
  6. In the Authorization tab, add connection details for the third-party service.
    1. Instance URL: Enter the base domain of the external API, with no paths, parameters, or trailing slashes. For example, https://api.weather.gov is correct.
    2. Authentication: Define how your agents will authenticate with the external system.
    3. Description: Provide details about the tool, including what the tool does, and when the agent must call the tool.
  7. In the Functions tab, provide endpoint details.
    1. Name: Assign a unique name to this endpoint. For example, getWeatherByCoordinates.
    2. Operation Type: Select the HTTP method required to process the REST call against the target endpoint.
    3. Resource Path: Specify the relative resource path to be appended to the Instance URL. Don't include the protocol or base domain. For example, /points/{latitude},{longitude} is correct.
    4. Description: Provide a clear summary of the endpoint's function and the specific task it performs within the workflow.
  8. In the Parameters tab, define each dynamic variable in the path, including data type and purpose. For example, you can define latitude as the first parameter and longitude as the second.
  9. In the Sample Queries tab, list example user queries that should trigger this tool.
  10. In the Headers tab, specify any required metadata and security credentials for the external server.

The tool now appears in the Tools tab, and you can select it when creating agents, nodes, or agent teams.